Skip to main content

Promotions

Frequency:

Promotions data changes are required to be sent in near real-time. Any change to the interface field in the external system should trigger the interface.

Expected data:

Data about specific promotion types on organization level.

  • Promotion ID: The unique identifier for the promotion.
  • Type of Promotion: The type of promotion being reported in the interface.

Technical:

If a promotion record does not exist in DSOrder, the record will be created.

If a promotion record already exists in DSOrder, the existing record will be updated with the new data.

Import Promotions​

Method: POST
URL: https://{url}/promotions

Create or update promotions.

Request Body​

The request body is a JSON array of objects.

NameTypeRequiredDescription
external_idstringYesUnique promotion identifier in external system
type_idstringYesUnique promotion type identifier in external system (list of available types must be configured in DSOrder)

Request Example​

[
    {
        "external_id": "PROMO-00001",
        "type_id": "TV-PROMO"
    }
]

Response​

200: OK — Success​

{
    "success": true,
    "message": null,
    "data": null,
    "warnings": []
}

200: OK — Error​

{
    "success": false,
    "message": "Promotion insertion failed",
    "data": null,
    "warnings": []
}