Sign in
DiscountUsage

Promo code usage summary

This endpoint summarises the total discount usage by promo code across all orders matching the given parameters.

get/shop/reports/promo-code-usage/summary

Query parameters

site_idstring uuid required

Filter the summary list of used promo codes by site.

revenue_date_fromstring date
Example:2023-10-01

Filter the summary 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 summary 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 summary 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 summary 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.

Response

The summary of Used Promo Codes was successfully retrieved

Example response

{
  "data": [
    {
      "discount_type_code": "SUMMER23",
      "total_times_used": 1120,
      "total_discount_across_orders": 10000,
      "currency": "gbp"
    }
  ]
}

Changes

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