Ingest Promotions

This endpoint receives the promotions payload that must be processed. The system import promotions, creates and updates them, and triggers the promotion calculation. The status of the import can be monitored with the GET_PROMOTION_IMPORT_STATUS endpoint.

Resource

1promotions/ingest

Available Version

Requires Chatter

HTTP Methods

POST

Request Body for POST

Root XML tag

POST promotions/ingest

JSON Example

1{
2    "workflow" : "Create",
3    "importId" : "12345678-1234-1234-1234-123456789012",
4    "salesOrg" : "0001",
5    "promotions": [
6    {
7      "AnchorAccount": "CS_Atlanta",// external Id
8      "PromotionTemplate": "Customer Promotion",
9      "Comment": "250aup new bom gcp",
10      "Slogan": "250aup new bom gcp ",
11      "DateFrom": "2024-01-01",
12      "DateThru": "2024-12-31",
13      "PlacementDateFrom": "2024-03-01",
14      "PlacementDateThru": "2024-04-30",
15      "DeliveryDateFrom": "2024-08-01",
16      "DeliveryDateThru": "2024-09-30",
17      "OrderDateFrom": "2024-06-01",
18      "OrderDateThru": "2024-07-30",
19      "CommitDate": "2024-01-10",
20      "ProductFilter": {
21        "Criteria": {
22          "Category": [
23            "Snacks",
24            "Beverages"
25          ],
26          "Brand": [
27            "Empower_Cola",
28            "HiChoc"
29          ]
30        }
31      },
32      "ManualInputs": [
33        {
34          "KPI": "ProPlanTotalVolume",
35          "Value": 900000
36        }
37      ],
38      "Tactics": [
39        {
40          "Amount": 2500,
41          "CompensationModel": "PerCase",
42          "DateFrom": "2024-05-01",
43          "DateThru": "2024-07-30",
44          "InStoreDateFrom": "2024-05-01",
45          "InStoreDateThru": "2024-07-15",
46          "ShipmentDateFrom": "2024-05-16",
47          "ShipmentDateThru": "2024-07-30",
48          "TacticTemplate": "PriceReduction"
49        }
50      ]
51    }
52  ]
53}

Properties

Name	Type	Description	Required or Optional	Available Version
`importId`	Integer	ImportId of the process. If not passed, a new import transaction will be created.	Optional	55
`workflow`	Integer	Promotion Business Object API workflow name to execute.	Required	55
`salesOrg`	SalesOrgName	Sales organization.	Optional	55
`promotions`	List <Object>	List of Promotion payloads. Max 50 items.	Required	55

Response Body for POST

Promotion Import Output Representation