Raw schema
{
"type": "object",
"properties": {
"date_from": {
"description": "Sales from this UTC time. YYYY-MM-DD means the start of that UTC day; or 2026-10-01T00:00:00Z. Convert local days to UTC with the retailer's time zone.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}Z)?$"
},
"date_to": {
"description": "Sales up to this UTC time. YYYY-MM-DD means the END of that UTC day (23:59:59Z).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}Z)?$"
},
"state": {
"description": "Sale state. On-account and layby sales are state closed (they differ by attributes).",
"type": "string",
"enum": [
"parked",
"pending",
"voided",
"closed"
]
},
"outlet_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only sales at this outlet."
},
"register_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only sales on this register."
},
"user_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only sales by this staff user."
},
"customer_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only sales to this customer."
},
"payment_type_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only sales with this payment type (the payment type's config_id, shown as payments[].type.config_id in a sale)."
},
"product_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only sales containing this product."
},
"invoice_number": {
"type": "string",
"maxLength": 60
},
"counted_states": {
"description": "Sale states that count towards the totals (exact, case-insensitive). Default: every state containing 'closed'.",
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"maxLength": 40
}
},
"max_pages": {
"description": "Pages of page_size sales to read (default 5, max 20).",
"type": "integer",
"minimum": 1,
"maximum": 20
},
"page_size": {
"description": "Sales per page (default 1000).",
"type": "integer",
"minimum": 100,
"maximum": 1000
},
"offset": {
"description": "Offset for the next page: pass next_offset from the previous call (default 0).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}