Sign in
DiscountUsage

Promo code usage breakdown queue

This endpoint queues an export of the breakdown of discount usage by promo code for individual orders matching the given parameters.

get/shop/reports/promo-code-usage/breakdown/queue

Query parameters

site_idstring uuid required

Filter the breakdown list of used promo codes by site.

revenue_date_fromstring date
Example:2023-10-01

Filter the breakdown list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or after this date.

revenue_date_tostring date
Example:2023-10-31

Filter the breakdown list of used promo codes by revenue date of the order. The promo code must have been used on orders with bookings on or before this date.

submitted_at_fromstring date
Example:2023-31-01

Filter the breakdown list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or after this date.

submitted_at_tostring date
Example:2023-31-10

Filter the breakdown list of used promo codes by submitted date of the order. The promo code must have been used on orders submitted on or before this date.

sortstring

The field to order results by.

sort_order'asc' | 'desc'

The direction to order results by.

applied_bystring uuid

Filter the breakdown list of used promo codes by the user who applied the promo code. This can be either 'Customer' or a member of staff.

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.