Create multiple campaign items

POST

/campaign-items

Creates multiple campaign items by linking existing items to a campaign.

Business Rules:

Campaign must exist and not be locked

All items must exist in the item library

Priority allocation determined by campaign element groups

hasArtwork flag set based on item artwork availability

perBoxQty inherited from element configuration

Side Effects:

Creates search index entries for all new campaign items

Updates campaign state from Created/ReadyToPublish to InProgress

Generates custom field values for merchandise information

Bulk creation optimized for performance

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Campaign items created successfully

Body

🟠400Bad Request

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://prod.your-api-server.com/campaign-items' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaignId": "550e8400-e29b-41d4-a716-446655440000",
    "itemIds": [
        "660e8400-e29b-41d4-a716-446655440001",
        "aa0e8400-e29b-41d4-a716-446655440007",
        "bb0e8400-e29b-41d4-a716-446655440008"
    ]
}'

Response Example

201 - Multiple campaign items created

{
    "campaignItemIds": [
        "cc0e8400-e29b-41d4-a716-446655440009",
        "dd0e8400-e29b-41d4-a716-446655440010",
        "ee0e8400-e29b-41d4-a716-446655440011"
    ],
    "campaignItemEntities": {
        "cc0e8400-e29b-41d4-a716-446655440009": {
            "_id": "cc0e8400-e29b-41d4-a716-446655440009",
            "clientId": "client123",
            "campaignId": "550e8400-e29b-41d4-a716-446655440000",
            "itemId": "660e8400-e29b-41d4-a716-446655440001",
            "status": 100,
            "qty": 0,
            "isActive": true,
            "isPriorityAllocation": false,
            "hasArtwork": true,
            "perBoxQty": 1,
            "allocationRules": [],
            "meta": {},
            "createdAt": "2025-09-09T16:00:00Z",
            "updatedAt": "2025-09-09T16:00:00Z"
        },
        "dd0e8400-e29b-41d4-a716-446655440010": {
            "_id": "dd0e8400-e29b-41d4-a716-446655440010",
            "clientId": "client123",
            "campaignId": "550e8400-e29b-41d4-a716-446655440000",
            "itemId": "aa0e8400-e29b-41d4-a716-446655440007",
            "status": 100,
            "qty": 0,
            "isActive": true,
            "isPriorityAllocation": true,
            "hasArtwork": false,
            "perBoxQty": 25,
            "allocationRules": [],
            "meta": {},
            "createdAt": "2025-09-09T16:00:00Z",
            "updatedAt": "2025-09-09T16:00:00Z"
        },
        "ee0e8400-e29b-41d4-a716-446655440011": {
            "_id": "ee0e8400-e29b-41d4-a716-446655440011",
            "clientId": "client123",
            "campaignId": "550e8400-e29b-41d4-a716-446655440000",
            "itemId": "bb0e8400-e29b-41d4-a716-446655440008",
            "status": 100,
            "qty": 0,
            "isActive": true,
            "isPriorityAllocation": false,
            "hasArtwork": true,
            "perBoxQty": 1,
            "allocationRules": [],
            "meta": {},
            "createdAt": "2025-09-09T16:00:00Z",
            "updatedAt": "2025-09-09T16:00:00Z"
        }
    }
}

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

List campaign items

Get MOS information for a campaign item