Raw schema
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Starshipit order id."
},
"order_number": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"reference": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"carrier": {
"description": "Starshipit carrier code, e.g. AusPost.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"carrier_service_code": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"shipping_method": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"shipping_description": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"signature_required": {
"type": "boolean"
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"note": {
"description": "Internal order note.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"sender_details": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Contact name."
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"building": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"company": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Country name, e.g. Australia."
},
"delivery_instructions": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
},
"destination": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Contact name."
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"building": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"company": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Country name, e.g. Australia."
},
"delivery_instructions": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
},
"items": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"description": "Product name or description.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000
},
"weight": {
"description": "Unit weight in kg.",
"type": "number",
"minimum": 0,
"maximum": 100000
},
"value": {
"description": "Unit price.",
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"tariff_code": {
"description": "Harmonized system (HS) code.",
"type": "string",
"minLength": 1,
"maxLength": 18
},
"country_of_origin": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"barcode": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"item_id": {
"description": "Existing item id to modify.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"quantity_to_ship": {
"type": "number",
"minimum": 0,
"maximum": 1000000
}
}
}
},
"packages": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"weight": {
"description": "Parcel weight in kg.",
"type": "number",
"minimum": 0,
"maximum": 100000
},
"height": {
"description": "Height in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"width": {
"description": "Width in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"length": {
"description": "Length in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"package_id": {
"description": "Existing package id to modify.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"packaging_type": {
"description": "e.g. Carton, Box, Envelope, Jiffy, Pallet, Satchel, Bag.",
"type": "string",
"minLength": 1,
"maxLength": 50
}
}
}
}
},
"required": [
"order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}