Get campaign item overview

GET

/campaign/{id}/overview/{itemId}

Retrieves comprehensive overview information for a specific campaign item,
including allocation details, store distributions, and item specifications.

Overview Information Includes:

Campaign item allocation details

Store-specific quantities and distributions

Item specifications (weight, dimensions, type)

Element information with supplier details

Allocation totals and summaries

Use Cases:

Item detail views

Allocation management

Store distribution planning

Inventory management

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Responses

🟢200OK

application/json

Campaign item overview 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/550e8400-e29b-41d4-a716-446655440000/overview/550e8400-e29b-41d4-a716-446655440001' \
--header 'Authorization: <api-key>'

Response Example

200 - Example 1

{
    "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
    "campaignItemId": "e682927e-5446-4749-9734-8eefd3402521",
    "itemDetails": {
        "name": "string",
        "elementId": {},
        "perBoxQty": 0
    },
    "allocations": [
        {
            "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
            "storeName": "string",
            "quantity": 0,
            "boxes": 0
        }
    ],
    "totals": {
        "totalQuantity": 0,
        "totalBoxes": 0,
        "totalStores": 0
    }
}

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

Get campaign item pricing information

Get priority allocations for a campaign item