Raw schema
{
"type": "object",
"properties": {
"query": {
"description": "Search text (order number, customer name, phone, email).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"description": "Order status: open (Sapo default when omitted, so archived orders are left out), closed, or any (all orders). Pass any for date-range totals.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"financial_status": {
"description": "Payment status: authorized, pending, paid, refunded, voided, or any. Sapo default when omitted: authorized, pending and paid only (refunded and voided are left out).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"fulfillment_status": {
"description": "Fulfillment status (for example unfulfilled, fulfilled, partial).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"tag": {
"description": "Only orders with this tag.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"customer_id": {
"description": "Only orders of this customer.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_on_min": {
"type": "string",
"description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
},
"created_on_max": {
"type": "string",
"description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
},
"modified_on_min": {
"type": "string",
"description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
},
"modified_on_max": {
"type": "string",
"description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"limit": {
"description": "Results per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}