Raw schema
{
"type": "object",
"properties": {
"number": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "The order number (your Order/Invoice/Job/Waybill number) โ used later to look the order up, so no slash or backslash."
},
"client": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Client/customer name."
},
"address": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Delivery (or pickup) address, e.g. '2 St Josephs Crescent, Liverpool L3 3JF'."
},
"type": {
"description": "delivery (default) or collection.",
"type": "string",
"enum": [
"delivery",
"collection"
]
},
"date": {
"description": "Order date, YYYY-MM-DD.",
"type": "string"
},
"order_id": {
"description": "Your accounting-system id for the order.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"depot": {
"description": "Depot address (else the account's default depot).",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"shipper": {
"description": "Shipper/supplier name.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"address_lat": {
"description": "Address latitude (pass with address_lon to skip geocoding).",
"type": "number",
"minimum": -90,
"maximum": 90
},
"address_lon": {
"description": "Address longitude.",
"type": "number",
"minimum": -180,
"maximum": 180
},
"address_zone": {
"description": "Address zone.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"time_slot_from": {
"description": "Desired delivery/pickup window start, local 24-hour time HH:mm.",
"type": "string"
},
"time_slot_to": {
"description": "Desired delivery/pickup window end, local 24-hour time HH:mm.",
"type": "string"
},
"service_time_minutes": {
"description": "Service time at the stop, minutes.",
"type": "number",
"minimum": 0,
"maximum": 1440
},
"note": {
"description": "Note for the driver.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"contact_name": {
"description": "Customer contact name.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"phone": {
"description": "Customer contact phone.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"email": {
"description": "Customer e-mail.",
"type": "string",
"maxLength": 255,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"weight": {
"description": "Total weight.",
"type": "number",
"minimum": 0
},
"volume": {
"description": "Total volume.",
"type": "number",
"minimum": 0
},
"pallets": {
"description": "Pallet count.",
"type": "number",
"minimum": 0
},
"cod": {
"description": "Cash-on-delivery amount to collect.",
"type": "number",
"minimum": 0
},
"barcode": {
"description": "Barcode the driver scans.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"priority": {
"description": "Order priority.",
"type": "string",
"enum": [
"low",
"normal",
"high"
]
},
"goods": {
"description": "Goods lines (max 100).",
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Item description."
},
"quantity": {
"description": "Quantity or weight.",
"type": "number",
"minimum": 0
},
"unit": {
"description": "Unit: pcs, pkg, kg, lbs โฆ",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"cost": {
"description": "Unit price.",
"type": "number",
"minimum": 0
},
"goods_id": {
"description": "Goods id in your accounting system.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"note": {
"description": "Line note.",
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"name"
]
}
}
},
"required": [
"number",
"client",
"address"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}