Sign in
Reports

Queue an export of the client associated barcodes report

This endpoint queues an export of the client associated barcodes report. The report will be generated asynchronously and delivered via the configured delivery method.

get/shop/reports/client-associated-barcodes/queue

Query parameters

site_idstring uuid required

Filter the list of ClientAssociatedBarcodes by site

pageinteger

The page to retrieve results from

created_at_fromstring date-time

Filter the list of ClientAssociatedBarcodes by created date (ISO 8601 format)

created_at_tostring date-time

Filter the list of ClientAssociatedBarcodes by created date (ISO 8601 format)

expires_at_fromstring date-time

Filter the list of ClientAssociatedBarcodes by expiry date (ISO 8601 format)

expires_at_tostring date-time

Filter the list of ClientAssociatedBarcodes by expiry date (ISO 8601 format)

has_orderboolean

Filter the list of ClientAssociatedBarcodes by whether they have an associated order

has_payment_methodboolean

Filter the list of ClientAssociatedBarcodes by whether they have an associated payment

sourcestring
Example:kiosk

Filter the list of ClientAssociatedBarcodes by source

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.