Get MOS information for a campaign item

GET

/campaign-item/{id}/mos-information

Retrieves MOS (Merchandising Operations System) information for a campaign item.

Data Sources:

If MOS info is already synced, returns stored data

Otherwise, fetches from federation API using item POS number

Parses custom attributes and category mappings

Maps custom fields using integration configurations

Federation API Integration:

Authenticates with federation API using client credentials

Queries product by POS number

Handles API errors gracefully (returns empty MOS info if product not found)

Supports both legacy and new custom attribute parsing

Custom Field Mapping:

Maps date fields from MM/DD/YYYY to YYYY-MM-DD format

Converts string arrays for multiSelect fields

Processes integration configs for responseElement type

Handles custom attributes with isCustomAttribute flag

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Responses

🟢200OK

application/json

MOS information 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/mos-information' \
--header 'Authorization: <api-key>'

Response Example

200 - Previously synced MOS information

{
    "_id": "880e8400-e29b-41d4-a716-446655440003",
    "clientId": "client123",
    "campaignId": "550e8400-e29b-41d4-a716-446655440000",
    "itemId": {
        "_id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Promotional Flyer",
        "posNumber": "FLY001"
    },
    "status": 102,
    "qty": 500,
    "mosInformation": {
        "reorderPoints": 50,
        "allowbackOrders": true,
        "minQty": 10,
        "maxQty": 1000,
        "quantityBreaks": [
            25,
            50,
            100,
            500
        ],
        "insuranceValue": 125.5,
        "goLiveDate": "2025-10-01",
        "lineofBusinessRequired": false,
        "revisionDate": "2025-09-15",
        "categories": [
            {
                "_id": "ff0e8400-e29b-41d4-a716-446655440012",
                "name": "Marketing Materials",
                "category": "ProductType",
                "parentTagId": "gg0e8400-e29b-41d4-a716-446655440013"
            }
        ],
        "restrictBranchRole": "accessToAllBranches",
        "mosRole": [
            "B2B",
            "Branch"
        ],
        "updateItemMOS": true
    },
    "meta": {
        "mosInfoSynced": true,
        "customAttribute1": "Value from federation API"
    },
    "createdAt": "2025-09-09T10:00:00Z",
    "updatedAt": "2025-09-09T14:30:00Z"
}

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

Create multiple campaign items

Delete MOS information for a campaign item