Sign in
Reports

Queue an export of the voucher codes report

Queues a CSV export of the voucher codes report to be generated asynchronously. Use this in preference to the synchronous endpoint when issuing a large number of codes.

get/shop/reports/voucher-codes/queue

Query parameters

site_idstring uuid required

The site to list voucher codes for.

codestring

Filter to voucher codes containing this substring (case-insensitive).

statusstring[]

A comma-separated list of voucher code statuses to filter on.

amountstring
Example:>=10000

Filter by code face amount (in minor units). Supports a comparison operator prefix, e.g. >=10000, <5000, =2000, or a bare value (interpreted as equality).

balancestring

Filter by remaining code balance (in minor units), using the same operator syntax as amount.

voucher_type_idstring[]

A comma-separated list of voucher type IDs to filter on.

fulfillment_statusstring

Filter by voucher fulfillment status.

created_sincestring date-time

Filter to voucher codes created on or after this date-time.

expired_range_fromstring date

Filter to voucher codes whose expiry date falls on or after this date.

expired_range_tostring date

Filter to voucher codes whose expiry date falls strictly before this date.

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.