Raw schema
{
"type": "object",
"properties": {
"branch_ids": {
"description": "Only these branches (see kiotviet_list_branches).",
"maxItems": 50,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"customer_ids": {
"description": "Only orders of these customers.",
"maxItems": 50,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"customer_code": {
"description": "Only orders of the customer with this code.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"status": {
"description": "KiotViet status code(s) to include.",
"maxItems": 10,
"type": "array",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"sale_channel_id": {
"description": "Only orders from this sales channel.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"created_date": {
"description": "Only orders created at or after this date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:\\d{2})?)?$"
},
"last_modified_to": {
"description": "Only orders last changed up to this date-time (KiotViet toDate is a bound on the modification time, not the creation time). Use with last_modified_from.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:\\d{2})?)?$"
},
"include_payment": {
"description": "Include the payments.",
"type": "boolean"
},
"include_order_delivery": {
"description": "Include the delivery details.",
"type": "boolean"
},
"last_modified_from": {
"description": "Only records changed at or after this date-time (shop local time).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:\\d{2})?)?$"
},
"order_by": {
"description": "Sort field.",
"type": "string",
"enum": [
"createdDate",
"modifiedDate",
"purchaseDate",
"code"
]
},
"order_direction": {
"description": "Sort direction.",
"type": "string",
"enum": [
"Asc",
"Desc"
]
},
"current_item": {
"description": "Record offset to start from (0 = first record). Pass the previous reply's next_item.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
},
"page_size": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}