Raw schema
{
"type": "object",
"properties": {
"order_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Your unique order id (for example 101-102938)."
},
"sandbox": {
"type": "boolean",
"description": "true = test order, nothing is charged or produced; false = a real, paid order."
},
"confirm": {
"description": "Required (true) for a real order (sandbox=false): set it only after the user has confirmed the items, address, shipping method and that their CustomCat payment method will be charged.",
"type": "boolean"
},
"shipping_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"shipping_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"shipping_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": "Customer email (required by CustomCat)."
},
"shipping_phone": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"shipping_address1": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"shipping_address2": {
"type": "string",
"maxLength": 200
},
"shipping_city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"shipping_state": {
"type": "string",
"minLength": 1,
"maxLength": 60,
"description": "State/province code, e.g. MI."
},
"shipping_zip": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"shipping_country": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "2-letter ISO country code, e.g. US."
},
"shipping_method": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Method name from customcat_list_shipping_methods, e.g. Economy."
},
"items": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"description": "SKU of a product made in CustomCat (from customcat_list_products, e.g. 22-115-4774-254). Use this OR catalog_sku + design_url.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"catalog_sku": {
"description": "Catalog SKU (from customcat_list_catalog or customcat_get_catalog_sku) when you bring your own artwork.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"design_url": {
"description": "Fully qualified https URL of the front design (needed with catalog_sku; leave out for a back-only print).",
"type": "string",
"maxLength": 2000
},
"design_url_back": {
"description": "Optional https URL of the back design. A front+back print adds a $5 fee per line item.",
"type": "string",
"maxLength": 2000
},
"mockup_url": {
"description": "Optional mockup of the front, used in QA.",
"type": "string",
"maxLength": 2000
},
"mockup_url_back": {
"description": "Optional mockup of the back, used in QA.",
"type": "string",
"maxLength": 2000
},
"preset_id": {
"description": "Optional design placement preset (2 full front, 3 full back, 4 default centre chest, 1 left chest wide, 10 left chest tall, 9 default back). Omit for exact artboard placement.",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"preset_back_id": {
"description": "Optional placement preset for the back design.",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"use_embedded_dpi": {
"description": "Use the DPI embedded in the image instead of the default 300.",
"type": "boolean"
},
"line_item_id": {
"description": "Your own id for this line item.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"quantity": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 10000,
"description": "How many of this item."
}
},
"required": [
"quantity"
]
},
"description": "Line items: either {sku, quantity} for products made in CustomCat, or {catalog_sku, design_url, quantity} for your own artwork."
}
},
"required": [
"order_id",
"sandbox",
"shipping_first_name",
"shipping_last_name",
"shipping_email",
"shipping_phone",
"shipping_address1",
"shipping_city",
"shipping_state",
"shipping_zip",
"shipping_country",
"shipping_method",
"items"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}