Sign in
DiscountUsage

Queue an export of the discount usage report

Queues a CSV export of the discount usage report to be generated asynchronously.

get/shop/reports/discount-usage/queue

Query parameters

site_idstring uuid

Restrict to baskets at the given site.

revenue_date_fromstring date
Example:2026-06-01

Restrict to baskets with a revenue date on or after this date.

revenue_date_tostring date
Example:2026-06-30

Restrict to baskets with a revenue date on or before this date.

submitted_at_fromstring date

Restrict to baskets submitted on or after this date.

submitted_at_tostring date

Restrict to baskets submitted on or before this date.

emailboolean

If true, email the completed CSV to the authenticated user when the background job finishes. Defaults to false, in which case the queued job's output URL must be polled via the queued-jobs endpoint.

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.