Get a single campaign item

GET

/campaign-item/{id}

Retrieves a campaign item by ID with full population of related entities.

Populated Fields:

Campaign details (name, state, defaults)

Asset information

Item details with artwork and element information

MOS information categories with parent tags

Allocation rules with populated categories and features

Merchandise information (receiving tags)

Special Processing:

Allocation rule values are populated with entity names

Filter values in allocation rules are resolved to entity names

Complex nested population for artwork files and element details

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Campaign item retrieved successfully

Body

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://prod.your-api-server.com/campaign-item/880e8400-e29b-41d4-a716-446655440003' \
--header 'Authorization: <api-key>'

Response Example

200 - Campaign item with full details

{
    "_id": "880e8400-e29b-41d4-a716-446655440003",
    "clientId": "client123",
    "campaignId": {
        "_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Summer Sale 2025",
        "state": 100,
        "defaults": {
            "primaryColor": "#FF0000",
            "secondaryColor": "#00FF00"
        }
    },
    "itemId": {
        "_id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Promotional Flyer",
        "posNumber": "FLY001",
        "artworks": [
            {
                "_id": "770e8400-e29b-41d4-a716-446655440004",
                "name": "Flyer Artwork",
                "fileId": {
                    "_id": "880e8400-e29b-41d4-a716-446655440005",
                    "url": "/files/flyer-artwork.jpg",
                    "thumbnailUrl": "/files/thumbs/flyer-artwork.jpg",
                    "description": "Summer sale promotional flyer"
                }
            }
        ],
        "elementId": {
            "_id": "990e8400-e29b-41d4-a716-446655440006",
            "name": "A4 Flyer",
            "priceBands": [
                {
                    "quantity": 100,
                    "price": 1.5
                },
                {
                    "quantity": 500,
                    "price": 1.25
                },
                {
                    "quantity": 1000,
                    "price": 1
                }
            ]
        }
    },
    "assetId": "770e8400-e29b-41d4-a716-446655440002",
    "status": 102,
    "qty": 500,
    "fixedPrice": 625,
    "oversType": "percent",
    "oversValue": 10,
    "warehouseType": "percent",
    "warehouseQuantity": 50,
    "total": 550,
    "isActive": true,
    "isPriorityAllocation": true,
    "hasArtwork": true,
    "hasAllocations": true,
    "perBoxQty": 25,
    "allocationRules": [
        {
            "property": "store",
            "rule": "include",
            "values": [
                {
                    "STORE001": "Main Street Store"
                },
                {
                    "STORE002": "Shopping Center Store"
                }
            ],
            "quantities": [
                250,
                250
            ]
        }
    ],
    "meta": {
        "customField1": "Summer Campaign"
    },
    "createdAt": "2025-09-09T10:00:00Z",
    "updatedAt": "2025-09-09T14:30:00Z"
}

Modified at 2025-09-25 10:04:16

Create a new campaign item

Update a campaign item