Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"pickup",
"dropoffs"
],
"properties": {
"pickup": {
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"minLength": 1,
"description": "Street address only. Floor, door and building details go in comment."
},
"comment": {
"type": "string",
"maxLength": 1000,
"description": "Note for the courier (floor, door code location, ...)."
},
"contact": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"phone": {
"type": "string",
"description": "E.164, e.g. +442079476330. Required if the address is not precise."
},
"company": {
"type": "string"
},
"lastname": {
"type": "string"
},
"firstname": {
"type": "string"
}
},
"description": "Either firstname + lastname, or company, is required by Stuart."
},
"coordinates": {
"type": "object",
"required": [
"lat",
"long"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90
},
"long": {
"type": "number",
"maximum": 180,
"minimum": -180
}
},
"description": "Optional coordinates (up to 6 decimals). An address string is still required."
}
},
"description": "The single pickup point."
},
"dropoffs": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"package_type"
],
"properties": {
"address": {
"type": "string",
"minLength": 1,
"description": "Street address only. Floor, door and building details go in comment."
},
"comment": {
"type": "string",
"maxLength": 1000
},
"contact": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"phone": {
"type": "string",
"description": "E.164, e.g. +442079476330. Required if the address is not precise."
},
"company": {
"type": "string"
},
"lastname": {
"type": "string"
},
"firstname": {
"type": "string"
}
},
"description": "Either firstname + lastname, or company, is required by Stuart."
},
"coordinates": {
"type": "object",
"required": [
"lat",
"long"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90
},
"long": {
"type": "number",
"maximum": 180,
"minimum": -180
}
},
"description": "Optional coordinates (up to 6 decimals). An address string is still required."
},
"package_type": {
"enum": [
"xsmall",
"small",
"medium",
"large",
"xlarge"
],
"type": "string",
"description": "Package size."
},
"client_reference": {
"type": "string",
"description": "Your own order reference (unique)."
},
"package_description": {
"type": "string",
"maxLength": 1000
},
"end_customer_time_window_end": {
"type": "string",
"description": "ISO 8601 end of the delivery window."
},
"end_customer_time_window_start": {
"type": "string",
"description": "ISO 8601 start of the delivery window promised to the end customer."
}
}
},
"maxItems": 8,
"minItems": 1,
"description": "1 to 8 dropoff points."
},
"pickup_at": {
"type": "string",
"description": "ISO 8601 time the courier should arrive at the pickup. Omit to dispatch immediately."
},
"assignment_code": {
"type": "string",
"description": "Invoicing reference shown on invoices."
}
}
}