{"openapi":"3.1.0","info":{"title":"Partner API","version":"1.0.0","description":"Order from your own system: send the artwork, price the order, place it, follow it. Prices are computed here; money is EUR with VAT included. Every change to an order reaches your webhook, signed (X-WebOffice-Signature: t=…,v1=HMAC-SHA256(secret, \"t.body\"))."},"servers":[{"url":"https://www.xyz-prints.com/api/v1/partner"}],"security":[{"bearer":[]}],"paths":{"/":{"get":{"operationId":"me","summary":"Who the key belongs to: your terms, what you owe on account, the limits.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"},"example":{"partner":{"name":"Galeria Norte","email":"orders@galerianorte.pt","lang":"pt"},"terms":{"payment":"account","auto_accept":true,"credit_limit":2500,"open_balance":612.4,"discount_pct":10},"kinds":["print"],"limits":{"lines_per_order":100,"qty_per_line":999,"file_mb":500,"single_request_mb":8,"formats":["tiff","jpg","png","pdf"],"upload_lifetime_hours":72,"pdf_pages":100}}}}},"default":{"description":"An error: unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}}},"/catalogue":{"get":{"operationId":"catalogue","summary":"What can be ordered today, kind by kind: the ids a line names.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalogue"},"example":{"currency":"EUR","prices_include_vat":true,"kinds":[{"kind":"print","items":[{"id":101,"name":"Hahnemühle Photo Rag 308","format":"roll","max_cm":[111.8,1500],"duplex":false,"mounts":["dibond3"],"frames":true}],"options":{"mounts":[{"id":"dibond3","name":"Dibond 3 mm"}]}}]}}}},"default":{"description":"An error: unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}}},"/uploads":{"post":{"operationId":"upload","summary":"Send a file. Up to the single-request limit as multipart field `file`; larger files in chunks. A PDF becomes one file per page.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadForm"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Uploaded"},"example":{"files":[{"id":"k3Fq9w2LxP0aZt7c","name":"harbour-at-dusk.tif","bytes":88213504,"width_px":7200,"height_px":9000,"dpi":300,"dpi_assumed":false,"colour":{"mode":"RGB","bit_depth":16,"profile":true,"assigned":null},"expires_at":"2026-09-28T10:00:00.000Z"}]}}}},"default":{"description":"An error: no_file, format_not_accepted, too_large, unreadable, upload_failed, storage_full, unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}}},"/uploads/{id}":{"get":{"operationId":"upload_get","summary":"A file you sent: its pixels, resolution and colour, and until when it is kept.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadOne"},"example":{"file":{"id":"k3Fq9w2LxP0aZt7c","name":"harbour-at-dusk.tif","bytes":88213504,"width_px":7200,"height_px":9000,"dpi":300,"dpi_assumed":false,"colour":{"mode":"RGB","bit_depth":16,"profile":true,"assigned":null},"expires_at":"2026-09-28T10:00:00.000Z"}}}}},"default":{"description":"An error: unknown_file, unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}}},"/quote":{"post":{"operationId":"quote","summary":"Price an order without placing it: lines, shipping options, VAT, total — and whether it would go straight into production.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBody"},"example":{"lines":[{"kind":"print","qty":2,"paper_id":101,"width_cm":40,"height_cm":50,"file":"k3Fq9w2LxP0aZt7c","fit":"fill","border_cm":2}],"delivery":{"mode":"ship"},"ship_to":{"first_name":"Ana","last_name":"Silva","address_1":"Rua das Flores 12","city":"Porto","postcode":"4050-262","country":"PT","phone":"+351 912 345 678"},"note":"Gift — no invoice in the parcel."}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quote"},"example":{"quote":{"currency":"EUR","lines":[{"kind":"print","name":"Hahnemühle Photo Rag 308","qty":2,"unit_price":54.12,"total":108.24,"vat_rate":23,"details":[{"name":"File","value":"harbour-at-dusk.tif"},{"name":"Sheet","value":"40 × 50 cm"},{"name":"Image","value":"36 × 46 cm"}]}],"warnings":[{"line":0,"code":"cropped","message":"fill cuts 3.2% of the picture away to cover the print; send fit to keep all of it."}],"delivery":{"mode":"ship","service":"ctt_express","label":"CTT Expresso","options":[{"id":"ctt_express","label":"CTT Expresso","price":12.05,"days":[1,2]}]},"totals":{"goods":108.24,"discount":0,"shipping":12.05,"vat":22.49,"total":120.29},"vat":{"rate":23,"exempt":false,"reason":null,"number":"PT509999999","status":"valid_domestic"},"would_be":{"state":"in_production","holds":[]}}}}}},"default":{"description":"An error: too_large, invalid_body, invalid_lines, no_shipping, unknown_service, destination_refused, pickup_not_offered, unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}}},"/orders":{"post":{"operationId":"order_create","summary":"Place an order. Priced here, then accepted into production, held, or left waiting for its payment — by your terms.","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string"},"description":"Your unique key for this attempt (8–200 characters). A retry with the same key returns the first answer and never places a second order."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBody"},"example":{"reference":"SHOP-10482","lines":[{"kind":"print","qty":2,"paper_id":101,"width_cm":40,"height_cm":50,"file":"k3Fq9w2LxP0aZt7c","fit":"fill","border_cm":2}],"delivery":{"mode":"ship"},"ship_to":{"first_name":"Ana","last_name":"Silva","address_1":"Rua das Flores 12","city":"Porto","postcode":"4050-262","country":"PT","phone":"+351 912 345 678"},"note":"Gift — no invoice in the parcel.","expected_total":120.29}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Placed"},"example":{"order":{"number":6214,"reference":"SHOP-10482","state":"in_production","holds":[],"status":"processing","created_at":"2026-09-25T10:04:11.000Z","updated_at":"2026-09-25T10:04:11.000Z","currency":"EUR","payment":{"terms":"account","state":"unpaid","paid_at":null},"totals":{"goods":108.24,"discount":0,"shipping":12.05,"vat":22.49,"total":120.29,"refunded":0},"vat":{"rate":23,"exempt":false,"reason":null,"number":"PT509999999"},"delivery":{"mode":"ship","service":"CTT Expresso","ship_to":{"first_name":"Ana","last_name":"Silva","address_1":"Rua das Flores 12","city":"Porto","postcode":"4050-262","country":"PT","phone":"+351 912 345 678"},"tracking":null},"invoice":null,"note":"Gift — no invoice in the parcel.","lines":[{"kind":"print","name":"Hahnemühle Photo Rag 308","qty":2,"unit_price":54.12,"total":108.24,"vat_rate":23,"details":[{"name":"File","value":"harbour-at-dusk.tif"},{"name":"Sheet","value":"40 × 50 cm"},{"name":"Image","value":"36 × 46 cm"}],"file":"k3Fq9w2LxP0aZt7c"}]},"warnings":[{"line":0,"code":"cropped","message":"fill cuts 3.2% of the picture away to cover the print; send fit to keep all of it."}]}}}},"default":{"description":"An error: idempotency_key_required, in_progress, too_large, invalid_body, invalid_lines, duplicate_reference, price_changed, no_shipping, unknown_service, destination_refused, pickup_not_offered, paused, unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}},"get":{"operationId":"order_list","summary":"Your orders, newest first — or every order changed since a moment, oldest change first, to keep your system in step.","parameters":[{"name":"updated_since","in":"query","schema":{"type":"string"},"description":"ISO 8601 date-time: orders changed after it, oldest change first. Keep the last updated_at and ask again."},{"name":"reference","in":"query","schema":{"type":"string"},"description":"Your own reference: the one order that carries it."},{"name":"limit","in":"query","schema":{"type":"string"},"description":"1–100, default 50. `more: true` says there is another page."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderList"},"example":{"orders":[{"number":6214,"reference":"SHOP-10482","state":"in_production","holds":[],"status":"processing","created_at":"2026-09-25T10:04:11.000Z","updated_at":"2026-09-25T10:04:11.000Z","currency":"EUR","payment":{"terms":"account","state":"unpaid","paid_at":null},"totals":{"goods":108.24,"discount":0,"shipping":12.05,"vat":22.49,"total":120.29,"refunded":0},"vat":{"rate":23,"exempt":false,"reason":null,"number":"PT509999999"},"delivery":{"mode":"ship","service":"CTT Expresso","ship_to":{"first_name":"Ana","last_name":"Silva","address_1":"Rua das Flores 12","city":"Porto","postcode":"4050-262","country":"PT","phone":"+351 912 345 678"},"tracking":null},"invoice":null,"note":"Gift — no invoice in the parcel.","lines":[{"kind":"print","name":"Hahnemühle Photo Rag 308","qty":2,"unit_price":54.12,"total":108.24,"vat_rate":23,"details":[{"name":"File","value":"harbour-at-dusk.tif"},{"name":"Sheet","value":"40 × 50 cm"},{"name":"Image","value":"36 × 46 cm"}],"file":"k3Fq9w2LxP0aZt7c"}]}]}}}},"default":{"description":"An error: invalid_query, unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}}},"/orders/{number}":{"get":{"operationId":"order_get","summary":"One of your orders by its number.","parameters":[{"name":"number","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderOne"},"example":{"order":{"number":6214,"reference":"SHOP-10482","state":"in_production","holds":[],"status":"processing","created_at":"2026-09-25T10:04:11.000Z","updated_at":"2026-09-25T10:04:11.000Z","currency":"EUR","payment":{"terms":"account","state":"unpaid","paid_at":null},"totals":{"goods":108.24,"discount":0,"shipping":12.05,"vat":22.49,"total":120.29,"refunded":0},"vat":{"rate":23,"exempt":false,"reason":null,"number":"PT509999999"},"delivery":{"mode":"ship","service":"CTT Expresso","ship_to":{"first_name":"Ana","last_name":"Silva","address_1":"Rua das Flores 12","city":"Porto","postcode":"4050-262","country":"PT","phone":"+351 912 345 678"},"tracking":null},"invoice":null,"note":"Gift — no invoice in the parcel.","lines":[{"kind":"print","name":"Hahnemühle Photo Rag 308","qty":2,"unit_price":54.12,"total":108.24,"vat_rate":23,"details":[{"name":"File","value":"harbour-at-dusk.tif"},{"name":"Sheet","value":"40 × 50 cm"},{"name":"Image","value":"36 × 46 cm"}],"file":"k3Fq9w2LxP0aZt7c"}]}}}}},"default":{"description":"An error: unknown_order, unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}}},"/orders/{number}/cancel":{"post":{"operationId":"order_cancel","summary":"Cancel an order that is held or still waiting for its payment. Once in production, write to the studio.","parameters":[{"name":"number","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderOne"},"example":{"order":{"number":6214,"reference":"SHOP-10482","state":"cancelled","holds":[],"status":"cancelled","created_at":"2026-09-25T10:04:11.000Z","updated_at":"2026-09-25T10:04:11.000Z","currency":"EUR","payment":{"terms":"account","state":"unpaid","paid_at":null},"totals":{"goods":108.24,"discount":0,"shipping":12.05,"vat":22.49,"total":120.29,"refunded":0},"vat":{"rate":23,"exempt":false,"reason":null,"number":"PT509999999"},"delivery":{"mode":"ship","service":"CTT Expresso","ship_to":{"first_name":"Ana","last_name":"Silva","address_1":"Rua das Flores 12","city":"Porto","postcode":"4050-262","country":"PT","phone":"+351 912 345 678"},"tracking":null},"invoice":null,"note":"Gift — no invoice in the parcel.","lines":[{"kind":"print","name":"Hahnemühle Photo Rag 308","qty":2,"unit_price":54.12,"total":108.24,"vat_rate":23,"details":[{"name":"File","value":"harbour-at-dusk.tif"},{"name":"Sheet","value":"40 × 50 cm"},{"name":"Image","value":"36 × 46 cm"}],"file":"k3Fq9w2LxP0aZt7c"}]}}}}},"default":{"description":"An error: unknown_order, not_cancellable, unauthorised, partner_inactive, address_not_allowed, rate_limited, unknown_call, internal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"error":{"code":"invalid_lines","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm.","fields":[{"field":"lines[0].width_cm","code":"size_not_available","message":"Hahnemühle Photo Rag 308: That size is too large for this paper — the largest print it can make is 111.8 × 1500 cm."}]}}}}}}}},"/openapi.json":{"get":{"operationId":"openapi","summary":"This description as OpenAPI 3.1, for your code generator. Add ?brand=<slug> for the line fields of a brand.","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApi"},"example":{"openapi":"3.1.0"}}}}}}}},"webhooks":{"orderEvent":{"post":{"summary":"Every change to one of your orders: order.created, order.accepted, order.paid, order.shipped, order.ready, order.invoiced, order.completed, order.cancelled, order.refunded, order.updated","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEvent"},"example":{"id":"evt_6f1c0a9b2d3e4f5a6b7c8d9e","event":"order.shipped","created_at":"2026-09-27T15:31:02.000Z","data":{"tracking":"EA123456789PT","order":{"number":6214,"reference":"SHOP-10482","state":"shipped","holds":[],"status":"processing","created_at":"2026-09-25T10:04:11.000Z","updated_at":"2026-09-25T10:04:11.000Z","currency":"EUR","payment":{"terms":"account","state":"unpaid","paid_at":null},"totals":{"goods":108.24,"discount":0,"shipping":12.05,"vat":22.49,"total":120.29,"refunded":0},"vat":{"rate":23,"exempt":false,"reason":null,"number":"PT509999999"},"delivery":{"mode":"ship","service":"CTT Expresso","ship_to":{"first_name":"Ana","last_name":"Silva","address_1":"Rua das Flores 12","city":"Porto","postcode":"4050-262","country":"PT","phone":"+351 912 345 678"},"tracking":"EA123456789PT"},"invoice":null,"note":"Gift — no invoice in the parcel.","lines":[{"kind":"print","name":"Hahnemühle Photo Rag 308","qty":2,"unit_price":54.12,"total":108.24,"vat_rate":23,"details":[{"name":"File","value":"harbour-at-dusk.tif"},{"name":"Sheet","value":"40 × 50 cm"},{"name":"Image","value":"36 × 46 cm"}],"file":"k3Fq9w2LxP0aZt7c"}]}}}}}},"responses":{"200":{"description":"Answer any 2xx within 8 seconds."}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"A partner key, from the studio."}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"Address":{"type":"object","required":["address_1","city","postcode","country"],"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"address_1":{"type":"string"},"address_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2"}},"description":"first_name/last_name or company names the recipient."},"Line":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string"},"qty":{"type":"integer","minimum":1,"maximum":999}},"additionalProperties":true,"description":"Each kind takes its own fields — GET /partner/openapi.json?brand=<slug> for a brand’s."},"OrderBody":{"type":"object","required":["reference","lines"],"properties":{"reference":{"type":"string","maxLength":80,"description":"Your own id for the order — one order per reference. Required to place, ignored by /quote."},"lines":{"type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/Line"}},"delivery":{"type":"object","properties":{"mode":{"type":"string","enum":["ship","pickup"],"default":"ship"},"service":{"type":"string","description":"An option id from /quote; default: the first offered."}}},"ship_to":{"$ref":"#/components/schemas/Address"},"note":{"type":"string","maxLength":2000},"expected_total":{"type":"number","description":"Refuse the order (409 price_changed) unless it comes to this total."}}},"UploadForm":{"type":"object","properties":{"file":{"type":"string","format":"binary"},"session":{"type":"string","description":"Chunked: your id for this file (letters, digits, - and _)"},"index":{"type":"integer"},"total":{"type":"integer"},"chunk_size":{"type":"integer"},"size":{"type":"integer"},"name":{"type":"string"},"chunk":{"type":"string","format":"binary"}}},"Upload":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"bytes":{"type":"integer"},"width_px":{"type":["integer","null"]},"height_px":{"type":["integer","null"]},"dpi":{"type":["number","null"]},"dpi_assumed":{"type":"boolean"},"colour":{"type":"object"},"pdf_page":{"type":"integer"},"expires_at":{"type":"string","format":"date-time"}}},"Uploaded":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/Upload"}},"pages_total":{"type":"integer"},"pages_skipped":{"type":"integer"}}},"UploadOne":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/Upload"}}},"Order":{"type":"object","properties":{"number":{"type":"integer"},"reference":{"type":"string"},"state":{"type":"string","enum":["awaiting_payment","held","in_production","shipped","completed","cancelled","refunded","failed"]},"holds":{"type":"array","items":{"type":"string","enum":["review","credit_limit","no_credit_limit"]}},"status":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"currency":{"type":"string"},"payment":{"type":"object","properties":{"terms":{"type":"string","enum":["account","prepay"]},"state":{"type":"string"},"paid_at":{"type":["string","null"]},"pay_url":{"type":"string"}}},"totals":{"type":"object","properties":{"goods":{"type":"number","description":"EUR, VAT included"},"discount":{"type":"number","description":"EUR, VAT included"},"shipping":{"type":"number","description":"EUR, VAT included"},"vat":{"type":"number","description":"EUR, VAT included"},"total":{"type":"number","description":"EUR, VAT included"},"refunded":{"type":"number","description":"EUR, VAT included"}}},"vat":{"type":"object"},"delivery":{"type":"object","properties":{"mode":{"type":"string"},"service":{"type":"string"},"ship_to":{"type":"object","required":["address_1","city","postcode","country"],"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"address_1":{"type":"string"},"address_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2"}},"description":"first_name/last_name or company names the recipient."},"tracking":{"type":["string","null"]}}},"invoice":{"type":["object","null"]},"note":{"type":"string"},"lines":{"type":"array","items":{"type":"object"}}},"example":{"number":6214,"reference":"SHOP-10482","state":"in_production","holds":[],"status":"processing","created_at":"2026-09-25T10:04:11.000Z","updated_at":"2026-09-25T10:04:11.000Z","currency":"EUR","payment":{"terms":"account","state":"unpaid","paid_at":null},"totals":{"goods":108.24,"discount":0,"shipping":12.05,"vat":22.49,"total":120.29,"refunded":0},"vat":{"rate":23,"exempt":false,"reason":null,"number":"PT509999999"},"delivery":{"mode":"ship","service":"CTT Expresso","ship_to":{"first_name":"Ana","last_name":"Silva","address_1":"Rua das Flores 12","city":"Porto","postcode":"4050-262","country":"PT","phone":"+351 912 345 678"},"tracking":null},"invoice":null,"note":"Gift — no invoice in the parcel.","lines":[{"kind":"print","name":"Hahnemühle Photo Rag 308","qty":2,"unit_price":54.12,"total":108.24,"vat_rate":23,"details":[{"name":"File","value":"harbour-at-dusk.tif"},{"name":"Sheet","value":"40 × 50 cm"},{"name":"Image","value":"36 × 46 cm"}],"file":"k3Fq9w2LxP0aZt7c"}]}},"OrderOne":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/Order"}}},"OrderList":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"more":{"type":"boolean"}}},"Placed":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/Order"},"warnings":{"type":"array","items":{"type":"object"}}}},"Quote":{"type":"object","properties":{"quote":{"type":"object"}}},"Catalogue":{"type":"object","properties":{"kinds":{"type":"array","items":{"type":"object"}}}},"Me":{"type":"object"},"OpenApi":{"type":"object"},"WebhookEvent":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string","enum":["order.created","order.accepted","order.paid","order.shipped","order.ready","order.invoiced","order.completed","order.cancelled","order.refunded","order.updated"]},"created_at":{"type":"string","format":"date-time"},"data":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/Order"}}}}}}}}