Raw schema
{
"type": "object",
"properties": {
"order_items": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 500
},
"price": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"quantity": {
"description": "Defaults to 1.",
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"weight": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"code": {
"description": "Item SKU or product code.",
"type": "string",
"maxLength": 200
},
"delivery_type": {
"description": "ship (default), noship, download or future.",
"type": "string",
"enum": [
"ship",
"noship",
"download",
"future"
]
},
"category_code": {
"type": "string",
"maxLength": 200
},
"variation_list": {
"description": "Variations, e.g. {\"Size\":\"Large\",\"Color\":\"Red\"} (max 5,000 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"metadata": {
"description": "Hidden item details (max 15,000 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
}
},
"description": "Line items (at least one)."
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"address1": {
"type": "string",
"maxLength": 200
},
"address2": {
"type": "string",
"maxLength": 200
},
"address3": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"address4": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"city": {
"type": "string",
"maxLength": 200
},
"state": {
"type": "string",
"maxLength": 200,
"description": "State or region."
},
"postal_code": {
"type": "string",
"maxLength": 200
},
"country": {
"type": "string",
"maxLength": 200,
"description": "Country code or full country name."
},
"phone": {
"type": "string",
"maxLength": 200
}
}
},
"customer": {
"description": "Customer (billing) address.",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"address1": {
"type": "string",
"maxLength": 200
},
"address2": {
"type": "string",
"maxLength": 200
},
"address3": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"address4": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"city": {
"type": "string",
"maxLength": 200
},
"state": {
"type": "string",
"maxLength": 200,
"description": "State or region."
},
"postal_code": {
"type": "string",
"maxLength": 200
},
"country": {
"type": "string",
"maxLength": 200,
"description": "Country code or full country name."
},
"phone": {
"type": "string",
"maxLength": 200
}
}
},
"email": {
"description": "Customer e-mail address.",
"type": "string",
"maxLength": 200
},
"source_id": {
"description": "Your own order id (the order's Order Desk id is used when blank).",
"type": "string",
"maxLength": 200
},
"source_name": {
"description": "Order source / cart name (default Order Desk).",
"type": "string",
"maxLength": 200
},
"folder_id": {
"description": "Folder to put the order in (see orderdesk_get_store).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"shipping_method": {
"type": "string",
"maxLength": 200
},
"shipping_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"handling_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"tax_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"payment_type": {
"description": "Visa, MasterCard, PayPal, ...",
"type": "string",
"maxLength": 200
},
"payment_status": {
"description": "Defaults to Captured.",
"type": "string",
"enum": [
"Approved",
"Authorized",
"Captured",
"Fully Refunded",
"Partially Refunded",
"Pending",
"Rejected",
"Voided"
]
},
"checkout_data": {
"description": "Editable extra order details (max 3,500 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"order_metadata": {
"description": "Hidden extra order details (max 2,000 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"required": [
"order_items"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}