{ "openapi": "3.1.0", "info": { "title": "Api", "version": "0.0.1" }, "paths": { "/api/health": { "get": { "tags": [ "health" ], "operationId": "health.health", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "protocolVersion", "schemaVersion", "demo", "config", "engines" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "protocolVersion": { "type": "string" }, "schemaVersion": { "type": "number" }, "demo": { "type": "boolean" }, "config": { "type": "object", "required": [ "name", "currency", "offers" ], "properties": { "name": { "type": "string" }, "currency": { "type": "string" }, "offers": { "type": "number" } }, "additionalProperties": false }, "engines": { "type": "array", "items": { "type": "object", "required": [ "slug", "enabled" ], "properties": { "slug": { "type": "string" }, "enabled": { "type": "boolean" }, "protocolVersion": { "type": "string" }, "reason": { "type": "string" }, "transient": { "type": "boolean" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } } } } }, "/api/offers": { "get": { "tags": [ "catalog" ], "operationId": "catalog.offers", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "protocolVersion", "currency", "offers" ], "properties": { "protocolVersion": { "type": "string" }, "currency": { "type": "string" }, "offers": { "type": "array", "items": { "type": "object", "required": [ "slug", "name", "placement", "technique", "retailPrice", "aspect", "variants" ], "properties": { "slug": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "name": { "type": "string" }, "placement": { "type": "string" }, "technique": { "type": "string" }, "retailPrice": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "$ref": "#/components/schemas/Int", "description": "a non-negative number", "title": "nonNegative", "minimum": 0 }, "currency": { "type": "string", "description": "a string matching the pattern ^[A-Z]{3}$", "pattern": "^[A-Z]{3}$" } }, "additionalProperties": false }, "aspect": { "anyOf": [ { "type": "object", "required": [ "min", "max" ], "properties": { "min": { "type": "number", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "max": { "type": "number", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 } }, "additionalProperties": false }, { "type": "null" } ] }, "variants": { "type": "array", "items": { "type": "object", "required": [ "key", "label", "spec", "specHash" ], "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "size": { "type": "string" }, "imageUrl": { "type": "string" }, "spec": { "type": "object", "required": [ "width", "height", "dpi", "formats", "colorSpace", "alpha", "placement", "technique" ], "properties": { "width": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "height": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "dpi": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "formats": { "type": "array", "items": { "type": "string", "enum": [ "png", "jpeg" ] }, "description": "an array of at least 1 item(s)", "title": "minItems(1)", "minItems": 1 }, "colorSpace": { "type": "string", "enum": [ "srgb" ] }, "alpha": { "type": "string", "enum": [ "required", "allowed", "forbidden" ] }, "placement": { "$ref": "#/components/schemas/NonEmptyString" }, "technique": { "$ref": "#/components/schemas/NonEmptyString" } }, "additionalProperties": false }, "specHash": { "type": "string", "description": "a string matching the pattern ^[0-9a-f]{64}$", "pattern": "^[0-9a-f]{64}$" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "503": { "description": "CatalogUnavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogUnavailable" } } } } } } }, "/api/designs/{engine}/{designId}": { "get": { "tags": [ "designs" ], "operationId": "designs.design", "parameters": [ { "name": "engine", "in": "path", "schema": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "required": true, "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$" }, { "name": "designId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "engine", "design", "offers", "currency", "storefront" ], "properties": { "engine": { "type": "string" }, "design": { "type": "object", "required": [ "id", "sellable", "previewUrl", "aspect" ], "properties": { "id": { "type": "string", "description": "a string matching the pattern ^[A-Za-z0-9_-]{8,128}$", "pattern": "^[A-Za-z0-9_-]{8,128}$" }, "title": { "type": "string" }, "sellable": { "type": "boolean" }, "previewUrl": { "type": "string" }, "aspect": { "type": "object", "required": [ "w", "h" ], "properties": { "w": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "h": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 } }, "additionalProperties": false }, "offers": { "type": "array", "items": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } }, "mockups": { "type": "object", "required": [], "properties": {}, "patternProperties": { "": { "type": "string" } }, "propertyNames": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } }, "engineRef": { "type": "string" } }, "additionalProperties": false }, "offers": { "type": "array", "items": { "type": "object", "required": [ "slug", "name", "placement", "technique", "retailPrice", "aspect", "variants" ], "properties": { "slug": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "name": { "type": "string" }, "placement": { "type": "string" }, "technique": { "type": "string" }, "retailPrice": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "$ref": "#/components/schemas/Int", "description": "a non-negative number", "title": "nonNegative", "minimum": 0 }, "currency": { "type": "string", "description": "a string matching the pattern ^[A-Z]{3}$", "pattern": "^[A-Z]{3}$" } }, "additionalProperties": false }, "aspect": { "anyOf": [ { "type": "object", "required": [ "min", "max" ], "properties": { "min": { "type": "number", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "max": { "type": "number", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 } }, "additionalProperties": false }, { "type": "null" } ] }, "variants": { "type": "array", "items": { "type": "object", "required": [ "key", "label", "spec", "specHash" ], "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "size": { "type": "string" }, "imageUrl": { "type": "string" }, "spec": { "type": "object", "required": [ "width", "height", "dpi", "formats", "colorSpace", "alpha", "placement", "technique" ], "properties": { "width": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "height": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "dpi": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "formats": { "type": "array", "items": { "type": "string", "enum": [ "png", "jpeg" ] }, "description": "an array of at least 1 item(s)", "title": "minItems(1)", "minItems": 1 }, "colorSpace": { "type": "string", "enum": [ "srgb" ] }, "alpha": { "type": "string", "enum": [ "required", "allowed", "forbidden" ] }, "placement": { "$ref": "#/components/schemas/NonEmptyString" }, "technique": { "$ref": "#/components/schemas/NonEmptyString" } }, "additionalProperties": false }, "specHash": { "type": "string", "description": "a string matching the pattern ^[0-9a-f]{64}$", "pattern": "^[0-9a-f]{64}$" } }, "additionalProperties": false } } }, "additionalProperties": false } }, "currency": { "type": "string" }, "storefront": { "type": "object", "required": [ "name", "accent", "accentText", "withdrawalNotice" ], "properties": { "name": { "type": "string" }, "logoUrl": { "type": "string" }, "accent": { "type": "string" }, "accentText": { "type": "string" }, "demo": { "type": "object", "required": [ "testCard" ], "properties": { "testCard": { "type": "string" } }, "additionalProperties": false }, "withdrawalNotice": { "type": "string" }, "termsUrl": { "type": "string" }, "privacyUrl": { "type": "string" }, "contactEmail": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "DesignNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesignNotFound" } } } }, "502": { "description": "EngineError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineError" } } } }, "503": { "description": "EngineUnavailable", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/EngineUnavailable" }, { "$ref": "#/components/schemas/CatalogUnavailable" } ] } } } } } } }, "/api/designs/{engine}/{designId}/printfile": { "post": { "tags": [ "printfiles" ], "operationId": "printfiles.ensure", "parameters": [ { "name": "engine", "in": "path", "schema": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "required": true, "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$" }, { "name": "designId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "printfile" ], "properties": { "status": { "type": "string", "enum": [ "ready" ] }, "printfile": { "type": "object", "required": [ "url", "sha256", "width", "height", "bytes", "contentType", "specHash" ], "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "width": { "$ref": "#/components/schemas/Int" }, "height": { "$ref": "#/components/schemas/Int" }, "bytes": { "$ref": "#/components/schemas/Int" }, "contentType": { "type": "string", "enum": [ "image/png", "image/jpeg" ] }, "specHash": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "retryAfterMs" ], "properties": { "status": { "type": "string", "enum": [ "preparing" ] }, "retryAfterMs": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "DesignNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesignNotFound" } } } }, "422": { "description": "PrintfileUnavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintfileUnavailable" } } } }, "502": { "description": "EngineError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineError" } } } }, "503": { "description": "EngineUnavailable", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/EngineUnavailable" }, { "$ref": "#/components/schemas/CatalogUnavailable" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "offer", "variant" ], "properties": { "offer": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "variant": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } }, "additionalProperties": false } } }, "required": true } }, "get": { "tags": [ "printfiles" ], "operationId": "printfiles.status", "parameters": [ { "name": "engine", "in": "path", "schema": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "required": true, "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$" }, { "name": "designId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "offer", "in": "query", "schema": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "required": true, "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$" }, { "name": "variant", "in": "query", "schema": { "type": "string", "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$", "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "required": true, "description": "a string matching the pattern ^[a-z0-9]+(-[a-z0-9]+)*$" } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "printfile" ], "properties": { "status": { "type": "string", "enum": [ "ready" ] }, "printfile": { "type": "object", "required": [ "url", "sha256", "width", "height", "bytes", "contentType", "specHash" ], "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "width": { "$ref": "#/components/schemas/Int" }, "height": { "$ref": "#/components/schemas/Int" }, "bytes": { "$ref": "#/components/schemas/Int" }, "contentType": { "type": "string", "enum": [ "image/png", "image/jpeg" ] }, "specHash": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "retryAfterMs" ], "properties": { "status": { "type": "string", "enum": [ "preparing" ] }, "retryAfterMs": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "DesignNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesignNotFound" } } } }, "422": { "description": "PrintfileUnavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrintfileUnavailable" } } } }, "502": { "description": "EngineError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineError" } } } }, "503": { "description": "EngineUnavailable", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/EngineUnavailable" }, { "$ref": "#/components/schemas/CatalogUnavailable" } ] } } } } } } }, "/api/quote": { "get": { "tags": [ "quotes" ], "operationId": "quotes.quote", "parameters": [ { "name": "engine", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "designId", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "offer", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "variant", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "country", "in": "query", "schema": { "type": "string", "description": "a string matching the pattern ^[A-Z]{2}$", "pattern": "^[A-Z]{2}$" }, "required": true, "description": "a string matching the pattern ^[A-Z]{2}$" }, { "name": "state", "in": "query", "schema": { "type": "string", "description": "a string matching the pattern ^[A-Z0-9]{1,3}$", "pattern": "^[A-Z0-9]{1,3}$" }, "required": false, "description": "a string matching the pattern ^[A-Z0-9]{1,3}$" } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "engine", "designId", "offer", "variant", "specHash", "country", "currency", "retail", "shipping", "total", "shippingMethod", "createdAt", "expiresAt" ], "properties": { "id": { "type": "string" }, "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "specHash": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "total": { "$ref": "#/components/schemas/Int" }, "shippingMethod": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "minDeliveryDays": { "$ref": "#/components/schemas/Int" }, "maxDeliveryDays": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false }, "createdAt": { "$ref": "#/components/schemas/Int" }, "expiresAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "DesignNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesignNotFound" } } } }, "422": { "description": "QuoteUnavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteUnavailable" } } } }, "502": { "description": "EngineError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineError" } } } }, "503": { "description": "QuoteInconsistent", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/QuoteInconsistent" }, { "$ref": "#/components/schemas/EngineUnavailable" }, { "$ref": "#/components/schemas/CatalogUnavailable" } ] } } } } } } }, "/api/quotes/{id}": { "get": { "tags": [ "quotes" ], "operationId": "quotes.quoteById", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "engine", "designId", "offer", "variant", "specHash", "country", "currency", "retail", "shipping", "total", "shippingMethod", "createdAt", "expiresAt" ], "properties": { "id": { "type": "string" }, "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "specHash": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "total": { "$ref": "#/components/schemas/Int" }, "shippingMethod": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "minDeliveryDays": { "$ref": "#/components/schemas/Int" }, "maxDeliveryDays": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false }, "createdAt": { "$ref": "#/components/schemas/Int" }, "expiresAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "QuoteNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteNotFound" } } } } } } }, "/api/checkout": { "post": { "tags": [ "orders" ], "operationId": "orders.checkout", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "orderId", "url" ], "properties": { "orderId": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "QuoteNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/QuoteNotFound" }, { "$ref": "#/components/schemas/DesignNotFound" } ] } } } }, "422": { "description": "CheckoutUnavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutUnavailable" } } } }, "502": { "description": "PspUnavailable", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PspUnavailable" }, { "$ref": "#/components/schemas/EngineError" } ] } } } }, "503": { "description": "EngineUnavailable", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/EngineUnavailable" }, { "$ref": "#/components/schemas/CatalogUnavailable" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "quoteId" ], "properties": { "quoteId": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/api/orders/{id}": { "get": { "tags": [ "orders" ], "operationId": "orders.publicOrder", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "t", "in": "query", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state", "offer", "variant", "offerName", "variantLabel", "currency", "retail", "shipping", "createdAt", "demo" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "offer": { "type": "string" }, "variant": { "type": "string" }, "offerName": { "type": "string" }, "variantLabel": { "type": "string" }, "previewUrl": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "amountTotal": { "$ref": "#/components/schemas/Int" }, "recipient": { "type": "object", "required": [ "firstName", "city", "country" ], "properties": { "firstName": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" } }, "additionalProperties": false }, "tracking": { "type": "object", "required": [], "properties": { "carrier": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "createdAt": { "$ref": "#/components/schemas/Int" }, "demo": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "OrderNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNotFound" } } } } } } }, "/webhooks/stripe": { "post": { "tags": [ "webhooks" ], "operationId": "webhooks.stripe", "parameters": [ { "name": "stripe-signature", "in": "header", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "received", "outcome" ], "properties": { "received": { "type": "boolean", "enum": [ true ] }, "outcome": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/WebhookRejected" } ] } } } }, "500": { "description": "WebhookProcessingFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookProcessingFailed" } } } } } } }, "/webhooks/printful": { "post": { "tags": [ "webhooks" ], "operationId": "webhooks.printful", "parameters": [ { "name": "x-pf-webhook-signature", "in": "header", "schema": { "type": "string" }, "required": false }, { "name": "x-pf-webhook-public-key", "in": "header", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "received", "outcome" ], "properties": { "received": { "type": "boolean", "enum": [ true ] }, "outcome": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/ProviderWebhookRejected" } ] } } } }, "500": { "description": "ProviderWebhookProcessingFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderWebhookProcessingFailed" } } } } } } }, "/api/operator/session": { "post": { "tags": [ "operator" ], "operationId": "operator.session", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "cookie", "expiresAt" ], "properties": { "cookie": { "type": "string" }, "expiresAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } }, "/api/operator/health": { "get": { "tags": [ "operator" ], "operationId": "operator.health", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "engines", "webhooks", "providers", "config", "secrets", "schema", "counts" ], "properties": { "engines": { "type": "array", "items": { "type": "object", "required": [ "slug", "enabled" ], "properties": { "slug": { "type": "string" }, "enabled": { "type": "boolean" }, "protocolVersion": { "type": "string" }, "reason": { "type": "string" }, "transient": { "type": "boolean" } }, "additionalProperties": false } }, "webhooks": { "type": "object", "required": [ "stripe", "printful" ], "properties": { "stripe": { "type": "object", "required": [ "configured" ], "properties": { "configured": { "type": "boolean" }, "url": { "type": "string" }, "detail": { "type": "string" } }, "additionalProperties": false }, "printful": { "type": "object", "required": [ "configured" ], "properties": { "configured": { "type": "boolean" }, "url": { "type": "string" }, "detail": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "providers": { "type": "object", "required": [ "stripe", "printful" ], "properties": { "stripe": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean" }, "detail": { "type": "string" } }, "additionalProperties": false }, "printful": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean" }, "detail": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "config": { "type": "object", "required": [ "name", "currency", "offers", "demo", "mailer" ], "properties": { "name": { "type": "string" }, "currency": { "type": "string" }, "offers": { "type": "number" }, "demo": { "type": "boolean" }, "mailer": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "required": [ "printful", "stripe", "stripeWebhook", "printfulWebhook", "resend", "sessionSecret", "cron" ], "properties": { "printful": { "type": "boolean" }, "stripe": { "type": "boolean" }, "stripeWebhook": { "type": "boolean" }, "printfulWebhook": { "type": "boolean" }, "resend": { "type": "boolean" }, "sessionSecret": { "type": "boolean" }, "cron": { "type": "boolean" } }, "additionalProperties": false }, "schema": { "type": "object", "required": [ "version", "latest" ], "properties": { "version": { "$ref": "#/components/schemas/Int" }, "latest": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false }, "counts": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/Int" } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } }, "/api/operator/orders": { "get": { "tags": [ "operator" ], "operationId": "operator.orders", "parameters": [ { "name": "state", "in": "query", "schema": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string", "description": "a number between 1 and 200", "title": "between(1, 200)" }, "required": false, "description": "a number between 1 and 200" }, { "name": "before", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "orders" ], "properties": { "orders": { "type": "array", "items": { "type": "object", "required": [ "id", "state", "statusToken", "engine", "designId", "offer", "variant", "specHash", "printfile", "quoteId", "currency", "retail", "shipping", "shippingMethod", "country", "providerCostEstimate", "psp", "providerAttempt", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "statusToken": { "type": "string" }, "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "specHash": { "type": "string" }, "printfile": { "type": "object", "required": [ "url", "sha256", "contentType" ], "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "contentType": { "type": "string" } }, "additionalProperties": false }, "quoteId": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "shippingMethod": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "country": { "type": "string" }, "providerCostEstimate": { "type": "object", "required": [ "product", "shipping", "currency" ], "properties": { "product": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "currency": { "type": "string" } }, "additionalProperties": false }, "psp": { "type": "object", "required": [], "properties": { "sessionId": { "type": "string" }, "sessionExpiresAt": { "$ref": "#/components/schemas/Int" }, "paymentIntentId": { "type": "string" } }, "additionalProperties": false }, "amountTax": { "$ref": "#/components/schemas/Int" }, "amountTotal": { "$ref": "#/components/schemas/Int" }, "recipient": { "type": "object", "required": [ "name", "address1", "city", "country", "email" ], "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "consentAcceptedAt": { "$ref": "#/components/schemas/Int" }, "providerOrderId": { "type": "string" }, "providerAttempt": { "$ref": "#/components/schemas/Int" }, "tracking": { "type": "object", "required": [], "properties": { "carrier": { "type": "string" }, "number": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "publicOrigin": { "type": "string" }, "previewUrl": { "type": "string" }, "purgedAt": { "$ref": "#/components/schemas/Int" }, "createdAt": { "$ref": "#/components/schemas/Int" }, "updatedAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } }, "nextCursor": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } }, "post": { "tags": [ "operator" ], "operationId": "operator.createOrder", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "outcome" ], "properties": { "detail": { "type": "object", "required": [ "order", "transitions", "inboundEvents", "emails", "links" ], "properties": { "order": { "type": "object", "required": [ "id", "state", "statusToken", "engine", "designId", "offer", "variant", "specHash", "printfile", "quoteId", "currency", "retail", "shipping", "shippingMethod", "country", "providerCostEstimate", "psp", "providerAttempt", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "statusToken": { "type": "string" }, "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "specHash": { "type": "string" }, "printfile": { "type": "object", "required": [ "url", "sha256", "contentType" ], "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "contentType": { "type": "string" } }, "additionalProperties": false }, "quoteId": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "shippingMethod": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "country": { "type": "string" }, "providerCostEstimate": { "type": "object", "required": [ "product", "shipping", "currency" ], "properties": { "product": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "currency": { "type": "string" } }, "additionalProperties": false }, "psp": { "type": "object", "required": [], "properties": { "sessionId": { "type": "string" }, "sessionExpiresAt": { "$ref": "#/components/schemas/Int" }, "paymentIntentId": { "type": "string" } }, "additionalProperties": false }, "amountTax": { "$ref": "#/components/schemas/Int" }, "amountTotal": { "$ref": "#/components/schemas/Int" }, "recipient": { "type": "object", "required": [ "name", "address1", "city", "country", "email" ], "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "consentAcceptedAt": { "$ref": "#/components/schemas/Int" }, "providerOrderId": { "type": "string" }, "providerAttempt": { "$ref": "#/components/schemas/Int" }, "tracking": { "type": "object", "required": [], "properties": { "carrier": { "type": "string" }, "number": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "publicOrigin": { "type": "string" }, "previewUrl": { "type": "string" }, "purgedAt": { "$ref": "#/components/schemas/Int" }, "createdAt": { "$ref": "#/components/schemas/Int" }, "updatedAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false }, "transitions": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "from", "to", "cause", "at" ], "properties": { "id": { "$ref": "#/components/schemas/Int" }, "orderId": { "type": "string" }, "from": { "anyOf": [ { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, { "type": "null" } ] }, "to": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "cause": { "type": "string", "enum": [ "storefront", "stripe_webhook", "printful_webhook", "cli", "reconciliation" ] }, "causeRef": { "type": "string" }, "note": { "type": "string" }, "at": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } }, "inboundEvents": { "type": "array", "items": { "type": "object", "required": [ "provider", "eventId", "eventType", "receivedAt" ], "properties": { "provider": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "receivedAt": { "$ref": "#/components/schemas/Int" }, "processedAt": { "$ref": "#/components/schemas/Int" }, "outcome": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false } }, "emails": { "type": "array", "items": { "type": "object", "required": [ "orderId", "kind", "attempts" ], "properties": { "orderId": { "type": "string" }, "kind": { "type": "string", "enum": [ "confirmation", "shipped" ] }, "sentAt": { "$ref": "#/components/schemas/Int" }, "providerMessageId": { "type": "string" }, "attempts": { "$ref": "#/components/schemas/Int" }, "lastError": { "type": "string" } }, "additionalProperties": false } }, "links": { "type": "object", "required": [], "properties": { "stripePayment": { "type": "string" }, "stripeSession": { "type": "string" }, "printfulOrder": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "outcome": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "OrderNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNotFound" } } } }, "422": { "description": "ActionRefused", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRefused" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "engine", "designId", "offer", "variant", "recipient", "paidOutside" ], "properties": { "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "recipient": { "type": "object", "required": [ "name", "address1", "city", "country", "email" ], "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "paidOutside": { "type": "boolean", "enum": [ true ] }, "email": { "type": "boolean" } }, "additionalProperties": false } } }, "required": true } } }, "/api/operator/orders/{id}": { "get": { "tags": [ "operator" ], "operationId": "operator.order", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "order", "transitions", "inboundEvents", "emails", "links" ], "properties": { "order": { "type": "object", "required": [ "id", "state", "statusToken", "engine", "designId", "offer", "variant", "specHash", "printfile", "quoteId", "currency", "retail", "shipping", "shippingMethod", "country", "providerCostEstimate", "psp", "providerAttempt", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "statusToken": { "type": "string" }, "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "specHash": { "type": "string" }, "printfile": { "type": "object", "required": [ "url", "sha256", "contentType" ], "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "contentType": { "type": "string" } }, "additionalProperties": false }, "quoteId": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "shippingMethod": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "country": { "type": "string" }, "providerCostEstimate": { "type": "object", "required": [ "product", "shipping", "currency" ], "properties": { "product": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "currency": { "type": "string" } }, "additionalProperties": false }, "psp": { "type": "object", "required": [], "properties": { "sessionId": { "type": "string" }, "sessionExpiresAt": { "$ref": "#/components/schemas/Int" }, "paymentIntentId": { "type": "string" } }, "additionalProperties": false }, "amountTax": { "$ref": "#/components/schemas/Int" }, "amountTotal": { "$ref": "#/components/schemas/Int" }, "recipient": { "type": "object", "required": [ "name", "address1", "city", "country", "email" ], "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "consentAcceptedAt": { "$ref": "#/components/schemas/Int" }, "providerOrderId": { "type": "string" }, "providerAttempt": { "$ref": "#/components/schemas/Int" }, "tracking": { "type": "object", "required": [], "properties": { "carrier": { "type": "string" }, "number": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "publicOrigin": { "type": "string" }, "previewUrl": { "type": "string" }, "purgedAt": { "$ref": "#/components/schemas/Int" }, "createdAt": { "$ref": "#/components/schemas/Int" }, "updatedAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false }, "transitions": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "from", "to", "cause", "at" ], "properties": { "id": { "$ref": "#/components/schemas/Int" }, "orderId": { "type": "string" }, "from": { "anyOf": [ { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, { "type": "null" } ] }, "to": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "cause": { "type": "string", "enum": [ "storefront", "stripe_webhook", "printful_webhook", "cli", "reconciliation" ] }, "causeRef": { "type": "string" }, "note": { "type": "string" }, "at": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } }, "inboundEvents": { "type": "array", "items": { "type": "object", "required": [ "provider", "eventId", "eventType", "receivedAt" ], "properties": { "provider": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "receivedAt": { "$ref": "#/components/schemas/Int" }, "processedAt": { "$ref": "#/components/schemas/Int" }, "outcome": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false } }, "emails": { "type": "array", "items": { "type": "object", "required": [ "orderId", "kind", "attempts" ], "properties": { "orderId": { "type": "string" }, "kind": { "type": "string", "enum": [ "confirmation", "shipped" ] }, "sentAt": { "$ref": "#/components/schemas/Int" }, "providerMessageId": { "type": "string" }, "attempts": { "$ref": "#/components/schemas/Int" }, "lastError": { "type": "string" } }, "additionalProperties": false } }, "links": { "type": "object", "required": [], "properties": { "stripePayment": { "type": "string" }, "stripeSession": { "type": "string" }, "printfulOrder": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "OrderNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNotFound" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } }, "/api/operator/orders/purge": { "post": { "tags": [ "operator" ], "operationId": "operator.purgeOrders", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "purged" ], "properties": { "purged": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "olderThanDays" ], "properties": { "olderThanDays": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 } }, "additionalProperties": false } } }, "required": true } } }, "/api/operator/orders/{id}/resubmit": { "post": { "tags": [ "operator" ], "operationId": "operator.resubmitOrder", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "outcome" ], "properties": { "detail": { "type": "object", "required": [ "order", "transitions", "inboundEvents", "emails", "links" ], "properties": { "order": { "type": "object", "required": [ "id", "state", "statusToken", "engine", "designId", "offer", "variant", "specHash", "printfile", "quoteId", "currency", "retail", "shipping", "shippingMethod", "country", "providerCostEstimate", "psp", "providerAttempt", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "statusToken": { "type": "string" }, "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "specHash": { "type": "string" }, "printfile": { "type": "object", "required": [ "url", "sha256", "contentType" ], "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "contentType": { "type": "string" } }, "additionalProperties": false }, "quoteId": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "shippingMethod": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "country": { "type": "string" }, "providerCostEstimate": { "type": "object", "required": [ "product", "shipping", "currency" ], "properties": { "product": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "currency": { "type": "string" } }, "additionalProperties": false }, "psp": { "type": "object", "required": [], "properties": { "sessionId": { "type": "string" }, "sessionExpiresAt": { "$ref": "#/components/schemas/Int" }, "paymentIntentId": { "type": "string" } }, "additionalProperties": false }, "amountTax": { "$ref": "#/components/schemas/Int" }, "amountTotal": { "$ref": "#/components/schemas/Int" }, "recipient": { "type": "object", "required": [ "name", "address1", "city", "country", "email" ], "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "consentAcceptedAt": { "$ref": "#/components/schemas/Int" }, "providerOrderId": { "type": "string" }, "providerAttempt": { "$ref": "#/components/schemas/Int" }, "tracking": { "type": "object", "required": [], "properties": { "carrier": { "type": "string" }, "number": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "publicOrigin": { "type": "string" }, "previewUrl": { "type": "string" }, "purgedAt": { "$ref": "#/components/schemas/Int" }, "createdAt": { "$ref": "#/components/schemas/Int" }, "updatedAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false }, "transitions": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "from", "to", "cause", "at" ], "properties": { "id": { "$ref": "#/components/schemas/Int" }, "orderId": { "type": "string" }, "from": { "anyOf": [ { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, { "type": "null" } ] }, "to": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "cause": { "type": "string", "enum": [ "storefront", "stripe_webhook", "printful_webhook", "cli", "reconciliation" ] }, "causeRef": { "type": "string" }, "note": { "type": "string" }, "at": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } }, "inboundEvents": { "type": "array", "items": { "type": "object", "required": [ "provider", "eventId", "eventType", "receivedAt" ], "properties": { "provider": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "receivedAt": { "$ref": "#/components/schemas/Int" }, "processedAt": { "$ref": "#/components/schemas/Int" }, "outcome": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false } }, "emails": { "type": "array", "items": { "type": "object", "required": [ "orderId", "kind", "attempts" ], "properties": { "orderId": { "type": "string" }, "kind": { "type": "string", "enum": [ "confirmation", "shipped" ] }, "sentAt": { "$ref": "#/components/schemas/Int" }, "providerMessageId": { "type": "string" }, "attempts": { "$ref": "#/components/schemas/Int" }, "lastError": { "type": "string" } }, "additionalProperties": false } }, "links": { "type": "object", "required": [], "properties": { "stripePayment": { "type": "string" }, "stripeSession": { "type": "string" }, "printfulOrder": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "outcome": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "OrderNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNotFound" } } } }, "422": { "description": "ActionRefused", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRefused" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } }, "/api/operator/orders/{id}/address": { "post": { "tags": [ "operator" ], "operationId": "operator.fixOrderAddress", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "outcome" ], "properties": { "detail": { "type": "object", "required": [ "order", "transitions", "inboundEvents", "emails", "links" ], "properties": { "order": { "type": "object", "required": [ "id", "state", "statusToken", "engine", "designId", "offer", "variant", "specHash", "printfile", "quoteId", "currency", "retail", "shipping", "shippingMethod", "country", "providerCostEstimate", "psp", "providerAttempt", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "statusToken": { "type": "string" }, "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "specHash": { "type": "string" }, "printfile": { "type": "object", "required": [ "url", "sha256", "contentType" ], "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "contentType": { "type": "string" } }, "additionalProperties": false }, "quoteId": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "shippingMethod": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "country": { "type": "string" }, "providerCostEstimate": { "type": "object", "required": [ "product", "shipping", "currency" ], "properties": { "product": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "currency": { "type": "string" } }, "additionalProperties": false }, "psp": { "type": "object", "required": [], "properties": { "sessionId": { "type": "string" }, "sessionExpiresAt": { "$ref": "#/components/schemas/Int" }, "paymentIntentId": { "type": "string" } }, "additionalProperties": false }, "amountTax": { "$ref": "#/components/schemas/Int" }, "amountTotal": { "$ref": "#/components/schemas/Int" }, "recipient": { "type": "object", "required": [ "name", "address1", "city", "country", "email" ], "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "consentAcceptedAt": { "$ref": "#/components/schemas/Int" }, "providerOrderId": { "type": "string" }, "providerAttempt": { "$ref": "#/components/schemas/Int" }, "tracking": { "type": "object", "required": [], "properties": { "carrier": { "type": "string" }, "number": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "publicOrigin": { "type": "string" }, "previewUrl": { "type": "string" }, "purgedAt": { "$ref": "#/components/schemas/Int" }, "createdAt": { "$ref": "#/components/schemas/Int" }, "updatedAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false }, "transitions": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "from", "to", "cause", "at" ], "properties": { "id": { "$ref": "#/components/schemas/Int" }, "orderId": { "type": "string" }, "from": { "anyOf": [ { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, { "type": "null" } ] }, "to": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "cause": { "type": "string", "enum": [ "storefront", "stripe_webhook", "printful_webhook", "cli", "reconciliation" ] }, "causeRef": { "type": "string" }, "note": { "type": "string" }, "at": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } }, "inboundEvents": { "type": "array", "items": { "type": "object", "required": [ "provider", "eventId", "eventType", "receivedAt" ], "properties": { "provider": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "receivedAt": { "$ref": "#/components/schemas/Int" }, "processedAt": { "$ref": "#/components/schemas/Int" }, "outcome": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false } }, "emails": { "type": "array", "items": { "type": "object", "required": [ "orderId", "kind", "attempts" ], "properties": { "orderId": { "type": "string" }, "kind": { "type": "string", "enum": [ "confirmation", "shipped" ] }, "sentAt": { "$ref": "#/components/schemas/Int" }, "providerMessageId": { "type": "string" }, "attempts": { "$ref": "#/components/schemas/Int" }, "lastError": { "type": "string" } }, "additionalProperties": false } }, "links": { "type": "object", "required": [], "properties": { "stripePayment": { "type": "string" }, "stripeSession": { "type": "string" }, "printfulOrder": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "outcome": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "OrderNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNotFound" } } } }, "422": { "description": "ActionRefused", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRefused" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "object", "required": [ "name", "address1", "city", "country", "email" ], "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "required": true } } }, "/api/operator/orders/{id}/cancel": { "post": { "tags": [ "operator" ], "operationId": "operator.cancelOrder", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "detail", "outcome" ], "properties": { "detail": { "type": "object", "required": [ "order", "transitions", "inboundEvents", "emails", "links" ], "properties": { "order": { "type": "object", "required": [ "id", "state", "statusToken", "engine", "designId", "offer", "variant", "specHash", "printfile", "quoteId", "currency", "retail", "shipping", "shippingMethod", "country", "providerCostEstimate", "psp", "providerAttempt", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string" }, "state": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "statusToken": { "type": "string" }, "engine": { "type": "string" }, "designId": { "type": "string" }, "offer": { "type": "string" }, "variant": { "type": "string" }, "specHash": { "type": "string" }, "printfile": { "type": "object", "required": [ "url", "sha256", "contentType" ], "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "contentType": { "type": "string" } }, "additionalProperties": false }, "quoteId": { "type": "string" }, "currency": { "type": "string" }, "retail": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "shippingMethod": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "country": { "type": "string" }, "providerCostEstimate": { "type": "object", "required": [ "product", "shipping", "currency" ], "properties": { "product": { "$ref": "#/components/schemas/Int" }, "shipping": { "$ref": "#/components/schemas/Int" }, "currency": { "type": "string" } }, "additionalProperties": false }, "psp": { "type": "object", "required": [], "properties": { "sessionId": { "type": "string" }, "sessionExpiresAt": { "$ref": "#/components/schemas/Int" }, "paymentIntentId": { "type": "string" } }, "additionalProperties": false }, "amountTax": { "$ref": "#/components/schemas/Int" }, "amountTotal": { "$ref": "#/components/schemas/Int" }, "recipient": { "type": "object", "required": [ "name", "address1", "city", "country", "email" ], "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "consentAcceptedAt": { "$ref": "#/components/schemas/Int" }, "providerOrderId": { "type": "string" }, "providerAttempt": { "$ref": "#/components/schemas/Int" }, "tracking": { "type": "object", "required": [], "properties": { "carrier": { "type": "string" }, "number": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "publicOrigin": { "type": "string" }, "previewUrl": { "type": "string" }, "purgedAt": { "$ref": "#/components/schemas/Int" }, "createdAt": { "$ref": "#/components/schemas/Int" }, "updatedAt": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false }, "transitions": { "type": "array", "items": { "type": "object", "required": [ "id", "orderId", "from", "to", "cause", "at" ], "properties": { "id": { "$ref": "#/components/schemas/Int" }, "orderId": { "type": "string" }, "from": { "anyOf": [ { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, { "type": "null" } ] }, "to": { "type": "string", "enum": [ "checkout_open", "expired", "paid", "submit_failed", "submitted", "on_hold", "in_production", "shipped", "fulfilled", "canceled", "refunded" ] }, "cause": { "type": "string", "enum": [ "storefront", "stripe_webhook", "printful_webhook", "cli", "reconciliation" ] }, "causeRef": { "type": "string" }, "note": { "type": "string" }, "at": { "$ref": "#/components/schemas/Int" } }, "additionalProperties": false } }, "inboundEvents": { "type": "array", "items": { "type": "object", "required": [ "provider", "eventId", "eventType", "receivedAt" ], "properties": { "provider": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "receivedAt": { "$ref": "#/components/schemas/Int" }, "processedAt": { "$ref": "#/components/schemas/Int" }, "outcome": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false } }, "emails": { "type": "array", "items": { "type": "object", "required": [ "orderId", "kind", "attempts" ], "properties": { "orderId": { "type": "string" }, "kind": { "type": "string", "enum": [ "confirmation", "shipped" ] }, "sentAt": { "$ref": "#/components/schemas/Int" }, "providerMessageId": { "type": "string" }, "attempts": { "$ref": "#/components/schemas/Int" }, "lastError": { "type": "string" } }, "additionalProperties": false } }, "links": { "type": "object", "required": [], "properties": { "stripePayment": { "type": "string" }, "stripeSession": { "type": "string" }, "printfulOrder": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "outcome": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "404": { "description": "OrderNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNotFound" } } } }, "422": { "description": "ActionRefused", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRefused" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } }, "/api/operator/reconcile": { "post": { "tags": [ "operator" ], "operationId": "operator.reconcile", "parameters": [ { "name": "dryRun", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "startedAt", "finishedAt", "trigger", "dryRun", "steps", "alarms" ], "properties": { "startedAt": { "$ref": "#/components/schemas/Int" }, "finishedAt": { "$ref": "#/components/schemas/Int" }, "trigger": { "type": "string", "enum": [ "operator", "cron" ] }, "dryRun": { "type": "boolean" }, "steps": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "type": "object", "required": [ "checked", "repaired", "notes" ], "properties": { "checked": { "$ref": "#/components/schemas/Int" }, "repaired": { "$ref": "#/components/schemas/Int" }, "notes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "alarms": { "type": "array", "items": { "type": "object", "required": [ "kind", "message" ], "properties": { "kind": { "type": "string", "enum": [ "stuck_paid", "submit_failed", "on_hold", "refund", "dispute", "engine_disabled", "catalog", "email", "provider_status" ] }, "orderId": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } }, "/api/operator/catalog/search": { "get": { "tags": [ "operator" ], "operationId": "operator.catalogSearch", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "products" ], "properties": { "products": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "placements", "variants" ], "properties": { "id": { "$ref": "#/components/schemas/Int" }, "name": { "type": "string" }, "placements": { "type": "array", "items": { "type": "object", "required": [ "placement", "technique", "spec" ], "properties": { "placement": { "type": "string" }, "technique": { "type": "string" }, "spec": { "anyOf": [ { "type": "object", "required": [ "width", "height", "dpi", "formats", "colorSpace", "alpha", "placement", "technique" ], "properties": { "width": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "height": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "dpi": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "formats": { "type": "array", "items": { "type": "string", "enum": [ "png", "jpeg" ] }, "description": "an array of at least 1 item(s)", "title": "minItems(1)", "minItems": 1 }, "colorSpace": { "type": "string", "enum": [ "srgb" ] }, "alpha": { "type": "string", "enum": [ "required", "allowed", "forbidden" ] }, "placement": { "$ref": "#/components/schemas/NonEmptyString" }, "technique": { "$ref": "#/components/schemas/NonEmptyString" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "variants": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "$ref": "#/components/schemas/Int" }, "name": { "type": "string" }, "color": { "type": "string" }, "size": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "502": { "description": "CatalogUnavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogUnavailable" } } } } } } }, "/api/operator/catalog/check": { "get": { "tags": [ "operator" ], "operationId": "operator.catalogCheck", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "offers" ], "properties": { "offers": { "type": "array", "items": { "type": "object", "required": [ "slug", "ok", "variants" ], "properties": { "slug": { "type": "string" }, "ok": { "type": "boolean" }, "variants": { "$ref": "#/components/schemas/Int" }, "message": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } }, "/api/operator/webhooks/register": { "post": { "tags": [ "operator" ], "operationId": "operator.webhooksRegister", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "stripe", "printful" ], "properties": { "stripe": { "anyOf": [ { "type": "object", "required": [ "status", "url" ], "properties": { "status": { "type": "string", "enum": [ "created", "verified" ] }, "url": { "type": "string" }, "secret": { "type": "string" }, "publicKey": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "status", "url", "message" ], "properties": { "status": { "type": "string", "enum": [ "failed" ] }, "url": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } ] }, "printful": { "anyOf": [ { "type": "object", "required": [ "status", "url" ], "properties": { "status": { "type": "string", "enum": [ "created", "verified" ] }, "url": { "type": "string" }, "secret": { "type": "string" }, "publicKey": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "status", "url", "message" ], "properties": { "status": { "type": "string", "enum": [ "failed" ] }, "url": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "422": { "description": "ToolError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "publicUrl": { "type": "string", "description": "a string matching the pattern ^https:\\/\\/", "pattern": "^https:\\/\\/" } }, "additionalProperties": false } } }, "required": true } } }, "/api/operator/printfile/check": { "post": { "tags": [ "operator" ], "operationId": "operator.printfileCheck", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "spec", "specHash", "file", "ok", "problems" ], "properties": { "spec": { "type": "object", "required": [ "width", "height", "dpi", "formats", "colorSpace", "alpha", "placement", "technique" ], "properties": { "width": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "height": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "dpi": { "$ref": "#/components/schemas/Int", "description": "a positive number", "title": "positive", "exclusiveMinimum": 0 }, "formats": { "type": "array", "items": { "type": "string", "enum": [ "png", "jpeg" ] }, "description": "an array of at least 1 item(s)", "title": "minItems(1)", "minItems": 1 }, "colorSpace": { "type": "string", "enum": [ "srgb" ] }, "alpha": { "type": "string", "enum": [ "required", "allowed", "forbidden" ] }, "placement": { "$ref": "#/components/schemas/NonEmptyString" }, "technique": { "$ref": "#/components/schemas/NonEmptyString" } }, "additionalProperties": false }, "specHash": { "type": "string" }, "file": { "type": "object", "required": [ "status", "contentType" ], "properties": { "status": { "$ref": "#/components/schemas/Int" }, "contentType": { "type": "string" }, "bytes": { "$ref": "#/components/schemas/Int" }, "header": { "type": "object", "required": [ "format", "width", "height", "hasAlpha" ], "properties": { "format": { "type": "string", "enum": [ "png", "jpeg" ] }, "width": { "$ref": "#/components/schemas/Int" }, "height": { "$ref": "#/components/schemas/Int" }, "hasAlpha": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, "ok": { "type": "boolean" }, "problems": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "422": { "description": "ToolError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "offer", "variant" ], "properties": { "url": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/", "pattern": "^https?:\\/\\/" }, "offer": { "type": "string" }, "variant": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/api/operator/reconciliation/latest": { "get": { "tags": [ "operator" ], "operationId": "operator.reconciliation", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "startedAt", "finishedAt", "trigger", "dryRun", "steps", "alarms" ], "properties": { "startedAt": { "$ref": "#/components/schemas/Int" }, "finishedAt": { "$ref": "#/components/schemas/Int" }, "trigger": { "type": "string", "enum": [ "operator", "cron" ] }, "dryRun": { "type": "boolean" }, "steps": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "type": "object", "required": [ "checked", "repaired", "notes" ], "properties": { "checked": { "$ref": "#/components/schemas/Int" }, "repaired": { "$ref": "#/components/schemas/Int" }, "notes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "alarms": { "type": "array", "items": { "type": "object", "required": [ "kind", "message" ], "properties": { "kind": { "type": "string", "enum": [ "stuck_paid", "submit_failed", "on_hold", "refund", "dispute", "engine_disabled", "catalog", "email", "provider_status" ] }, "orderId": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "500": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } }, "/api/cron/reconcile": { "get": { "tags": [ "cron" ], "operationId": "cron.reconcile", "parameters": [ { "name": "authorization", "in": "header", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "startedAt", "finishedAt", "trigger", "dryRun", "steps", "alarms" ], "properties": { "startedAt": { "$ref": "#/components/schemas/Int" }, "finishedAt": { "$ref": "#/components/schemas/Int" }, "trigger": { "type": "string", "enum": [ "operator", "cron" ] }, "dryRun": { "type": "boolean" }, "steps": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "type": "object", "required": [ "checked", "repaired", "notes" ], "properties": { "checked": { "$ref": "#/components/schemas/Int" }, "repaired": { "$ref": "#/components/schemas/Int" }, "notes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "alarms": { "type": "array", "items": { "type": "object", "required": [ "kind", "message" ], "properties": { "kind": { "type": "string", "enum": [ "stuck_paid", "submit_failed", "on_hold", "refund", "dispute", "engine_disabled", "catalog", "email", "provider_status" ] }, "orderId": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiDecodeError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } } } } } }, "components": { "schemas": { "HttpApiDecodeError": { "type": "object", "required": [ "issues", "message", "_tag" ], "properties": { "issues": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "HttpApiDecodeError" ] } }, "additionalProperties": false, "description": "The request did not match the expected schema" }, "Issue": { "type": "object", "required": [ "_tag", "path", "message" ], "properties": { "_tag": { "type": "string", "enum": [ "Pointer", "Unexpected", "Missing", "Composite", "Refinement", "Transformation", "Type", "Forbidden" ], "description": "The tag identifying the type of parse issue" }, "path": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyKey" }, "description": "The path to the property where the issue occurred" }, "message": { "type": "string", "description": "A descriptive message explaining the issue" } }, "additionalProperties": false, "description": "Represents an error encountered while parsing a value to match the schema" }, "PropertyKey": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "required": [ "_tag", "key" ], "properties": { "_tag": { "type": "string", "enum": [ "symbol" ] }, "key": { "type": "string" } }, "additionalProperties": false, "description": "an object to be decoded into a globally shared symbol" } ] }, "Int": { "type": "integer", "description": "an integer", "title": "int" }, "NonEmptyString": { "type": "string", "description": "a non empty string", "title": "nonEmptyString", "minLength": 1 }, "CatalogUnavailable": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "offer": { "type": "string" }, "_tag": { "type": "string", "enum": [ "CatalogUnavailable" ] } }, "additionalProperties": false }, "DesignNotFound": { "type": "object", "required": [ "designId", "_tag" ], "properties": { "designId": { "type": "string" }, "_tag": { "type": "string", "enum": [ "DesignNotFound" ] } }, "additionalProperties": false }, "EngineUnavailable": { "type": "object", "required": [ "engine", "reason", "_tag" ], "properties": { "engine": { "type": "string" }, "reason": { "type": "string" }, "_tag": { "type": "string", "enum": [ "EngineUnavailable" ] } }, "additionalProperties": false }, "EngineError": { "type": "object", "required": [ "engine", "message", "_tag" ], "properties": { "engine": { "type": "string" }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "EngineError" ] } }, "additionalProperties": false }, "PrintfileUnavailable": { "type": "object", "required": [ "reason", "message", "_tag" ], "properties": { "reason": { "type": "string", "enum": [ "not_sellable", "not_eligible", "rejected", "invalid" ] }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "PrintfileUnavailable" ] } }, "additionalProperties": false }, "QuoteUnavailable": { "type": "object", "required": [ "reason", "message", "_tag" ], "properties": { "reason": { "type": "string", "enum": [ "not_sellable", "not_eligible", "state_required", "no_shipping" ] }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "QuoteUnavailable" ] } }, "additionalProperties": false }, "QuoteInconsistent": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "QuoteInconsistent" ] } }, "additionalProperties": false }, "QuoteNotFound": { "type": "object", "required": [ "id", "_tag" ], "properties": { "id": { "type": "string" }, "_tag": { "type": "string", "enum": [ "QuoteNotFound" ] } }, "additionalProperties": false }, "CheckoutUnavailable": { "type": "object", "required": [ "reason", "message", "_tag" ], "properties": { "reason": { "type": "string", "enum": [ "quote_expired", "printfile_missing", "not_sellable" ] }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "CheckoutUnavailable" ] } }, "additionalProperties": false }, "PspUnavailable": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "PspUnavailable" ] } }, "additionalProperties": false }, "OrderNotFound": { "type": "object", "required": [ "id", "_tag" ], "properties": { "id": { "type": "string" }, "_tag": { "type": "string", "enum": [ "OrderNotFound" ] } }, "additionalProperties": false }, "WebhookRejected": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "WebhookRejected" ] } }, "additionalProperties": false }, "WebhookProcessingFailed": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "WebhookProcessingFailed" ] } }, "additionalProperties": false }, "ProviderWebhookRejected": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "ProviderWebhookRejected" ] } }, "additionalProperties": false }, "ProviderWebhookProcessingFailed": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "ProviderWebhookProcessingFailed" ] } }, "additionalProperties": false }, "Unauthorized": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Unauthorized" ] } }, "additionalProperties": false }, "ActionRefused": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "ActionRefused" ] } }, "additionalProperties": false }, "ToolError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "ToolError" ] } }, "additionalProperties": false } }, "securitySchemes": {} }, "security": [], "tags": [ { "name": "health" }, { "name": "catalog" }, { "name": "designs" }, { "name": "printfiles" }, { "name": "quotes" }, { "name": "orders" }, { "name": "webhooks" }, { "name": "operator" }, { "name": "cron" } ] }