Raw schema
{
"type": "object",
"properties": {
"search": {
"description": "Text contained in the order number, status, customer, invoice number, customer reference or credit note number.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"status": {
"description": "Overall sale status.",
"type": "string",
"enum": [
"DRAFT",
"VOIDED",
"ESTIMATING",
"ESTIMATED",
"ORDERING",
"ORDERED",
"BACKORDERED",
"PICKING",
"PICKED",
"PACKING",
"PACKED",
"SHIPPING",
"INVOICING",
"INVOICED",
"CREDITED",
"COMPLETED"
]
},
"created_since": {
"description": "Only sales created after this time.",
"type": "string",
"maxLength": 40
},
"updated_since": {
"description": "Only sales changed after this time.",
"type": "string",
"maxLength": 40
},
"updated_until": {
"description": "Only sales changed before this time.",
"type": "string",
"maxLength": 40
},
"ship_by": {
"description": "Only sales with a Ship By date on or before this, not yet shipped.",
"type": "string",
"maxLength": 40
},
"quote_status": {
"description": "Quote status.",
"type": "string",
"enum": [
"NOT AVAILABLE",
"DRAFT",
"AUTHORISED",
"VOIDED"
]
},
"order_status": {
"description": "Order status.",
"type": "string",
"enum": [
"NOT AVAILABLE",
"DRAFT",
"AUTHORISED",
"VOIDED",
"AUTH_NO_ALLOC",
"FULFILLED",
"CLOSED"
]
},
"pick_status": {
"description": "Combined pick status.",
"type": "string",
"enum": [
"VOIDED",
"NOT AVAILABLE",
"PICKED",
"PICKING",
"NOT PICKED",
"PARTIALLY PICKED"
]
},
"pack_status": {
"description": "Combined pack status.",
"type": "string",
"enum": [
"VOIDED",
"NOT AVAILABLE",
"PACKED",
"PACKING",
"NOT PACKED",
"PARTIALLY PACKED"
]
},
"shipping_status": {
"description": "Combined shipping status.",
"type": "string",
"enum": [
"VOIDED",
"NOT AVAILABLE",
"SHIPPED",
"SHIPPING",
"NOT SHIPPED",
"PARTIALLY SHIPPED"
]
},
"invoice_status": {
"description": "Combined invoice status.",
"type": "string",
"enum": [
"VOIDED",
"DRAFT",
"AUTHORISED",
"NOT AVAILABLE",
"PAID"
]
},
"credit_note_status": {
"description": "Credit note status.",
"type": "string",
"enum": [
"NOT AVAILABLE",
"DRAFT",
"AUTHORISED",
"VOIDED"
]
},
"external_id": {
"description": "Only sales with this External ID.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"ready_for_shipping": {
"description": "true = only sales packed but not yet shipped.",
"type": "boolean"
},
"order_location_id": {
"description": "Only sales from this order location (GUID).",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"limit": {
"description": "Records per page, 1-100 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}