{ "openapi": "3.1.0", "info": { "title": "weprintlocal API", "version": "1.0.0", "description": "Print-on-demand, made locally. Quote, order and track print through a network of local printers. Authenticate with `Authorization: Bearer wpl_test_…` (sandbox) or `wpl_live_…`." }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "description": "Store API key (wpl_test_/wpl_live_) or printer key (wpp_live_)" } }, "schemas": { "AddressDtoInput": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "company": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "line1": { "type": "string", "minLength": 1, "maxLength": 200 }, "line2": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "city": { "type": "string", "minLength": 1, "maxLength": 100 }, "region": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "postcode": { "type": "string", "minLength": 1, "maxLength": 20 }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2 }, "phone": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "line1", "city", "postcode", "countryCode" ] }, "CustomerDtoInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "email": { "type": "string", "maxLength": 320, "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,}$" }, "phone": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "name", "email" ] }, "CreateQuoteRequestInput": { "type": "object", "properties": { "productCode": { "type": "string", "minLength": 1, "maxLength": 64 }, "quantity": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "options": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "null" ] } }, "deliveryServiceCode": { "type": "string", "minLength": 1, "maxLength": 64 }, "deliveryCountryCode": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 2 }, { "type": "null" } ] } }, "required": [ "productCode", "quantity", "deliveryServiceCode" ] }, "AddBasketItemRequestInput": { "type": "object", "properties": { "quoteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "files": { "description": "Artwork by role, as the product defines it (e.g. { \"Cover\": fileId, \"Text\": fileId } or { \"Artwork\": fileId }).", "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 20 }, "additionalProperties": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "coverFileId": { "description": "Legacy: same as files.Cover.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "textFileId": { "description": "Legacy: same as files.Text.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "quoteId" ] }, "AttachFilesRequestInput": { "type": "object", "properties": { "files": { "description": "Artwork by role, as the product defines it (e.g. { \"Cover\": fileId, \"Text\": fileId } or { \"Artwork\": fileId }).", "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 20 }, "additionalProperties": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "coverFileId": { "description": "Legacy: same as files.Cover.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "textFileId": { "description": "Legacy: same as files.Text.", "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } } }, "CreateUploadRequestInput": { "type": "object", "properties": { "role": { "type": "string", "minLength": 1, "maxLength": 20 }, "fileName": { "type": "string", "minLength": 1, "maxLength": 500 }, "contentType": { "type": "string", "minLength": 1, "maxLength": 100 }, "sizeBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "role", "fileName", "contentType", "sizeBytes" ] }, "CreateWebhookRequestInput": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 1000 }, "events": { "minItems": 1, "maxItems": 16, "type": "array", "items": { "type": "string", "enum": [ "order.received", "order.status_changed", "order.accepted", "order.in_production", "order.shipped", "order.delivered", "order.cancelled", "order.artwork_failed", "order.failed", "order.on_hold", "order.address_updated", "order.refunded", "order.issue_updated", "order.item_status_changed", "order.delayed", "order.printer_declined" ] } } }, "required": [ "url", "events" ] }, "UpdateWebhookRequestInput": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 1000 }, "events": { "minItems": 1, "maxItems": 16, "type": "array", "items": { "type": "string", "enum": [ "order.received", "order.status_changed", "order.accepted", "order.in_production", "order.shipped", "order.delivered", "order.cancelled", "order.artwork_failed", "order.failed", "order.on_hold", "order.address_updated", "order.refunded", "order.issue_updated", "order.item_status_changed", "order.delayed", "order.printer_declined" ] } }, "isActive": { "type": "boolean" } } }, "OrderLineRequestInput": { "type": "object", "properties": { "quoteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "files": { "description": "Artwork by role, e.g. { \"Cover\": fileId, \"Text\": fileId }.", "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 20 }, "additionalProperties": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "coverFileId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "textFileId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "externalLineId": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "printerCode": { "description": "Merchant API: the printer this item must go to (overrides the order’s printerCode).", "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "quoteId" ] }, "CreateOrderRequestInput": { "type": "object", "properties": { "basketId": { "description": "Order a ready basket (store checkout). Send X-Basket-Token.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "lines": { "description": "Or order quotes directly (API integrations, merchant keys).", "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/OrderLineRequestInput" } }, "customer": { "$ref": "#/components/schemas/CustomerDtoInput" }, "deliveryAddress": { "description": "UK addresses only (GB). Postcodes are validated and normalised.", "$ref": "#/components/schemas/AddressDtoInput" }, "billingAddress": { "anyOf": [ { "$ref": "#/components/schemas/AddressDtoInput" }, { "type": "null" } ] }, "externalReference": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "postbackUrl": { "description": "Merchant API: where this order’s status postbacks go (public https). Defaults to your postback settings.", "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "draft": { "description": "Merchant API: create the order on hold (a draft). It is checked and priced but not sent to a printer until you release it.", "type": "boolean" }, "printerCode": { "description": "Merchant API: the printer on the network to send this order to, e.g. LEEDS-PRESS. It goes to that printer only; if they decline, the order waits for you to choose again. Leave it out and we send it to a printer near the delivery address.", "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "customer", "deliveryAddress" ] }, "SaveViewRequestInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "shared": { "default": false, "type": "boolean" }, "filters": { "default": {}, "type": "object", "propertyNames": { "type": "string", "maxLength": 40 }, "additionalProperties": { "type": "string", "maxLength": 200 } }, "columns": { "default": [], "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 40 } } }, "required": [ "name" ] }, "CanonicalOrderInput": { "type": "object", "properties": { "externalReference": { "type": "string", "maxLength": 100 }, "customer": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "email": { "type": "string", "maxLength": 320 }, "phone": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "name", "email" ] }, "delivery": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "company": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "line1": { "type": "string", "maxLength": 200 }, "line2": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "city": { "type": "string", "maxLength": 100 }, "region": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "postcode": { "type": "string", "maxLength": 20 }, "countryCode": { "type": "string", "maxLength": 2 }, "phone": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "name", "line1", "city", "postcode", "countryCode" ] }, "deliveryServiceCode": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "lines": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "externalLineId": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "sku": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "productCode": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "quantity": { "type": "number" }, "options": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "artwork": { "default": [], "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "maxLength": 20 }, "url": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "fileId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "role" ] } }, "printerCode": { "description": "The printer this item must go to (overrides the order’s printerCode).", "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "quantity" ] } }, "merchantTotal": { "type": [ "number", "null" ] }, "currency": { "anyOf": [ { "type": "string", "maxLength": 3 }, { "type": "null" } ] }, "printerCode": { "description": "The printer on the network to send this order to. Leave it out and we choose one near the delivery address.", "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "externalReference", "customer", "delivery", "lines" ] }, "HoldOrderRequestInput": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "reason" ] }, "ReportIssueRequestInput": { "type": "object", "properties": { "lineNo": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "Damaged", "Misprinted", "WrongItem", "MissingItems", "LostInTransit", "Other" ] }, "description": { "type": "string", "minLength": 10, "maxLength": 2000 }, "affectedQuantity": { "description": "Defaults to the whole line.", "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "lineNo", "kind", "description" ] }, "AddNoteRequestInput": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "body" ] }, "SandboxAdvanceRequestInput": { "type": "object", "properties": { "to": { "type": "string", "enum": [ "InProduction", "Shipped", "Delivered" ] }, "trackingNumber": { "type": "string", "maxLength": 100 } }, "required": [ "to" ] }, "UpdatePrinterProfileRequestInput": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "Active", "Paused" ] }, "maxOpenJobs": { "type": "integer", "minimum": 1, "maximum": 10000 }, "contactEmail": { "type": "string", "maxLength": 320, "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,}$" }, "contactPhone": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } } }, "PrinterResolveIssueRequestInput": { "type": "object", "properties": { "resolution": { "type": "string", "enum": [ "Reprint", "Refund", "Reject" ] }, "note": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "resolution", "note" ] }, "AcceptJobRequestInput": { "default": {}, "type": "object", "properties": { "printerReference": { "type": "string", "maxLength": 100 } } }, "RejectJobRequestInput": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "reason" ] }, "JobStatusUpdateRequestInput": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "InProduction", "Shipped", "Delivered", "Failed" ] }, "carrier": { "type": "string", "maxLength": 60 }, "trackingNumber": { "type": "string", "maxLength": 100 }, "trackingUrl": { "type": "string", "maxLength": 500, "format": "uri" }, "note": { "type": "string", "maxLength": 1000 }, "untracked": { "type": "boolean" } }, "required": [ "status" ] }, "CreateIntakeConnectionRequestInput": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "SHOPIFY", "WOOCOMMERCE", "MAPPED_JSON" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "config": { "default": {}, "type": "object", "properties": { "defaultDeliveryService": { "type": "string", "maxLength": 64 }, "testMode": { "type": "boolean" }, "holdNewOrders": { "type": "boolean" }, "postbackUrl": { "type": "string", "maxLength": 1000 }, "shopDomain": { "type": "string", "maxLength": 255 }, "mapping": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "maxLength": 300 } } }, "additionalProperties": {} } }, "required": [ "channel", "name" ] }, "UpdateIntakeConnectionRequestInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "config": { "type": "object", "properties": { "defaultDeliveryService": { "type": "string", "maxLength": 64 }, "testMode": { "type": "boolean" }, "holdNewOrders": { "type": "boolean" }, "postbackUrl": { "type": "string", "maxLength": 1000 }, "shopDomain": { "type": "string", "maxLength": 255 }, "mapping": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "maxLength": 300 } } }, "additionalProperties": {} }, "isActive": { "type": "boolean" } } }, "SetIntakeSecretRequestInput": { "type": "object", "properties": { "secret": { "type": "string", "minLength": 8, "maxLength": 500 } } }, "CreateSkuMappingRequestInput": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 100 }, "productCode": { "type": "string", "minLength": 1, "maxLength": 64 }, "options": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "required": [ "sku", "productCode" ] }, "UpdateSkuMappingRequestInput": { "type": "object", "properties": { "productCode": { "type": "string", "minLength": 1, "maxLength": 64 }, "options": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } } }, "SetTagsRequestInput": { "type": "object", "properties": { "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 40 } } }, "required": [ "tags" ] }, "CancelItemRequestInput": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "reason" ] }, "ChoosePrinterRequestInput": { "type": "object", "properties": { "printerCode": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "printerCode" ] }, "DuplicateOrderRequestInput": { "type": "object", "properties": { "hold": { "default": true, "type": "boolean" } } }, "ErrorDto": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fieldErrors": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "correlationId": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false }, "SelectedOptionDto": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "valueLabel": { "type": "string" } }, "required": [ "code", "label", "value", "valueLabel" ], "additionalProperties": false }, "QuoteLineDto": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "number" }, "unitAmount": { "type": "number" }, "amount": { "type": "number" } }, "required": [ "type", "code", "description", "quantity", "unitAmount", "amount" ], "additionalProperties": false }, "QuoteDto": { "type": "object", "properties": { "quoteId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quoteNumber": { "type": "string" }, "productCode": { "type": "string" }, "productName": { "type": "string" }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedOptionDto" } }, "deliveryServiceCode": { "type": "string" }, "deliveryCountryCode": { "type": "string" }, "currency": { "type": "string" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineDto" } }, "subtotal": { "type": "number" }, "deliveryTotal": { "type": "number" }, "vatRatePercent": { "type": "number" }, "vatTotal": { "type": "number" }, "total": { "type": "number" }, "createdUtc": { "type": "string" }, "expiresUtc": { "type": "string" }, "isExpired": { "type": "boolean" }, "isUsed": { "type": "boolean" } }, "required": [ "quoteId", "quoteNumber", "productCode", "productName", "quantity", "options", "deliveryServiceCode", "deliveryCountryCode", "currency", "lines", "subtotal", "deliveryTotal", "vatRatePercent", "vatTotal", "total", "createdUtc", "expiresUtc", "isExpired", "isUsed" ], "additionalProperties": false }, "FileDto": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "role": { "type": "string" }, "fileName": { "type": "string" }, "sizeBytes": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sha256": { "type": [ "string", "null" ] }, "uploadStatus": { "type": "string" }, "preflightStatus": { "type": "string" }, "preflightSummary": { "type": [ "string", "null" ] }, "pageCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdUtc": { "type": "string" } }, "required": [ "fileId", "role", "fileName", "uploadStatus", "preflightStatus", "createdUtc" ], "additionalProperties": false }, "AddressDto": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "company": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "line1": { "type": "string", "minLength": 1, "maxLength": 200 }, "line2": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "city": { "type": "string", "minLength": 1, "maxLength": 100 }, "region": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "postcode": { "type": "string", "minLength": 1, "maxLength": 20 }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2 }, "phone": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ] } }, "required": [ "line1", "city", "postcode", "countryCode" ], "additionalProperties": false }, "TimelineStepDto": { "type": "object", "properties": { "status": { "type": "string" }, "label": { "type": "string" }, "state": { "type": "string" }, "atUtc": { "type": [ "string", "null" ] } }, "required": [ "status", "label", "state" ], "additionalProperties": false }, "OrderLineDto": { "type": "object", "properties": { "lineNo": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "productCode": { "type": "string" }, "productName": { "type": "string" }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedOptionDto" } }, "lineTotal": { "type": "number" }, "quoteNumber": { "type": "string" }, "files": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/FileDto" } }, "coverFile": { "$ref": "#/components/schemas/FileDto" }, "textFile": { "$ref": "#/components/schemas/FileDto" }, "shipment": { "anyOf": [ { "type": "object", "properties": { "carrier": { "type": [ "string", "null" ] }, "trackingNumber": { "type": [ "string", "null" ] }, "trackingUrl": { "type": [ "string", "null" ] }, "shippedUtc": { "type": [ "string", "null" ] } }, "required": [ "carrier", "trackingNumber", "trackingUrl", "shippedUtc" ], "additionalProperties": false }, { "type": "null" } ] }, "cancelled": { "type": "boolean" }, "cancelReason": { "type": [ "string", "null" ] } }, "required": [ "lineNo", "productCode", "productName", "quantity", "options", "lineTotal", "quoteNumber", "files" ], "additionalProperties": false }, "OrderIssueDto": { "type": "object", "properties": { "issueReference": { "type": "string" }, "lineNo": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "kind": { "type": "string" }, "description": { "type": "string" }, "affectedQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string", "description": "Open | Reprinting | Refunded | Rejected" }, "resolution": { "type": [ "string", "null" ] }, "resolutionNote": { "type": [ "string", "null" ] }, "raisedBy": { "type": "string" }, "printerAtFault": { "type": [ "boolean", "null" ] }, "createdUtc": { "type": "string" }, "resolvedUtc": { "type": [ "string", "null" ] } }, "required": [ "issueReference", "lineNo", "kind", "description", "affectedQuantity", "status", "resolution", "resolutionNote", "raisedBy", "createdUtc", "resolvedUtc" ], "additionalProperties": false }, "RefundDto": { "type": "object", "properties": { "refundId": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "method": { "type": "string", "description": "Card (back to the card) | Credit (off the next account invoice)" }, "reason": { "type": "string" }, "status": { "type": "string" }, "createdUtc": { "type": "string" }, "completedUtc": { "type": [ "string", "null" ] } }, "required": [ "refundId", "amount", "currency", "method", "reason", "status", "createdUtc", "completedUtc" ], "additionalProperties": false }, "OrderDto": { "type": "object", "properties": { "orderReference": { "type": "string" }, "status": { "type": "string" }, "paymentStatus": { "type": "string" }, "sourceChannel": { "type": "string" }, "externalReference": { "type": [ "string", "null" ] }, "isTest": { "type": "boolean" }, "currency": { "type": "string" }, "subtotal": { "type": "number" }, "deliveryTotal": { "type": "number" }, "vatTotal": { "type": "number" }, "total": { "type": "number" }, "customerName": { "type": "string" }, "deliveryAddress": { "$ref": "#/components/schemas/AddressDto" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineDto" } }, "timeline": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineStepDto" } }, "customerEmail": { "type": "string" }, "paymentMethod": { "description": "Card | Account", "type": "string" }, "deliveryServiceCode": { "type": [ "string", "null" ] }, "onHold": { "type": "boolean" }, "holdReason": { "type": [ "string", "null" ] }, "cancelReason": { "type": [ "string", "null" ] }, "refundedTotal": { "type": "number" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/OrderIssueDto" } }, "refunds": { "type": "array", "items": { "$ref": "#/components/schemas/RefundDto" } }, "tags": { "type": "array", "items": { "type": "string" } }, "dispatchBy": { "description": "Working day (YYYY-MM-DD, UK time) the order must be dispatched by under its SLA.", "type": [ "string", "null" ] }, "slaStatus": { "anyOf": [ { "type": "string", "enum": [ "OnTrack", "DueToday", "Late", "Met", "Missed" ] }, { "type": "null" } ] }, "duplicatedFrom": { "type": [ "string", "null" ] }, "can": { "type": "object", "properties": { "hold": { "type": "boolean" }, "release": { "type": "boolean" }, "cancel": { "type": "boolean" }, "changeAddress": { "type": "boolean" }, "reportIssue": { "type": "boolean" }, "cancelItems": { "type": "boolean" }, "duplicate": { "type": "boolean" } }, "required": [ "hold", "release", "cancel", "changeAddress", "reportIssue" ], "additionalProperties": false }, "createdUtc": { "type": "string" }, "updatedUtc": { "type": "string" } }, "required": [ "orderReference", "status", "paymentStatus", "sourceChannel", "isTest", "currency", "subtotal", "deliveryTotal", "vatTotal", "total", "customerName", "deliveryAddress", "lines", "timeline", "createdUtc", "updatedUtc" ], "additionalProperties": false }, "TenantDto": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "currency": { "type": "string" }, "supportEmail": { "type": [ "string", "null" ] }, "theme": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "slug", "name", "currency", "theme" ], "additionalProperties": false }, "ProductSummaryDto": { "type": "object", "properties": { "code": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "isAvailable": { "type": "boolean" }, "minQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "maxQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "code", "slug", "name", "isAvailable", "minQuantity", "maxQuantity" ], "additionalProperties": false }, "OptionValueDto": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "required": [ "code", "label" ], "additionalProperties": false }, "ProductOptionDto": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "helpText": { "type": [ "string", "null" ] }, "inputType": { "type": "string" }, "isRequired": { "type": "boolean" }, "minNumber": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNumber": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stepNumber": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "defaultValue": { "type": [ "string", "null" ] }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/OptionValueDto" } } }, "required": [ "code", "label", "inputType", "isRequired", "values" ], "additionalProperties": false }, "DeliveryServiceDto": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "leadTimeDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "code", "name", "leadTimeDays" ], "additionalProperties": false }, "ProductDetailDto": { "type": "object", "properties": { "code": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "imageUrl": { "type": [ "string", "null" ] }, "isAvailable": { "type": "boolean" }, "minQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "maxQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "description": { "type": [ "string", "null" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "artworkGuidance": { "type": [ "string", "null" ] }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOptionDto" } }, "deliveryServices": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryServiceDto" } }, "requiredFiles": { "type": "array", "items": { "type": "string" } } }, "required": [ "code", "slug", "name", "isAvailable", "minQuantity", "maxQuantity", "templateVersion", "options", "deliveryServices", "requiredFiles" ], "additionalProperties": false }, "StoreHostDto": { "type": "object", "properties": { "slug": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "slug", "domain" ], "additionalProperties": false }, "CreateBasketResponse": { "type": "object", "properties": { "basketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "basketToken": { "type": "string" } }, "required": [ "basketId", "basketToken" ], "additionalProperties": false }, "BasketItemDto": { "type": "object", "properties": { "itemId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "quote": { "$ref": "#/components/schemas/QuoteDto" }, "files": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/FileDto" } }, "coverFile": { "$ref": "#/components/schemas/FileDto" }, "textFile": { "$ref": "#/components/schemas/FileDto" }, "issues": { "type": "array", "items": { "type": "string" } } }, "required": [ "itemId", "quote", "files", "issues" ], "additionalProperties": false }, "BasketDto": { "type": "object", "properties": { "basketId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "status": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/BasketItemDto" } }, "subtotal": { "type": "number" }, "deliveryTotal": { "type": "number" }, "vatTotal": { "type": "number" }, "total": { "type": "number" }, "canCheckout": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "string" } }, "orderReference": { "type": [ "string", "null" ] } }, "required": [ "basketId", "status", "currency", "items", "subtotal", "deliveryTotal", "vatTotal", "total", "canCheckout", "issues" ], "additionalProperties": false }, "UploadGrantDto": { "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "uploadToken": { "type": "string" }, "expiresUtc": { "type": "string" }, "maxBytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "uploadPath": { "type": "string" } }, "required": [ "fileId", "uploadToken", "expiresUtc", "maxBytes", "uploadPath" ], "additionalProperties": false }, "WebhookSubscriptionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "createdUtc": { "type": "string" } }, "required": [ "id", "url", "events", "isActive", "createdUtc" ], "additionalProperties": false }, "WebhookSubscriptionWithSecretDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "createdUtc": { "type": "string" }, "secret": { "type": "string", "description": "Signing secret, shown once. Verify X-WPL-Signature: t=,v1=hex(HMAC-SHA256(secret, t + \".\" + body))." } }, "required": [ "id", "url", "events", "isActive", "createdUtc", "secret" ], "additionalProperties": false }, "CreatedOrderDto": { "type": "object", "properties": { "orderReference": { "type": "string" }, "status": { "type": "string" }, "paymentStatus": { "type": "string" }, "sourceChannel": { "type": "string" }, "externalReference": { "type": [ "string", "null" ] }, "isTest": { "type": "boolean" }, "currency": { "type": "string" }, "subtotal": { "type": "number" }, "deliveryTotal": { "type": "number" }, "vatTotal": { "type": "number" }, "total": { "type": "number" }, "customerName": { "type": "string" }, "deliveryAddress": { "$ref": "#/components/schemas/AddressDto" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineDto" } }, "timeline": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineStepDto" } }, "customerEmail": { "type": "string" }, "paymentMethod": { "description": "Card | Account", "type": "string" }, "deliveryServiceCode": { "type": [ "string", "null" ] }, "onHold": { "type": "boolean" }, "holdReason": { "type": [ "string", "null" ] }, "cancelReason": { "type": [ "string", "null" ] }, "refundedTotal": { "type": "number" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/OrderIssueDto" } }, "refunds": { "type": "array", "items": { "$ref": "#/components/schemas/RefundDto" } }, "tags": { "type": "array", "items": { "type": "string" } }, "dispatchBy": { "description": "Working day (YYYY-MM-DD, UK time) the order must be dispatched by under its SLA.", "type": [ "string", "null" ] }, "slaStatus": { "anyOf": [ { "type": "string", "enum": [ "OnTrack", "DueToday", "Late", "Met", "Missed" ] }, { "type": "null" } ] }, "duplicatedFrom": { "type": [ "string", "null" ] }, "can": { "type": "object", "properties": { "hold": { "type": "boolean" }, "release": { "type": "boolean" }, "cancel": { "type": "boolean" }, "changeAddress": { "type": "boolean" }, "reportIssue": { "type": "boolean" }, "cancelItems": { "type": "boolean" }, "duplicate": { "type": "boolean" } }, "required": [ "hold", "release", "cancel", "changeAddress", "reportIssue" ], "additionalProperties": false }, "createdUtc": { "type": "string" }, "updatedUtc": { "type": "string" }, "accessToken": { "description": "Store orders only, returned once: the shopper's credential for the tracking page (send as X-Order-Token).", "type": "string" } }, "required": [ "orderReference", "status", "paymentStatus", "sourceChannel", "isTest", "currency", "subtotal", "deliveryTotal", "vatTotal", "total", "customerName", "deliveryAddress", "lines", "timeline", "createdUtc", "updatedUtc" ], "additionalProperties": false }, "OrderSummaryDto": { "type": "object", "properties": { "orderReference": { "type": "string" }, "status": { "type": "string" }, "paymentStatus": { "type": "string" }, "sourceChannel": { "type": "string" }, "externalReference": { "type": [ "string", "null" ] }, "isTest": { "type": "boolean" }, "currency": { "type": "string" }, "total": { "type": "number" }, "customerName": { "type": "string" }, "createdUtc": { "type": "string" }, "updatedUtc": { "type": "string" }, "postcode": { "type": "string" }, "onHold": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "dispatchBy": { "type": [ "string", "null" ] }, "slaStatus": { "anyOf": [ { "type": "string", "enum": [ "OnTrack", "DueToday", "Late", "Met", "Missed" ] }, { "type": "null" } ] } }, "required": [ "orderReference", "status", "paymentStatus", "sourceChannel", "externalReference", "isTest", "currency", "total", "customerName", "createdUtc", "updatedUtc" ], "additionalProperties": false }, "OrderPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderSummaryDto" } }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "page", "pageSize", "total" ], "additionalProperties": false }, "OrderNoteDto": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "author": { "type": "string" }, "body": { "type": "string" }, "internal": { "type": "boolean" }, "createdUtc": { "type": "string" } }, "required": [ "id", "author", "body", "internal", "createdUtc" ], "additionalProperties": false }, "OrderActivityDto": { "type": "object", "properties": { "atUtc": { "type": "string" }, "kind": { "type": "string" }, "text": { "type": "string" }, "actor": { "type": [ "string", "null" ] } }, "required": [ "atUtc", "kind", "text", "actor" ], "additionalProperties": false }, "SavedViewDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "shared": { "type": "boolean" }, "filters": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "string" } }, "createdUtc": { "type": "string" } }, "required": [ "id", "name", "shared", "filters", "columns", "createdUtc" ], "additionalProperties": false }, "PrinterProfileDto": { "type": "object", "properties": { "printerId": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "contactEmail": { "type": "string" }, "contactPhone": { "type": [ "string", "null" ] }, "address": { "$ref": "#/components/schemas/AddressDto" }, "serviceRadiusKm": { "type": [ "number", "null" ] }, "countries": { "type": "array", "items": { "type": "string" } }, "maxOpenJobs": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "openJobs": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "offerTimeoutMinutes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "connector": { "type": "string" }, "qualityScore": { "type": "number" }, "performance": { "type": "object", "properties": { "acceptanceRate": { "type": [ "number", "null" ] }, "onTimeRate": { "type": [ "number", "null" ] }, "offers": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "shipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "acceptanceRate", "onTimeRate", "offers", "shipped" ], "additionalProperties": false } }, "required": [ "printerId", "code", "name", "status", "contactEmail", "contactPhone", "address", "serviceRadiusKm", "countries", "maxOpenJobs", "openJobs", "offerTimeoutMinutes", "connector", "qualityScore", "performance" ], "additionalProperties": false }, "PrinterJobSummaryDto": { "type": "object", "properties": { "jobReference": { "type": "string" }, "status": { "type": "string" }, "productCode": { "type": "string" }, "productName": { "type": "string" }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "offerExpiresUtc": { "type": [ "string", "null" ] }, "dueByUtc": { "type": [ "string", "null" ] }, "createdUtc": { "type": "string" } }, "required": [ "jobReference", "status", "productCode", "productName", "quantity", "offerExpiresUtc", "dueByUtc", "createdUtc" ], "additionalProperties": false }, "PrinterIssueDto": { "type": "object", "properties": { "issueReference": { "type": "string" }, "jobReference": { "type": "string" }, "orderReference": { "type": "string" }, "isTest": { "type": "boolean" }, "lineNo": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "productName": { "type": "string" }, "kind": { "type": "string" }, "description": { "type": "string" }, "affectedQuantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "status": { "type": "string" }, "resolution": { "type": [ "string", "null" ] }, "resolutionNote": { "type": [ "string", "null" ] }, "createdUtc": { "type": "string" }, "resolvedUtc": { "type": [ "string", "null" ] } }, "required": [ "issueReference", "jobReference", "orderReference", "isTest", "lineNo", "productName", "kind", "description", "affectedQuantity", "status", "resolution", "resolutionNote", "createdUtc", "resolvedUtc" ], "additionalProperties": false }, "IntakeIssueDto": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false }, "IntakeResultDto": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "externalReference": { "type": "string" }, "status": { "type": "string", "enum": [ "Accepted", "Rejected", "Duplicate" ] }, "orderReference": { "type": "string" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/IntakeIssueDto" } } }, "required": [ "recordId", "externalReference", "status" ], "additionalProperties": false }, "IntakeRecordDto": { "type": "object", "properties": { "recordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "channel": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "externalReference": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/IntakeIssueDto" } }, "orderReference": { "type": [ "string", "null" ] }, "receivedUtc": { "type": "string" } }, "required": [ "recordId", "channel", "connectionId", "externalReference", "status", "issues", "orderReference", "receivedUtc" ], "additionalProperties": false }, "IntakeConnectionDto": { "type": "object", "properties": { "connectionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "channel": { "type": "string" }, "name": { "type": "string" }, "inboundUrl": { "type": "string" }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "hasSecret": { "type": "boolean" }, "isActive": { "type": "boolean" }, "createdUtc": { "type": "string" } }, "required": [ "connectionId", "channel", "name", "inboundUrl", "config", "hasSecret", "isActive", "createdUtc" ], "additionalProperties": false }, "SkuMappingDto": { "type": "object", "properties": { "mappingId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sku": { "type": "string" }, "productCode": { "type": "string" }, "options": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "required": [ "mappingId", "sku", "productCode", "options" ], "additionalProperties": false }, "SandboxAdvanceResult": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "object", "properties": { "jobReference": { "type": "string" }, "status": { "type": "string" } }, "required": [ "jobReference", "status" ], "additionalProperties": false } } }, "required": [ "jobs" ], "additionalProperties": false }, "IntakeWebhookAck": { "type": "object", "properties": { "received": { "type": "boolean" }, "recordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "received" ], "additionalProperties": false }, "WebhookDeliveryDto": { "type": "object", "properties": { "id": { "type": "string" }, "target": { "type": "string" }, "url": { "type": "string" }, "event": { "type": "string" }, "orderReference": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lastStatusCode": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "lastError": { "type": [ "string", "null" ] }, "history": { "type": "array", "items": { "type": "object", "properties": { "at": { "type": "string" }, "statusCode": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "error": { "type": [ "string", "null" ] }, "ms": { "type": "number" } }, "required": [ "at", "statusCode", "error", "ms" ], "additionalProperties": false } }, "nextAttemptUtc": { "type": [ "string", "null" ] }, "deliveredUtc": { "type": [ "string", "null" ] }, "createdUtc": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "target", "url", "event", "orderReference", "status", "attempts", "lastStatusCode", "lastError", "history", "nextAttemptUtc", "deliveredUtc", "createdUtc", "body" ], "additionalProperties": false }, "PostbackSettingsDto": { "type": "object", "properties": { "url": { "description": "Default postback URL for your orders (an order can give its own postbackUrl).", "type": [ "string", "null" ] }, "hasSecret": { "type": "boolean" }, "secret": { "description": "Shown once, when rotated.", "type": "string" } }, "required": [ "url", "hasSecret" ], "additionalProperties": false } } }, "paths": { "/v1/store": { "get": { "summary": "The store named by the caller (theme, currency, support contact)", "tags": [ "Store" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/products": { "get": { "summary": "Products this store can sell, with availability from its price books", "tags": [ "Store" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSummaryDto" } } } } } } } }, "/v1/products/{productCode}": { "get": { "summary": "A product with its options and delivery services", "tags": [ "Store" ], "parameters": [ { "schema": { "type": "string", "maxLength": 100 }, "in": "path", "name": "productCode", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/quotes": { "post": { "summary": "Price a configuration. Quotes are immutable and expire; add one to a basket or order to buy it.", "tags": [ "Quotes" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateQuoteRequestInput" } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/quotes/{quoteId}": { "get": { "summary": "A quote issued to this store", "tags": [ "Quotes" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "quoteId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/baskets": { "post": { "summary": "Create a basket. The returned token is its only credential: keep it server-side (e.g. an HttpOnly cookie) and send it as X-Basket-Token.", "tags": [ "Baskets" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBasketResponse" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/baskets/{basketId}": { "get": { "summary": "The basket with totals, per-item issues and whether it can be checked out.", "tags": [ "Baskets" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "basketId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasketDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/baskets/{basketId}/items": { "post": { "summary": "Add a quote to the basket, optionally with its artwork.", "tags": [ "Baskets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddBasketItemRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "basketId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasketDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/baskets/{basketId}/items/{itemId}/files": { "put": { "summary": "Attach (or replace) artwork on a basket item.", "tags": [ "Baskets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachFilesRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "basketId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "itemId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasketDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/baskets/{basketId}/items/{itemId}/requote": { "post": { "summary": "Re-price an item (e.g. after its quote expired) with the same configuration; artwork is kept.", "tags": [ "Baskets" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "basketId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "itemId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasketDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/baskets/{basketId}/items/{itemId}": { "delete": { "summary": "Remove an item from the basket.", "tags": [ "Baskets" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "basketId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "itemId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasketDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/files/uploads": { "post": { "summary": "Step 1: request a short-lived upload grant for one artwork file (role as the product defines, e.g. Cover, Text, Artwork).", "tags": [ "Files" ], "description": "Send X-Basket-Token when uploading for a basket so the file can be attached to it. Keep the returned uploadToken: it is the file's credential.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUploadRequestInput" } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadGrantDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/files/uploads/{fileId}/content": { "put": { "summary": "Step 2: stream the file bytes (Content-Type application/pdf, image/png, image/jpeg or application/octet-stream) with the grant in X-Upload-Token.", "tags": [ "Files" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "fileId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/files/{fileId}": { "get": { "summary": "Upload and artwork-check status of a file.", "tags": [ "Files" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "fileId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders": { "post": { "summary": "Place an order from a ready basket, or directly from quotes (API). Repeats with the same basket, Idempotency-Key or externalReference return the existing order with 200.", "tags": [ "Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "maxLength": 100 }, "in": "header", "name": "idempotency-key", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedOrderDto" } } } }, "201": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedOrderDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } }, "get": { "summary": "Your store's orders, newest first, with search and filters (merchant key, or signed-in store staff).", "tags": [ "Orders" ], "parameters": [ { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "q", "required": false, "description": "Search order reference, your reference, customer name or e-mail, or postcode." }, { "schema": { "type": "string", "maxLength": 30 }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "channel", "required": false }, { "schema": { "type": "string", "maxLength": 100 }, "in": "query", "name": "externalReference", "required": false }, { "schema": {}, "in": "query", "name": "from", "required": false, "description": "Placed on or after (ISO date)." }, { "schema": {}, "in": "query", "name": "to", "required": false, "description": "Placed before (ISO date)." }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "onHold", "required": false }, { "schema": { "type": "string", "maxLength": 40 }, "in": "query", "name": "tag", "required": false, "description": "Only orders with this tag." }, { "schema": { "type": "string", "enum": [ "Late", "DueToday", "OnTrack" ] }, "in": "query", "name": "sla", "required": false, "description": "Open orders that are past, on, or before their dispatch-by date." }, { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "pageSize", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderPage" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders/export": { "get": { "summary": "Download your orders as CSV (same filters as the list; up to 5,000 rows, one row per line).", "tags": [ "Orders" ], "parameters": [ { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "q", "required": false, "description": "Search order reference, your reference, customer name or e-mail, or postcode." }, { "schema": { "type": "string", "maxLength": 30 }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "channel", "required": false }, { "schema": { "type": "string", "maxLength": 100 }, "in": "query", "name": "externalReference", "required": false }, { "schema": {}, "in": "query", "name": "from", "required": false, "description": "Placed on or after (ISO date)." }, { "schema": {}, "in": "query", "name": "to", "required": false, "description": "Placed before (ISO date)." }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "onHold", "required": false }, { "schema": { "type": "string", "maxLength": 40 }, "in": "query", "name": "tag", "required": false, "description": "Only orders with this tag." }, { "schema": { "type": "string", "enum": [ "Late", "DueToday", "OnTrack" ] }, "in": "query", "name": "sla", "required": false, "description": "Open orders that are past, on, or before their dispatch-by date." } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/orders/{orderReference}": { "get": { "summary": "Order status, artwork, timeline, shipment tracking, issues and refunds. Shoppers (via the store) send X-Order-Token or X-Basket-Token.", "tags": [ "Orders" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders/{orderReference}/cancel": { "post": { "summary": "Cancel an order before any printer has accepted it. Nothing is refunded automatically: refunds are agreed between you and the printer. Shoppers can only cancel unpaid orders.", "tags": [ "Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "maxLength": 500 } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders/{orderReference}/hold": { "post": { "summary": "Put an order on hold: nothing goes to a printer until you release it. Only before a printer accepts it.", "tags": [ "Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HoldOrderRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders/{orderReference}/release": { "post": { "summary": "Release a held order or confirm a draft, so it goes on to production.", "tags": [ "Orders" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders/{orderReference}/delivery-address": { "put": { "summary": "Change the delivery address (UK only) until a printer accepts the order. The order is re-routed to the best printer for the new address.", "tags": [ "Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressDtoInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders/{orderReference}/issues": { "get": { "summary": "Problems reported on this order and how they were resolved", "tags": [ "Orders" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderIssueDto" } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } }, "post": { "summary": "Report a problem with a dispatched item (within 30 days): damaged, misprinted, wrong item, missing items or lost in transit. The printer who made it sees the report and answers it (a reprint, a refund or a reply); we carry the messages.", "tags": [ "Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportIssueRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderIssueDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders/{orderReference}/notes": { "get": { "summary": "Notes on the order shared between your team and ours", "tags": [ "Orders" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderNoteDto" } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } }, "post": { "summary": "Add a note to the order (visible to your team and ours)", "tags": [ "Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddNoteRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNoteDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/orders/{orderReference}/activity": { "get": { "summary": "Everything that happened to the order, newest first", "tags": [ "Orders" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "orderReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderActivityDto" } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/sandbox/jobs/{jobReference}/advance": { "post": { "summary": "Advance a sandbox job (test keys only) to InProduction, Shipped or Delivered", "tags": [ "Sandbox" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxAdvanceRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "jobReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SandboxAdvanceResult" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/me": { "get": { "summary": "Your printer profile, capacity and status", "tags": [ "Printer portal" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrinterProfileDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } }, "patch": { "summary": "Pause or resume new offers, change capacity or contact details", "tags": [ "Printer portal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePrinterProfileRequestInput" } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrinterProfileDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/jobs": { "get": { "summary": "Your jobs, newest first", "tags": [ "Printer portal" ], "parameters": [ { "schema": { "type": "string", "maxLength": 100 }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "cursor", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterJobSummaryDto" } }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "items", "nextCursor" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/jobs/{jobReference}": { "get": { "summary": "One of your jobs: options, artwork links, delivery, due date, history", "tags": [ "Printer portal" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "jobReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobReference": { "type": "string" }, "status": { "type": "string" }, "attempt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "product": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "code", "name" ], "additionalProperties": false }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "options": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "valueLabel": { "type": "string" } }, "required": [ "code", "label", "value", "valueLabel" ], "additionalProperties": false } }, "artwork": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string" }, "fileName": { "type": "string" }, "sizeBytes": { "type": [ "number", "null" ] }, "sha256": { "type": [ "string", "null" ] }, "pageCount": { "type": [ "number", "null" ] }, "url": { "type": "string" } }, "required": [ "role", "fileName", "sizeBytes", "sha256", "pageCount", "url" ], "additionalProperties": false } }, "delivery": { "type": "object", "properties": { "serviceCode": { "type": [ "string", "null" ] }, "address": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "serviceCode", "address" ], "additionalProperties": false }, "offeredUtc": { "type": [ "string", "null" ] }, "offerExpiresUtc": { "type": [ "string", "null" ] }, "acceptedUtc": { "type": [ "string", "null" ] }, "dueByUtc": { "type": [ "string", "null" ] }, "cost": { "type": [ "number", "null" ] }, "currency": { "type": "string" }, "printerReference": { "type": [ "string", "null" ] }, "carrier": { "type": [ "string", "null" ] }, "trackingNumber": { "type": [ "string", "null" ] }, "trackingUrl": { "type": [ "string", "null" ] }, "shippedUtc": { "type": [ "string", "null" ] }, "events": { "type": "array", "items": { "type": "object", "properties": { "fromStatus": { "type": [ "string", "null" ] }, "toStatus": { "type": "string" }, "actor": { "type": "string" }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "atUtc": { "type": "string" } }, "required": [ "fromStatus", "toStatus", "actor", "detail", "atUtc" ], "additionalProperties": false } } }, "required": [ "jobReference", "status", "attempt", "product", "quantity", "options", "artwork", "delivery", "offeredUtc", "offerExpiresUtc", "acceptedUtc", "dueByUtc", "cost", "currency", "printerReference", "carrier", "trackingNumber", "trackingUrl", "shippedUtc", "events" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/jobs/{jobReference}/files/{role}": { "get": { "summary": "Download artwork for a job you hold (while offered or in progress)", "tags": [ "Printer portal" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "jobReference", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 20 }, "in": "path", "name": "role", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/v1/printer/issues": { "get": { "summary": "Problems reported on items you made (open ones by default)", "tags": [ "Printer portal" ], "parameters": [ { "schema": { "default": "Open", "type": "string", "enum": [ "Open", "All" ] }, "in": "query", "name": "status", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterIssueDto" } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/jobs/{jobReference}/issues": { "get": { "summary": "Problems reported on this job", "tags": [ "Printer portal" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "jobReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrinterIssueDto" } } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/jobs/{jobReference}/issues/{issueReference}/resolve": { "post": { "summary": "Answer a problem on your job: Reprint (a new job for the affected quantity, offered to you), Refund (you have refunded the merchant yourself; nothing is paid through weprintlocal) or Reject (with your reason). The merchant sees your note.", "tags": [ "Printer portal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrinterResolveIssueRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "jobReference", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "issueReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrinterIssueDto" } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/jobs/{jobReference}/accept": { "post": { "summary": "Accept an offered job", "tags": [ "Printer portal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptJobRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "jobReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobReference": { "type": "string" }, "status": { "type": "string" }, "attempt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "product": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "code", "name" ], "additionalProperties": false }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "options": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "valueLabel": { "type": "string" } }, "required": [ "code", "label", "value", "valueLabel" ], "additionalProperties": false } }, "artwork": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string" }, "fileName": { "type": "string" }, "sizeBytes": { "type": [ "number", "null" ] }, "sha256": { "type": [ "string", "null" ] }, "pageCount": { "type": [ "number", "null" ] }, "url": { "type": "string" } }, "required": [ "role", "fileName", "sizeBytes", "sha256", "pageCount", "url" ], "additionalProperties": false } }, "delivery": { "type": "object", "properties": { "serviceCode": { "type": [ "string", "null" ] }, "address": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "serviceCode", "address" ], "additionalProperties": false }, "offeredUtc": { "type": [ "string", "null" ] }, "offerExpiresUtc": { "type": [ "string", "null" ] }, "acceptedUtc": { "type": [ "string", "null" ] }, "dueByUtc": { "type": [ "string", "null" ] }, "cost": { "type": [ "number", "null" ] }, "currency": { "type": "string" }, "printerReference": { "type": [ "string", "null" ] }, "carrier": { "type": [ "string", "null" ] }, "trackingNumber": { "type": [ "string", "null" ] }, "trackingUrl": { "type": [ "string", "null" ] }, "shippedUtc": { "type": [ "string", "null" ] }, "events": { "type": "array", "items": { "type": "object", "properties": { "fromStatus": { "type": [ "string", "null" ] }, "toStatus": { "type": "string" }, "actor": { "type": "string" }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "atUtc": { "type": "string" } }, "required": [ "fromStatus", "toStatus", "actor", "detail", "atUtc" ], "additionalProperties": false } } }, "required": [ "jobReference", "status", "attempt", "product", "quantity", "options", "artwork", "delivery", "offeredUtc", "offerExpiresUtc", "acceptedUtc", "dueByUtc", "cost", "currency", "printerReference", "carrier", "trackingNumber", "trackingUrl", "shippedUtc", "events" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/jobs/{jobReference}/reject": { "post": { "summary": "Decline an offer (or hand back an accepted job before production); it's re-routed", "tags": [ "Printer portal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectJobRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "jobReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobReference": { "type": "string" }, "status": { "type": "string" } }, "required": [ "jobReference", "status" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/printer/jobs/{jobReference}/status": { "post": { "summary": "Report progress: InProduction, Shipped (tracking required unless untracked), Delivered or Failed", "tags": [ "Printer portal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatusUpdateRequestInput" } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "in": "path", "name": "jobReference", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobReference": { "type": "string" }, "status": { "type": "string" }, "attempt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "product": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "code", "name" ], "additionalProperties": false }, "quantity": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "options": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" }, "valueLabel": { "type": "string" } }, "required": [ "code", "label", "value", "valueLabel" ], "additionalProperties": false } }, "artwork": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string" }, "fileName": { "type": "string" }, "sizeBytes": { "type": [ "number", "null" ] }, "sha256": { "type": [ "string", "null" ] }, "pageCount": { "type": [ "number", "null" ] }, "url": { "type": "string" } }, "required": [ "role", "fileName", "sizeBytes", "sha256", "pageCount", "url" ], "additionalProperties": false } }, "delivery": { "type": "object", "properties": { "serviceCode": { "type": [ "string", "null" ] }, "address": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "serviceCode", "address" ], "additionalProperties": false }, "offeredUtc": { "type": [ "string", "null" ] }, "offerExpiresUtc": { "type": [ "string", "null" ] }, "acceptedUtc": { "type": [ "string", "null" ] }, "dueByUtc": { "type": [ "string", "null" ] }, "cost": { "type": [ "number", "null" ] }, "currency": { "type": "string" }, "printerReference": { "type": [ "string", "null" ] }, "carrier": { "type": [ "string", "null" ] }, "trackingNumber": { "type": [ "string", "null" ] }, "trackingUrl": { "type": [ "string", "null" ] }, "shippedUtc": { "type": [ "string", "null" ] }, "events": { "type": "array", "items": { "type": "object", "properties": { "fromStatus": { "type": [ "string", "null" ] }, "toStatus": { "type": "string" }, "actor": { "type": "string" }, "detail": { "anyOf": [ {}, { "type": "null" } ] }, "atUtc": { "type": "string" } }, "required": [ "fromStatus", "toStatus", "actor", "detail", "atUtc" ], "additionalProperties": false } } }, "required": [ "jobReference", "status", "attempt", "product", "quantity", "options", "artwork", "delivery", "offeredUtc", "offerExpiresUtc", "acceptedUtc", "dueByUtc", "cost", "currency", "printerReference", "carrier", "trackingNumber", "trackingUrl", "shippedUtc", "events" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/intake/orders": { "post": { "summary": "Submit orders in the canonical format; each is accepted, rejected (with issues) or a duplicate", "tags": [ "Intake" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/CanonicalOrderInput" } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/IntakeResultDto" } } }, "required": [ "results" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDto" } } } } } } }, "/v1/intake/csv": { "post": { "summary": "Upload a CSV of orders (one row per line; rows sharing order_ref form one order). Columns: order_ref, customer_name, customer_email, phone, address1, address2, city, region, postcode, country, product_code | sku, quantity, delivery_service, artwork_url, cover_url, opt: