Raw schema
{
"type": "object",
"properties": {
"query": {
"description": "Search supplier name/post code, PO number, reference, SKU, UPC or item title.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"state": {
"description": "Lifecycle state (draft/active/completed) or a received-status filter (not_received, partially_received, fully_received, past_due, all). Default: all states including drafts.",
"type": "string",
"enum": [
"draft",
"active",
"completed",
"not_received",
"partially_received",
"fully_received",
"past_due",
"all"
]
},
"supplier_id": {
"description": "Only POs for this supplier.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"destination_warehouse_id": {
"description": "Only POs delivering to this warehouse.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"sellable_id": {
"description": "Only active POs containing this sellable (variant) id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"reference_number": {
"description": "Exact PO reference number.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"created_after": {
"description": "Created on or after this date (yyyy-mm-dd).",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"created_before": {
"description": "Created on or before this date, whole day included (yyyy-mm-dd).",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"updated_since": {
"description": "Updated at or after this ISO 8601 date-time with timezone.",
"type": "string"
},
"sort_by": {
"description": "Sort field (default created_at, newest first).",
"type": "string",
"enum": [
"supplier_name",
"created_at",
"expected_date",
"estimated_delivery_days"
]
},
"order": {
"description": "Sort direction, used with sort_by.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}