Create a new campaign item

POST

/campaign-item

Creates a new campaign item linking an item to a campaign.

Business Rules:

Campaign must exist and not be locked

Item must exist and have valid artwork if hasArtwork is true

Campaign state transitions to InProgress if currently Created

Allocation rules determine if item is Ready or Draft status

Priority allocation items are tracked in campaign asset groups

Side Effects:

Updates campaign state if transitioning from Created

Sets hasArtwork flag based on item artwork availability

Calculates perBoxQty from associated element

Populates campaign item with item and campaign details

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Campaign item 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-item' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaignId": "550e8400-e29b-41d4-a716-446655440000",
    "itemId": "660e8400-e29b-41d4-a716-446655440001",
    "assetId": "770e8400-e29b-41d4-a716-446655440002",
    "qty": 100,
    "fixedPrice": 25.5,
    "oversType": "percent",
    "oversValue": 10,
    "warehouseType": "percent",
    "warehouseQuantity": 0,
    "isPriorityAllocation": false,
    "meta": {
        "customField1": "value1"
    }
}'

Response Example

201 - Successfully created campaign item

{
    "_id": "880e8400-e29b-41d4-a716-446655440003",
    "clientId": "client123",
    "campaignId": {
        "_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Summer Sale 2025",
        "state": 100
    },
    "itemId": {
        "_id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Promotional Flyer",
        "posNumber": "FLY001"
    },
    "assetId": "770e8400-e29b-41d4-a716-446655440002",
    "status": 100,
    "qty": 100,
    "fixedPrice": 25.5,
    "oversType": "percent",
    "oversValue": 10,
    "warehouseType": "percent",
    "warehouseQuantity": 0,
    "total": 0,
    "isActive": true,
    "isPriorityAllocation": false,
    "hasArtwork": true,
    "perBoxQty": 1,
    "allocationRules": [],
    "meta": {
        "customField1": "value1"
    },
    "createdAt": "2025-09-09T10:00:00Z",
    "updatedAt": "2025-09-09T10:00:00Z"
}

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

Import artwork files for campaign items

Get a single campaign item