Reports

List ClientAssociatedBarcodes

Use this endpoint to retrieve a list of ClientAssociatedBarcode resources for reporting purposes. This endpoint supports filtering by various criteria including created date, expiry date, order, customer, source, and payment method.

get/shop/reports/client-associated-barcodes

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 list of ClientAssociatedBarcode resources was successfully retrieved

Changes

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