Order Promotions API

The Order Promotions API tracks promotional codes or discounts applied to specific orders. It provides insights into promotional campaigns, including the discount amounts, associated orders, and performance metrics. This API is crucial for evaluating the effectiveness of promotions and refining marketing strategies.

Example Response

After a successful call, the API will return a response similar to the below structure.

[
    {
        "ticket_id": 595661265,
        "location_id": 233605,
        "order_source": "Ordering Source Name",
        "order_number": "D1656",
        "subtotal": 19.85,
        "web_subtotal": 19.85,
        "closed_at": "2024-11-06T01:30:00.020Z",
        "created_at": "2024-11-06T01:29:57.443Z",
        "promo_name": null,
        "promo_amount": "4.08",
        "promo_code": "BOGO",
        "order_payload_id": 385098636,
        "external_store_id": null
    }
]

Field Descriptions

Field Name	Description
`ticket_id`	Identifier for the associated ticket.
`location_id`	Identifier for the restaurant location where the promotion was applied.
`order_source`	Name of the platform or source where the order originated.
`order_number`	Unique identifier for the order.
`subtotal`	Subtotal amount of the order, excluding taxes and fees.
`web_subtotal`	Subtotal amount for web orders.
`closed_at`	Timestamp when the order was closed.
`created_at`	Timestamp when the promotion was applied.
`promo_name`	Name of the promotion applied to the order.
`promo_amount`	Discount amount provided by the promotion.
`promo_code`	Promotional code applied to the order (e.g., BOGO).
`order_payload_id`	Identifier for the order payload associated with the promotion.
`external_store_id`	Identifier for the external store, if applicable.

This API facilitates the detailed tracking of promotional activities, enabling marketers to analyze the impact of discounts and codes on overall sales performance and customer engagement.