Raw schema
{
"type": "object",
"properties": {
"courier_type": {
"description": "Service level (default standard). Give this or courier_allocation.",
"type": "string",
"enum": [
"standard",
"express",
"click_and_collect"
]
},
"courier_allocation": {
"description": "A specific carrier keyword, e.g. CouriersPlease (see the Shippit carriers list). Instead of courier_type.",
"type": "string",
"minLength": 1,
"maxLength": 60
},
"delivery_address": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"delivery_suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"delivery_state": {
"type": "string",
"minLength": 2,
"maxLength": 40,
"description": "State. Australian orders use NSW, VIC, QLD, WA, SA, TAS, ACT or NT."
},
"delivery_postcode": {
"type": "string",
"minLength": 2,
"maxLength": 12
},
"delivery_country_code": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter country code (default: the merchant's home country, usually AU)."
},
"delivery_company": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"delivery_instructions": {
"description": "Instructions for the driver, at most 55 characters.",
"type": "string",
"minLength": 1,
"maxLength": 55
},
"authority_to_leave": {
"description": "Whether the parcel may be left unattended.",
"type": "string",
"enum": [
"Yes",
"No"
]
},
"receiver_name": {
"description": "Name of the person receiving it, if different from the customer.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"receiver_contact_number": {
"type": "string",
"minLength": 3,
"maxLength": 30
},
"customer_email": {
"type": "string",
"maxLength": 200,
"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,}$",
"description": "The customer's email (Shippit sends tracking notifications here unless suppressed)."
},
"customer_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"customer_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"customer_mobile": {
"type": "string",
"minLength": 3,
"maxLength": 30
},
"parcels": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"qty": {
"description": "Number of parcels of this kind (required unless products are given).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 1000
},
"weight": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100000,
"description": "Weight of one parcel in kilograms."
},
"length": {
"description": "Length in metres.",
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100
},
"width": {
"description": "Width in metres.",
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100
},
"depth": {
"description": "Depth (height) in metres.",
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"required": [
"weight"
]
},
"description": "The parcels (qty and weight are the minimum; leave qty out when you also send products)."
},
"products": {
"description": "Optional line items for the packing slip.",
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"description": "Product title (needed for international orders; shown on the packing slip).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"quantity": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"price": {
"description": "Unit price (used for the packing slip, customs and transit protection).",
"type": "number",
"minimum": 0,
"maximum": 10000000
}
},
"required": [
"quantity"
]
}
},
"retailer_invoice": {
"description": "Your order number, printed on the label and packing slip.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"retailer_reference": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"features": {
"description": "Carrier add-on services; some need prior approval from Shippit.",
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"enum": [
"white_glove",
"book_in_required",
"call_before_collection",
"call_before_delivery",
"driver_assist",
"two_person_lift",
"tail_lift_truck_delivery",
"tail_lift_truck_pickup",
"alcohol",
"pharmaceutical",
"id_check",
"tobacco",
"identity_on_delivery",
"pin_on_delivery"
]
}
},
"tags": {
"description": "Your own labels for filtering.",
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"validate": {
"description": "Reject the order if suburb and postcode do not match (default true).",
"type": "boolean"
},
"suppress_communications": {
"description": "true = Shippit sends no tracking notifications to the customer for this order (default false: it does).",
"type": "boolean"
},
"confirm": {
"type": "boolean",
"description": "Must be true. The order is real: it can email the customer and, for a named on-demand carrier, book it at once. Ask the user to confirm first."
}
},
"required": [
"delivery_address",
"delivery_suburb",
"delivery_state",
"delivery_postcode",
"customer_email",
"customer_first_name",
"parcels",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}