{ "openapi": "3.0.3", "info": { "title": "VapeTax API — catalogue, operations and isolated warehouse pilot", "version": "1.2.0", "description": "Scoped server-to-server API. Read account catalogue, stock, production, purchases, contacts, stamps, inventory and VPD through explicitly listed routes. Operational writes, transfers and allocation require an enabled isolated SIMULATION/SANDBOX pilot. Catalogue import remains separately available. Existing source, lifecycle, reconciliation, ledger and owner-approval protections apply. LIVE release acceptance and provider transmission remain hard-disabled. Local release, mandatory automatic VPD accounting and SICPA outcome are separate. Machine keys never grant OWNER, billing, passwords, team management, provider credentials, arbitrary provider retry or database/backup access. See https://vapetax.co.uk/docs for workflows, status interpretation and recovery. All authenticated responses are no-store; use HTTPS except isolated loopback testing." }, "servers": [ { "url": "http://localhost:4000", "description": "Isolated local development; replace with your verified deployed API origin." }, { "url": "https://api.vapetax.co.uk", "description": "Production origin; feature availability must be verified and approved before use." } ], "tags": [ { "name": "Product API", "description": "Server-to-server scoped product catalogue operations." }, { "name": "Owner management", "description": "Browser JWT management by the UK account owner; no integration key grants these rights." }, { "name": "Warehouse pilot API", "description": "Verified inventory, atomic release/VPD accounting and independent provider status in explicitly enabled isolated test environments." }, { "name": "Contacts operations", "description": "Account-scoped domain data. Writes require an explicitly enabled isolated pilot and preserve domain lifecycle and retained-evidence guards." }, { "name": "Products operations", "description": "Account-scoped domain data. Writes require an explicitly enabled isolated pilot and preserve domain lifecycle and retained-evidence guards." }, { "name": "Production operations", "description": "Account-scoped domain data. Writes require an explicitly enabled isolated pilot and preserve domain lifecycle and retained-evidence guards." }, { "name": "Purchases operations", "description": "Account-scoped domain data. Writes require an explicitly enabled isolated pilot and preserve domain lifecycle and retained-evidence guards." }, { "name": "Stock operations", "description": "Account-scoped domain data. Writes require an explicitly enabled isolated pilot and preserve domain lifecycle and retained-evidence guards." }, { "name": "Stamps operations", "description": "Account-scoped domain data. Writes require an explicitly enabled isolated pilot and preserve domain lifecycle and retained-evidence guards." }, { "name": "Vpd operations", "description": "Account-scoped domain data. Writes require an explicitly enabled isolated pilot and preserve domain lifecycle and retained-evidence guards." }, { "name": "Warehouse operations", "description": "Exact approved units, local warehouse movements and order reservations. Isolated pilot only; no automatic provider transmission." }, { "name": "OWNER operations", "description": "Account-scoped domain data. Writes require an explicitly enabled isolated pilot and preserve domain lifecycle and retained-evidence guards." } ], "paths": { "/developer": { "get": { "tags": [ "Owner management" ], "operationId": "getDeveloper", "summary": "Review integrations and server readiness", "description": "UK account OWNER only. Read remains available when Developer API access is disabled. Admin impersonation is read-only; platform ADMIN alone is not the owner.", "security": [ { "OwnerSession": [] } ], "responses": { "200": { "description": "Owner Developer view; no raw API secrets or digests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Developer" } } } }, "401": { "description": "INVALID_API_KEY for missing, invalid, expired or revoked integration credentials; human routes require browser JWT authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "SCOPE_REQUIRED, ACCOUNT_DISABLED or ENVIRONMENT_DISABLED; human management requires the UK account owner and mutations reject admin access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/integrations": { "post": { "tags": [ "Owner management" ], "operationId": "createIntegration", "summary": "Create a named integration", "security": [ { "OwnerSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIntegration" } } } }, "responses": { "201": { "description": "Integration created in the server environment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Integration" } } } }, "400": { "description": "Invalid request or idempotency header; unknown fields, invalid barcode hierarchy or invalid cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "INVALID_API_KEY for missing, invalid, expired or revoked integration credentials; human routes require browser JWT authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "SCOPE_REQUIRED, ACCOUNT_DISABLED or ENVIRONMENT_DISABLED; human management requires the UK account owner and mutations reject admin access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT for changed content using an accepted key, or a catalogue/mapping/key-limit conflict. Review; do not retry with a new key to bypass the conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Developer management JSON exceeds 1 MiB.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON_REQUIRED. Send a JSON body with Content-Type: application/json.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/integrations/{id}/keys": { "post": { "tags": [ "Owner management" ], "operationId": "createIntegrationKey", "summary": "Create or rotate a scoped key", "description": "At most two unrevoked, unexpired keys per integration. Choose a replacement before revoking the old one. Expiry defaults to 90 days. Raw secret is returned once and cannot be retrieved later.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 128, "minLength": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKey" } } } }, "responses": { "201": { "description": "One-time key secret; prevent caching and store securely.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedKey" } } } }, "400": { "description": "Invalid request or idempotency header; unknown fields, invalid barcode hierarchy or invalid cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "INVALID_API_KEY for missing, invalid, expired or revoked integration credentials; human routes require browser JWT authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "SCOPE_REQUIRED, ACCOUNT_DISABLED or ENVIRONMENT_DISABLED; human management requires the UK account owner and mutations reject admin access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource is unavailable in the authenticated account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT for changed content using an accepted key, or a catalogue/mapping/key-limit conflict. Review; do not retry with a new key to bypass the conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Developer management JSON exceeds 1 MiB.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON_REQUIRED. Send a JSON body with Content-Type: application/json.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/integrations/{id}/disable": { "post": { "tags": [ "Owner management" ], "operationId": "disableIntegration", "summary": "Disable new requests from this integration", "description": "Keeps imported catalogue data and request history. No hard-delete operation.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 128, "minLength": 1 } } ], "responses": { "200": { "description": "Integration disabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "401": { "description": "INVALID_API_KEY for missing, invalid, expired or revoked integration credentials; human routes require browser JWT authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "SCOPE_REQUIRED, ACCOUNT_DISABLED or ENVIRONMENT_DISABLED; human management requires the UK account owner and mutations reject admin access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource is unavailable in the authenticated account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Developer management JSON exceeds 1 MiB.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON_REQUIRED. Send a JSON body with Content-Type: application/json.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/keys/{id}": { "delete": { "tags": [ "Owner management" ], "operationId": "revokeIntegrationKey", "summary": "Revoke one key immediately", "security": [ { "OwnerSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "maxLength": 128, "minLength": 1 } } ], "responses": { "200": { "description": "Key revoked; metadata/history retained.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ok" } } } }, "401": { "description": "INVALID_API_KEY for missing, invalid, expired or revoked integration credentials; human routes require browser JWT authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "SCOPE_REQUIRED, ACCOUNT_DISABLED or ENVIRONMENT_DISABLED; human management requires the UK account owner and mutations reject admin access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource is unavailable in the authenticated account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/capabilities": { "get": { "tags": [ "Product API" ], "operationId": "getCapabilities", "summary": "Read supported operations and limits", "description": "Any valid integration key. Operations contains the effective scopes granted to this key. No release capability is enabled.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "authenticated", "responses": { "200": { "description": "Published capabilities; no live SICPA readiness is implied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Capabilities" } } } }, "401": { "description": "INVALID_API_KEY for missing, invalid, expired or revoked integration credentials; human routes require browser JWT authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "SCOPE_REQUIRED, ACCOUNT_DISABLED or ENVIRONMENT_DISABLED; human management requires the UK account owner and mutations reject admin access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "RATE_LIMITED. Wait before retrying. PostgreSQL enforces 60 requests/key/minute and 300/account/minute across replicas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "description": "Seconds before retrying; fall back to a bounded one-minute delay when absent.", "schema": { "type": "integer", "minimum": 1 } } } } } } }, "/integrations/v1/products": { "get": { "tags": [ "Product API" ], "operationId": "listProducts", "summary": "Read product catalogue with cursor pagination", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:read", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9_-]{1,80}$" }, "description": "Opaque nextCursor from the preceding page. Omit for the first page. Each page contains at most 100 products." } ], "responses": { "200": { "description": "Tenant catalogue and only this integration’s external mappings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPage" } } } }, "400": { "description": "Invalid request or idempotency header; unknown fields, invalid barcode hierarchy or invalid cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "INVALID_API_KEY for missing, invalid, expired or revoked integration credentials; human routes require browser JWT authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "SCOPE_REQUIRED, ACCOUNT_DISABLED or ENVIRONMENT_DISABLED; human management requires the UK account owner and mutations reject admin access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "RATE_LIMITED. Wait before retrying. PostgreSQL enforces 60 requests/key/minute and 300/account/minute across replicas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "description": "Seconds before retrying; fall back to a bounded one-minute delay when absent.", "schema": { "type": "integer", "minimum": 1 } } } } } } }, "/integrations/v1/products/import": { "post": { "tags": [ "Product API" ], "operationId": "importProducts", "summary": "Import new catalogue products atomically", "description": "products:write is required. Creates catalogue records usable by production orders, without receiving stock, generating stamps, releasing inventory, posting VPD or notifying SICPA. Manufacturer and recipe fields are excluded from this initial API. The whole batch succeeds or fails. Existing catalogue conflicts need owner review; this endpoint never silently overwrites them. Persist the exact request and Idempotency-Key before sending. Namespace is account + stable integration + environment + product-import operation, independent of rotating key IDs. Canonical product/barcode ordering and trimmed descriptive fields permit equivalent reordering; external IDs and code case remain significant. Replaying an accepted payload returns its original import. A changed accepted key conflicts. Reuse the identical key/body after a lost response or transient 5xx; do not invent a new key to bypass errors. Identical products already mapped by this integration in a different batch reuse their product IDs; changed mapped content returns PRODUCT_CONFLICT. A prior unmapped catalogue match returns PRODUCT_MAPPING_REQUIRED; barcode collisions return BARCODE_CONFLICT. Existing browser catalogue edits are not silently reverted by an import.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:write", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[\\x21-\\x7E]{1,128}$" }, "description": "Persisted client-selected batch identity: 1–128 printable non-space ASCII characters. Reuse with identical accepted content after timeout or restart." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductImport" }, "example": { "products": [ { "externalProductId": "EXAMPLE-BLUE-10ML", "name": "Blueberry 10ml", "sku": "BLUE-10ML", "brand": "Example", "volumeMl": 10, "barcodes": [ { "code": "BLUE10-ITEM", "level": "ITEM", "unitsPerPack": 1 }, { "code": "BLUE10-PACK5", "level": "PACK", "unitsPerPack": 5, "containsCode": "BLUE10-ITEM", "containsQty": 5 } ] } ] } } } }, "responses": { "200": { "description": "Accepted request replay; same import ID and product mappings, replayed=true.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportResult" } } }, "headers": { "Idempotency-Replayed": { "description": "Present and true when an accepted import is replayed.", "schema": { "type": "string", "enum": [ "true" ] } } } }, "201": { "description": "First atomic acceptance; replayed=false.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportResult" } } } }, "400": { "description": "Invalid request or idempotency header; unknown fields, invalid barcode hierarchy or invalid cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "INVALID_API_KEY for missing, invalid, expired or revoked integration credentials; human routes require browser JWT authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "SCOPE_REQUIRED, ACCOUNT_DISABLED or ENVIRONMENT_DISABLED; human management requires the UK account owner and mutations reject admin access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "IDEMPOTENCY_CONFLICT for changed content using an accepted key, or a catalogue/mapping/key-limit conflict. Review; do not retry with a new key to bypass the conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "JSON body exceeds 1 MiB on the integration API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON_REQUIRED. Send a JSON body with Content-Type: application/json.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "RATE_LIMITED. Wait before retrying. PostgreSQL enforces 60 requests/key/minute and 300/account/minute across replicas.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "description": "Seconds before retrying; fall back to a bounded one-minute delay when absent.", "schema": { "type": "integer", "minimum": 1 } } } }, "500": { "description": "Server failure. Retry an import with the identical body and the same Idempotency-Key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/warehouses": { "get": { "tags": [ "Owner management" ], "operationId": "ownerWarehouses", "summary": "List verified warehouses", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner.", "security": [ { "OwnerSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehousePage" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Owner management" ], "operationId": "createWarehouse", "summary": "Register verified pilot premises", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Existing references cannot be overwritten.", "security": [ { "OwnerSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWarehouse" } } } }, "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Warehouse" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/inventory-manifests": { "post": { "tags": [ "Owner management" ], "operationId": "ownerStageInventory", "summary": "Stage a complete inventory manifest", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Identical namespace/reference/version replays return 200 with the same manifest; changed content returns 409 MANIFEST_CONFLICT. Semantic inventory errors are stored as INVALID with report.errors. Staging alone adopts no stock.", "security": [ { "OwnerSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifestInput" } } } }, "responses": { "200": { "description": "Identical manifest replay; no duplicate adoption.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifest" } } } }, "202": { "description": "Manifest staged with a semantic validation report. No inventory adoption or provider confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifest" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "tags": [ "Owner management" ], "operationId": "ownerManifests", "summary": "List inventory review records", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifestPage" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/inventory-manifests/{id}": { "get": { "tags": [ "Owner management" ], "operationId": "ownerManifest", "summary": "Read inventory report and review status", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifest" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/release-validations": { "post": { "tags": [ "Owner management" ], "operationId": "ownerValidateRelease", "summary": "Preview eligibility and duty without recording a release", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Validation is advisory; acceptance rechecks inventory under the shared account lock.", "security": [ { "OwnerSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInput" } } } }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseValidation" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/releases": { "get": { "tags": [ "Owner management" ], "operationId": "ownerReleases", "summary": "List releases or recover by external despatch ID", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9_-]+$" } }, { "name": "externalDespatchId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "Recover the original result after a lost response; scoped to this integration." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResultPage" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Owner management" ], "operationId": "ownerAcceptRelease", "summary": "Record one local release and automatic VPD accounting", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Transactional acceptance is atomic. Identical retries return 200 with the same operation ID and Idempotency-Replayed:true. New releases return 202 and Location; pending delivery supplies Retry-After. Do not resubmit unknown provider outcomes or interpret 202 as SICPA confirmation.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[!-~]+$" }, "description": "Persist before first send. Reuse with the same canonical request for timeout/retry. The same business despatch with a changed body conflicts even under a new key." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInput" } } } }, "responses": { "200": { "description": "Identical request replay; current independent accounting/provider states.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResult" } } }, "headers": { "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "description": "True for an existing operation." } } }, "202": { "description": "Local release and VPD accounting recorded; provider status is independent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResult" } } }, "headers": { "Location": { "schema": { "type": "string" }, "description": "Status resource for the accepted release." }, "Retry-After": { "schema": { "type": "integer" }, "description": "Suggested delay before polling a pending notification." } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/releases/{id}": { "get": { "tags": [ "Owner management" ], "operationId": "ownerRelease", "summary": "Read local release, VPD and SICPA status", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResult" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/warehouses": { "get": { "tags": [ "Warehouse pilot API" ], "operationId": "integrationWarehouses", "summary": "List verified warehouses", "description": "Requires releases:validate. Reads are restricted to the calling integration.", "security": [ { "IntegrationKey": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWarehousePage" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/inventory-manifests": { "post": { "tags": [ "Warehouse pilot API" ], "operationId": "integrationStageInventory", "summary": "Stage a complete inventory manifest", "description": "Requires inventory:write. Reads are restricted to the calling integration. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Identical namespace/reference/version replays return 200 with the same manifest; changed content returns 409 MANIFEST_CONFLICT. Semantic inventory errors are stored as INVALID with report.errors. Staging alone adopts no stock.", "security": [ { "IntegrationKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifestInput" } } } }, "responses": { "200": { "description": "Identical manifest replay; no duplicate adoption.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifest" } } } }, "202": { "description": "Manifest staged with a semantic validation report. No inventory adoption or provider confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifest" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/inventory-manifests/{id}": { "get": { "tags": [ "Warehouse pilot API" ], "operationId": "integrationManifest", "summary": "Read inventory report and review status", "description": "Requires inventory:read. Reads are restricted to the calling integration.", "security": [ { "IntegrationKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifest" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/release-validations": { "post": { "tags": [ "Warehouse pilot API" ], "operationId": "integrationValidateRelease", "summary": "Preview eligibility and duty without recording a release", "description": "Requires releases:validate. Reads are restricted to the calling integration. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Validation is advisory; acceptance rechecks inventory under the shared account lock.", "security": [ { "IntegrationKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInput" } } } }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseValidation" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/releases": { "get": { "tags": [ "Warehouse pilot API" ], "operationId": "integrationReleases", "summary": "List releases or recover by external despatch ID", "description": "Requires releases:read. Reads are restricted to the calling integration.", "security": [ { "IntegrationKey": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9_-]+$" } }, { "name": "externalDespatchId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "Recover the original result after a lost response; scoped to this integration." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResultPage" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Warehouse pilot API" ], "operationId": "integrationAcceptRelease", "summary": "Record one local release and automatic VPD accounting", "description": "Requires releases:write. Reads are restricted to the calling integration. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Transactional acceptance is atomic. Identical retries return 200 with the same operation ID and Idempotency-Replayed:true. New releases return 202 and Location; pending delivery supplies Retry-After. Do not resubmit unknown provider outcomes or interpret 202 as SICPA confirmation.", "security": [ { "IntegrationKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[!-~]+$" }, "description": "Persist before first send. Reuse with the same canonical request for timeout/retry. The same business despatch with a changed body conflicts even under a new key." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInput" } } } }, "responses": { "200": { "description": "Identical request replay; current independent accounting/provider states.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResult" } } }, "headers": { "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] }, "description": "True for an existing operation." } } }, "202": { "description": "Local release and VPD accounting recorded; provider status is independent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResult" } } }, "headers": { "Location": { "schema": { "type": "string" }, "description": "Status resource for the accepted release." }, "Retry-After": { "schema": { "type": "integer" }, "description": "Suggested delay before polling a pending notification." } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/releases/{id}": { "get": { "tags": [ "Warehouse pilot API" ], "operationId": "integrationRelease", "summary": "Read local release, VPD and SICPA status", "description": "Requires releases:read. Reads are restricted to the calling integration.", "security": [ { "IntegrationKey": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseResult" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/inventory-lots": { "get": { "tags": [ "Owner management" ], "operationId": "ownerInventoryLots", "summary": "List approved inventory holdings", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryLotPage" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/inventory-manifests/{id}/approve": { "post": { "tags": [ "Owner management" ], "operationId": "ownerapproveManifest", "summary": "Approve verified complete source inventory", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Reason is required. Approval revalidates complete source partitions under the account lock and creates immutable holdings; approved sources are protected from restore/deletion. No historical provider events are fabricated.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReview" } } } }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifest" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/inventory-manifests/{id}/reject": { "post": { "tags": [ "Owner management" ], "operationId": "ownerrejectManifest", "summary": "Reject an inventory manifest", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner. Mutations require the isolated pilot gate. LIVE acceptance is disabled. All JSON bodies are capped at 1 MiB. Reason is required. Approval revalidates complete source partitions under the account lock and creates immutable holdings; approved sources are protected from restore/deletion. No historical provider events are fabricated.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReview" } } } }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryManifest" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/developer/releases/{id}/evidence": { "get": { "tags": [ "Owner management" ], "operationId": "ownerReleaseEvidence", "summary": "Export retained release and provider evidence", "description": "UK OWNER browser JWT. Admin access can read; mutations require the actual owner.", "security": [ { "OwnerSession": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseEvidence" } } } }, "400": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Invalid input, denied access, conflict, body limit, throttling or server failure. No partial release/accounting on failed acceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/contacts": { "post": { "tags": [ "Contacts operations" ], "operationId": "IntegrationContactsController_create", "summary": "Create — Contacts", "description": "Requires contacts:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "contacts:write", "x-generated-from": "backend/src/developer/contacts.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationContactsController_create_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalContactsCreateContactDto" } } } } }, "get": { "tags": [ "Contacts operations" ], "operationId": "IntegrationOperationalReadController_contacts", "summary": "Contacts — Contacts", "description": "Requires contacts:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "contacts:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_contacts_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } } ] } }, "/integrations/v1/contacts/{id}": { "patch": { "tags": [ "Contacts operations" ], "operationId": "IntegrationContactsController_update", "summary": "Update — Contacts", "description": "Requires contacts:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "contacts:write", "x-generated-from": "backend/src/developer/contacts.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationContactsController_update_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalContactsUpdateContactDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Contacts operations" ], "operationId": "IntegrationContactsController_remove", "summary": "Remove — Contacts", "description": "Requires contacts:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "contacts:write", "x-generated-from": "backend/src/developer/contacts.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationContactsController_remove_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Contacts operations" ], "operationId": "IntegrationOperationalReadController_contact", "summary": "Contact — Contacts", "description": "Requires contacts:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "contacts:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_contact_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/inventory/units": { "get": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_units", "summary": "Units — Inventory", "description": "Requires inventory:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. Lookup values are exact matches. Unsupported filters are rejected. Units/scans/aggregation pages contain at most 100 rows; lots/transfer/allocation pages at most 50. Follow nextCursor until null.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "inventory:read", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_units_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "sku", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "barcode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "batch", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "productionNumber", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } }, { "name": "warehouseId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "inventoryLotId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "aggregationCode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "stampCode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } }, { "name": "availability", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "AVAILABLE", "RESERVED", "RELEASED" ] } } ] } }, "/integrations/v1/inventory/lots": { "get": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_lots", "summary": "Lots — Inventory", "description": "Requires inventory:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. Lookup values are exact matches. Unsupported filters are rejected. Units/scans/aggregation pages contain at most 100 rows; lots/transfer/allocation pages at most 50. Follow nextCursor until null.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "inventory:read", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_lots_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "sku", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "barcode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "batch", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "productionNumber", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } }, { "name": "warehouseId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "inventoryLotId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } } ] } }, "/integrations/v1/inventory/scans": { "get": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_scans", "summary": "Scans — Inventory", "description": "Requires inventory:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. Lookup values are exact matches. Unsupported filters are rejected. Units/scans/aggregation pages contain at most 100 rows; lots/transfer/allocation pages at most 50. Follow nextCursor until null.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "inventory:read", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_scans_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "sku", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "barcode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "batch", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "productionNumber", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } }, { "name": "aggregationCode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "stampCode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } } ] } }, "/integrations/v1/inventory/aggregations": { "get": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_aggregations", "summary": "Aggregations — Inventory", "description": "Requires inventory:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. Lookup values are exact matches. Unsupported filters are rejected. Units/scans/aggregation pages contain at most 100 rows; lots/transfer/allocation pages at most 50. Follow nextCursor until null.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "inventory:read", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_aggregations_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "sku", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "barcode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "batch", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 } }, { "name": "productionNumber", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } }, { "name": "aggregationCode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } } ] } }, "/integrations/v1/inventory/transfers": { "post": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_transfer", "summary": "Transfer — Inventory", "description": "Requires inventory:write and an enabled isolated pilot. Moves exact owner-approved units between two verified DUTY_SUSPENDED premises. Rejects free-circulation destinations, reserved/released units, invalid movement time and unsupported stock. The local transfer does not change duty or transmit a provider event (LOCAL_ONLY). This is not provider acceptance or permission for an actual duty-suspended journey. Persist the exact body, business ID and Idempotency-Key before sending. First success is 201; identical replay is 200 with Idempotency-Replayed:true. Changed content or an overlapping claim returns 409. Recover by the original business ID after a lost response; do not invent a replacement ID.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "inventory:write", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Exact persisted request replay. Same operation ID; no second movement or reservation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_transfer_Response" } } }, "headers": { "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] } } } }, "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_transfer_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperInventoryTransferDto" }, "example": { "externalTransferId": "EXAMPLE-TRANSFER-001", "fromWarehouseId": "{{sourceWarehouseId}}", "toWarehouseId": "{{destinationWarehouseId}}", "movementType": "DUTY_SUSPENDED_TRANSFER", "occurredAt": "2026-10-15T10:00:00+01:00", "custodyEvidence": "FICTIONAL — replace with verified custody and departure/arrival evidence", "authorityEvidence": "FICTIONAL — replace with actual authorised movement evidence", "stampCodes": [ "UKVDSDRY/FAKEEXAMPLE01" ], "aggregationCodes": [] } } } }, "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_transfers", "summary": "Transfers — Inventory", "description": "Requires inventory:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. Lookup values are exact matches. Unsupported filters are rejected. Units/scans/aggregation pages contain at most 100 rows; lots/transfer/allocation pages at most 50. Follow nextCursor until null.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "inventory:read", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_transfers_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "externalTransferId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } } ] } }, "/integrations/v1/inventory/transfers/{id}": { "get": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_transferDetail", "summary": "Transfer Detail — Inventory", "description": "Requires inventory:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. Lookup values are exact matches. Unsupported filters are rejected. Units/scans/aggregation pages contain at most 100 rows; lots/transfer/allocation pages at most 50. Follow nextCursor until null.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "inventory:read", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_transferDetail_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/order-allocations": { "post": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_reserve", "summary": "Reserve — Orders", "description": "Requires orders:write and an enabled isolated pilot. Reserves exact owner-approved available stamp leaves or complete aggregates for this integration and externalOrderId. Reservation does not release goods or post duty. Later partial releases must use the matching order and integration; cancellation can free only the unreleased remainder. Persist the exact body, business ID and Idempotency-Key before sending. First success is 201; identical replay is 200 with Idempotency-Replayed:true. Changed content or an overlapping claim returns 409. Recover by the original business ID after a lost response; do not invent a replacement ID.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "orders:write", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Exact persisted request replay. Same operation ID; no second movement or reservation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_reserve_Response" } } }, "headers": { "Idempotency-Replayed": { "schema": { "type": "string", "enum": [ "true" ] } } } }, "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_reserve_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperReserveOrderDto" }, "example": { "externalAllocationId": "EXAMPLE-ALLOCATION-001", "externalOrderId": "EXAMPLE-ORDER-001", "warehouseId": "{{warehouseId}}", "stampCodes": [ "UKVDSDRY/FAKEEXAMPLE01" ], "aggregationCodes": [] } } } }, "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_allocations", "summary": "Allocations — Orders", "description": "Requires orders:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. Lookup values are exact matches. Unsupported filters are rejected. Units/scans/aggregation pages contain at most 100 rows; lots/transfer/allocation pages at most 50. Follow nextCursor until null.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "orders:read", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_allocations_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "externalOrderId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } }, { "name": "externalAllocationId", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 128 } } ] } }, "/integrations/v1/order-allocations/{id}": { "get": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_allocation", "summary": "Allocation — Orders", "description": "Requires orders:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. Lookup values are exact matches. Unsupported filters are rejected. Units/scans/aggregation pages contain at most 100 rows; lots/transfer/allocation pages at most 50. Follow nextCursor until null.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "orders:read", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_allocation_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/order-allocations/{id}/cancel": { "post": { "tags": [ "Warehouse operations" ], "operationId": "IntegrationInventoryOperationsController_cancel", "summary": "Cancel — Orders", "description": "Requires orders:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "orders:write", "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationInventoryOperationsController_cancel_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperCancelOrderAllocationDto" }, "example": { "reason": "Example order amended; release the unreleased reservation only." } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/developer/order-allocations/{id}/cancel": { "post": { "tags": [ "Owner management" ], "operationId": "DeveloperOrderAllocationController_cancel", "summary": "Cancel — OWNER", "description": "Actual UK owner session only in the isolated pilot. Cancels only the unreleased remainder. Cannot reverse a release, duty posting or provider event. An identical repeated cancellation reason returns the retained result; a changed reason conflicts.", "security": [ { "OwnerSession": [] } ], "x-generated-from": "backend/src/developer/inventory-operations.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperOrderAllocationController_cancel_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperCancelOrderAllocationDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/catalogue": { "get": { "tags": [ "Products operations" ], "operationId": "IntegrationOperationalReadController_catalogue", "summary": "Catalogue — Products", "description": "Requires products:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_catalogue_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "sku", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 160 } }, { "name": "barcode", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 160 } } ] }, "post": { "tags": [ "Products operations" ], "operationId": "IntegrationProductsController_create", "summary": "Create — Products", "description": "Requires products:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:write", "x-generated-from": "backend/src/developer/products.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductsController_create_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductsCreateProductDto" }, "example": { "name": "Example Liquid 10ml", "sku": "EXAMPLE-10", "volumeMl": 10, "recipe": { "pgMl": 4, "vgMl": 6 }, "barcodes": [ { "code": "EXAMPLE-ITEM", "level": "ITEM" }, { "code": "EXAMPLE-PACK5", "level": "PACK", "containsCode": "EXAMPLE-ITEM", "containsQty": 5 } ] } } } } } }, "/integrations/v1/catalogue/{id}": { "get": { "tags": [ "Products operations" ], "operationId": "IntegrationOperationalReadController_product", "summary": "Product — Products", "description": "Requires products:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_product_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Products operations" ], "operationId": "IntegrationProductsController_update", "summary": "Update — Products", "description": "Requires products:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:write", "x-generated-from": "backend/src/developer/products.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductsController_update_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductsUpdateProductDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Products operations" ], "operationId": "IntegrationProductsController_remove", "summary": "Remove — Products", "description": "Requires products:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:write", "x-generated-from": "backend/src/developer/products.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductsController_remove_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/production-orders": { "get": { "tags": [ "Production operations" ], "operationId": "IntegrationOperationalReadController_productionOrders", "summary": "Production Orders — Production", "description": "Requires production:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_productionOrders_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "sku", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 160 } }, { "name": "batch", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 160 } }, { "name": "productionNumber", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 160 } } ] }, "post": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_create", "summary": "Create — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_create_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductionordersCreateProductionOrderDto" }, "example": { "client": "Example Customer", "product": "Example Liquid 10ml", "productId": "{{productId}}", "sku": "EXAMPLE-10", "batch": "EXAMPLE-BATCH-001", "expiryDate": "2027-10-15", "planned": { "bottlesPlanned": 100, "pgPlanned": 400, "vgPlanned": 600 } } } } } } }, "/integrations/v1/production-orders/{id}": { "get": { "tags": [ "Production operations" ], "operationId": "IntegrationOperationalReadController_production", "summary": "Production — Production", "description": "Requires production:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_production_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_update", "summary": "Update — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_update_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductionordersUpdateProductionOrderDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_remove", "summary": "Remove — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_remove_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/purchase-orders": { "get": { "tags": [ "Purchases operations" ], "operationId": "IntegrationOperationalReadController_purchaseOrders", "summary": "Purchase Orders — Purchases", "description": "Requires purchases:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_purchaseOrders_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } } ] }, "post": { "tags": [ "Purchases operations" ], "operationId": "IntegrationPurchaseOrdersController_create", "summary": "Create — Purchases", "description": "Requires purchases:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:write", "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPurchaseOrdersController_create_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalPurchaseordersCreatePurchaseOrderDto" } } } } } }, "/integrations/v1/purchase-orders/{id}": { "get": { "tags": [ "Purchases operations" ], "operationId": "IntegrationOperationalReadController_purchase", "summary": "Purchase — Purchases", "description": "Requires purchases:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_purchase_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Purchases operations" ], "operationId": "IntegrationPurchaseOrdersController_update", "summary": "Update — Purchases", "description": "Requires purchases:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:write", "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPurchaseOrdersController_update_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalPurchaseordersUpdatePurchaseOrderDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Purchases operations" ], "operationId": "IntegrationPurchaseOrdersController_remove", "summary": "Remove — Purchases", "description": "Requires purchases:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:write", "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPurchaseOrdersController_remove_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/{resource}": { "get": { "tags": [ "Stock operations" ], "operationId": "IntegrationOperationalReadController_stock", "summary": "Stock — Stock", "description": "Requires stock:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_stock_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } } ] } }, "/integrations/v1/stamp-orders": { "get": { "tags": [ "Stamps operations" ], "operationId": "IntegrationOperationalReadController_stampOrders", "summary": "Stamp Orders — Stamps", "description": "Requires stamps:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_stampOrders_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } } ] } }, "/integrations/v1/manufacturers": { "get": { "tags": [ "Stamps operations" ], "operationId": "IntegrationOperationalReadController_manufacturers", "summary": "Manufacturers — Stamps", "description": "Requires stamps:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release. List responses use { items, nextCursor }; the default and maximum page size is 100. Filters are exact matches; only listed query parameters are supported.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:read", "x-generated-from": "backend/src/developer/operational-read.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationOperationalReadController_manufacturers_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } } ] } }, "/integrations/v1/production-orders/import": { "post": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_importMany", "summary": "Import Many — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_importMany_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductionordersImportProductionOrdersDto" } } } } } }, "/integrations/v1/production-orders/{id}/start": { "post": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_start", "summary": "Start — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_start_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/production-orders/{id}/complete": { "post": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_complete", "summary": "Complete — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_complete_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductionordersCompleteProductionOrderDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/production-orders/{id}/actuals": { "put": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_saveActuals", "summary": "Save Actuals — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_saveActuals_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductionordersCompleteProductionOrderDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/production-orders/{id}/invoice": { "post": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_uploadInvoice", "summary": "Upload Invoice — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_uploadInvoice_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductionordersInvoiceUploadDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_downloadInvoice", "summary": "Download Invoice — Production", "description": "Requires production:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:read", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Production operations" ], "operationId": "IntegrationProductionOrdersController_deleteInvoice", "summary": "Delete Invoice — Production", "description": "Requires production:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "production:write", "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductionOrdersController_deleteInvoice_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/catalogue/lookup": { "get": { "tags": [ "Products operations" ], "operationId": "IntegrationProductsController_lookup", "summary": "Lookup — Products", "description": "Requires products:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:read", "x-generated-from": "backend/src/developer/products.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductsController_lookup_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/catalogue/barcodes/{barcodeId}": { "patch": { "tags": [ "Products operations" ], "operationId": "IntegrationProductsController_updateBarcode", "summary": "Update Barcode — Products", "description": "Requires products:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:write", "x-generated-from": "backend/src/developer/products.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductsController_updateBarcode_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductsUpdateBarcodeDto" } } } }, "parameters": [ { "name": "barcodeId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Products operations" ], "operationId": "IntegrationProductsController_removeBarcode", "summary": "Remove Barcode — Products", "description": "Requires products:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:write", "x-generated-from": "backend/src/developer/products.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductsController_removeBarcode_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "barcodeId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/catalogue/aggregates/{aggregateId}": { "patch": { "tags": [ "Products operations" ], "operationId": "IntegrationProductsController_linkAggregate", "summary": "Link Aggregate — Products", "description": "Requires products:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:write", "x-generated-from": "backend/src/developer/products.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductsController_linkAggregate_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductsLinkAggregateDto" } } } }, "parameters": [ { "name": "aggregateId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/catalogue/{id}/barcodes": { "post": { "tags": [ "Products operations" ], "operationId": "IntegrationProductsController_addBarcode", "summary": "Add Barcode — Products", "description": "Requires products:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "products:write", "x-generated-from": "backend/src/developer/products.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProductsController_addBarcode_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalProductsBarcodeDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/purchase-orders/{id}/status": { "post": { "tags": [ "Purchases operations" ], "operationId": "IntegrationPurchaseOrdersController_setStatus", "summary": "Set Status — Purchases", "description": "Requires purchases:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:write", "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPurchaseOrdersController_setStatus_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalPurchaseordersUpdatePoStatusDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/purchase-orders/{id}/invoice": { "post": { "tags": [ "Purchases operations" ], "operationId": "IntegrationPurchaseOrdersController_uploadInvoice", "summary": "Upload Invoice — Purchases", "description": "Requires purchases:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:write", "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPurchaseOrdersController_uploadInvoice_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalPurchaseordersInvoiceFileDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "tags": [ "Purchases operations" ], "operationId": "IntegrationPurchaseOrdersController_downloadInvoice", "summary": "Download Invoice — Purchases", "description": "Requires purchases:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:read", "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Purchases operations" ], "operationId": "IntegrationPurchaseOrdersController_deleteInvoice", "summary": "Delete Invoice — Purchases", "description": "Requires purchases:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "purchases:write", "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPurchaseOrdersController_deleteInvoice_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stamps/scans/verify": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_verifyScans", "summary": "Verify Scans — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_verifyScans_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsVerifyScansDto" } } } } } }, "/integrations/v1/stamps/activate": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_activateStamps", "summary": "Activate Stamps — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_activateStamps_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsActivateStampsDto" } } } } } }, "/integrations/v1/stamps/activate-pack": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_activateAndPack", "summary": "Activate And Pack — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_activateAndPack_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsActivateAndPackDto" } } } } } }, "/integrations/v1/stamps/destroy": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_destroyStamps", "summary": "Destroy Stamps — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_destroyStamps_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsDestroyStampsDto" } } } } } }, "/integrations/v1/stamps/ship": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_shipStamps", "summary": "Ship Stamps — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_shipStamps_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsShipStampsDto" } } } } } }, "/integrations/v1/stamps/receive": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_receiveStamps", "summary": "Receive Stamps — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_receiveStamps_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsReceiveStampsDto" } } } } } }, "/integrations/v1/stamps/aggregates": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_createAggregate", "summary": "Create Aggregate — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_createAggregate_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsCreateAggregateDto" } } } } }, "get": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_listAggregates", "summary": "List Aggregates — Stamps", "description": "Requires stamps:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:read", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_listAggregates_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/stamps/aggregates/master": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_createMasterAggregate", "summary": "Create Master Aggregate — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_createMasterAggregate_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsCreateMasterAggregateDto" } } } } } }, "/integrations/v1/stamps/aggregates/{id}/stamps": { "get": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_listAggregateStamps", "summary": "List Aggregate Stamps — Stamps", "description": "Requires stamps:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:read", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_listAggregateStamps_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stamps/aggregates/{id}/break": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_breakAggregate", "summary": "Break Aggregate — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_breakAggregate_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stamps/manufacturers": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_createManufacturer", "summary": "Create Manufacturer — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_createManufacturer_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsCreateManufacturerDto" } } } } } }, "/integrations/v1/stamps/manufacturers/{id}": { "patch": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_updateManufacturer", "summary": "Update Manufacturer — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_updateManufacturer_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStampsUpdateManufacturerDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_deleteManufacturer", "summary": "Delete Manufacturer — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_deleteManufacturer_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stamps/agg-codes/import": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_importAggCodes", "summary": "Import Agg Codes — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_importAggCodes_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperAggCodesDto" } } } } } }, "/integrations/v1/stamps/agg-codes": { "get": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_aggCodeSummary", "summary": "Agg Code Summary — Stamps", "description": "Requires stamps:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:read", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_aggCodeSummary_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/stamps/case-labels": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_caseLabels", "summary": "Case Labels — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_caseLabels_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperCaseLabelsDto" } } } } } }, "/integrations/v1/stamps/scan-photos": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_saveScanPhotos", "summary": "Save Scan Photos — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_saveScanPhotos_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperScanPhotosDto" } } } } }, "get": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_listScanPhotos", "summary": "List Scan Photos — Stamps", "description": "Requires stamps:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:read", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_listScanPhotos_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stamps/scan-photos/{id}/file": { "get": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_getScanPhoto", "summary": "Get Scan Photo — Stamps", "description": "Requires stamps:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:read", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stamps": { "post": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_createOrder", "summary": "Create Order — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_createOrder_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperCreateStampOrderDto" } } } } } }, "/integrations/v1/stamps/{id}": { "patch": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_updateOrder", "summary": "Update Order — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_updateOrder_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalDeveloperUpdateStampOrderDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Stamps operations" ], "operationId": "IntegrationStampsController_deleteOrder", "summary": "Delete Order — Stamps", "description": "Requires stamps:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stamps:write", "x-generated-from": "backend/src/developer/stamps.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStampsController_deleteOrder_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/pgvg": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addPgvg", "summary": "Add Pgvg — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addPgvg_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddPgvgDto" }, "example": { "type": "PG", "qtyMl": 1000, "batch": "EXAMPLE-INGREDIENT-001", "expiryDate": "2027-10-15" } } } } } }, "/integrations/v1/stock/pgvg/{id}": { "patch": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_editPgvgLog", "summary": "Edit Pgvg Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_editPgvgLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockEditPgvgLogDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deletePgvgLog", "summary": "Delete Pgvg Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deletePgvgLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/nicotine": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addNicotine", "summary": "Add Nicotine — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addNicotine_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddNicotineDto" } } } } } }, "/integrations/v1/stock/nicotine/log/{id}": { "patch": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_editNicLog", "summary": "Edit Nic Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_editNicLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockEditNicLogDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteNicLog", "summary": "Delete Nic Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteNicLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/nicotine/{id}": { "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteNicotineStock", "summary": "Delete Nicotine Stock — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteNicotineStock_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/nicotine/convert": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_convertNicotine", "summary": "Convert Nicotine — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_convertNicotine_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockConvertNicotineDto" } } } } } }, "/integrations/v1/stock/sweetener/powder": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addSweetenerPowder", "summary": "Add Sweetener Powder — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addSweetenerPowder_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddSweetenerPowderDto" } } } } } }, "/integrations/v1/stock/sweetener/liquid": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addSweetenerLiquid", "summary": "Add Sweetener Liquid — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addSweetenerLiquid_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddSweetenerLiquidDto" } } } } } }, "/integrations/v1/stock/sweetener/convert": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_convertSweetener", "summary": "Convert Sweetener — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_convertSweetener_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockConvertSweetenerDto" } } } } } }, "/integrations/v1/stock/sweetener/log/{id}": { "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteSweetenerLog", "summary": "Delete Sweetener Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteSweetenerLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/cbd": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addCbd", "summary": "Add Cbd — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addCbd_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddCbdDto" } } } } } }, "/integrations/v1/stock/cbd/convert": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_convertCbd", "summary": "Convert Cbd — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_convertCbd_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockConvertCbdDto" } } } } } }, "/integrations/v1/stock/cbd/log/{id}": { "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteCbdLog", "summary": "Delete Cbd Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteCbdLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/cbd/{id}": { "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteCbdStock", "summary": "Delete Cbd Stock — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteCbdStock_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/flavourings": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_createFlavouring", "summary": "Create Flavouring — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_createFlavouring_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockCreateFlavouringDto" } } } } } }, "/integrations/v1/stock/flavourings/{id}/add": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addFlavouringStock", "summary": "Add Flavouring Stock — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addFlavouringStock_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddFlavStockDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/flavourings/{id}": { "patch": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_updateFlavouring", "summary": "Update Flavouring — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_updateFlavouring_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockUpdateFlavouringDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteFlavouring", "summary": "Delete Flavouring — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteFlavouring_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/flavourings/log/{id}": { "patch": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_editFlavLog", "summary": "Edit Flav Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_editFlavLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockEditFlavLogDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteFlavLog", "summary": "Delete Flav Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteFlavLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/labels": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addLabel", "summary": "Add Label — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addLabel_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddLabelDto" } } } } } }, "/integrations/v1/stock/labels/{id}/add": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addLabelStock", "summary": "Add Label Stock — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addLabelStock_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddLabelStockDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/labels/log/{id}": { "patch": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_editLblLog", "summary": "Edit Lbl Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_editLblLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockEditLblLogDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteLblLog", "summary": "Delete Lbl Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteLblLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/labels/{id}": { "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteLabelSku", "summary": "Delete Label Sku — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteLabelSku_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/bottles": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addBottle", "summary": "Add Bottle — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addBottle_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddBottleDto" } } } } } }, "/integrations/v1/stock/bottles/{id}/add": { "post": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_addBottleStock", "summary": "Add Bottle Stock — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_addBottleStock_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockAddBottleStockDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/bottles/log/{id}": { "patch": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_editBottleLog", "summary": "Edit Bottle Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_editBottleLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalStockEditBottleLogDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteBottleLog", "summary": "Delete Bottle Log — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteBottleLog_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/stock/bottles/{id}": { "delete": { "tags": [ "Stock operations" ], "operationId": "IntegrationStockController_deleteBottleSize", "summary": "Delete Bottle Size — Stock", "description": "Requires stock:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "stock:write", "x-generated-from": "backend/src/developer/stock.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStockController_deleteBottleSize_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/vpd": { "get": { "tags": [ "Vpd operations" ], "operationId": "IntegrationVpdController_list", "summary": "List — Vpd", "description": "Requires vpd:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "vpd:read", "x-generated-from": "backend/src/developer/vpd.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationVpdController_list_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/vpd/production-orders": { "get": { "tags": [ "Vpd operations" ], "operationId": "IntegrationVpdController_productionOrders", "summary": "Production Orders — Vpd", "description": "Requires vpd:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "vpd:read", "x-generated-from": "backend/src/developer/vpd.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationVpdController_productionOrders_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/vpd/import-orders": { "get": { "tags": [ "Vpd operations" ], "operationId": "IntegrationVpdController_importOrders", "summary": "Import Orders — Vpd", "description": "Requires vpd:read. Returns only records available to this integration account. Reading does not reserve goods, establish provider activation or record a taxable release.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "vpd:read", "x-generated-from": "backend/src/developer/vpd.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationVpdController_importOrders_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/integrations/v1/vpd/orders": { "post": { "tags": [ "Vpd operations" ], "operationId": "IntegrationVpdController_createOrder", "summary": "Create Order — Vpd", "description": "Requires vpd:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "vpd:write", "x-generated-from": "backend/src/developer/vpd.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationVpdController_createOrder_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalVpdCreateVpdOrderDto" } } } } } }, "/integrations/v1/vpd/orders/{id}": { "patch": { "tags": [ "Vpd operations" ], "operationId": "IntegrationVpdController_updateOrder", "summary": "Update Order — Vpd", "description": "Requires vpd:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "vpd:write", "x-generated-from": "backend/src/developer/vpd.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationVpdController_updateOrder_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalVpdUpdateVpdOrderDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Vpd operations" ], "operationId": "IntegrationVpdController_removeOrder", "summary": "Remove Order — Vpd", "description": "Requires vpd:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "vpd:write", "x-generated-from": "backend/src/developer/vpd.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationVpdController_removeOrder_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/vpd/orders/{id}/entries": { "post": { "tags": [ "Vpd operations" ], "operationId": "IntegrationVpdController_addEntry", "summary": "Add Entry — Vpd", "description": "Requires vpd:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "vpd:write", "x-generated-from": "backend/src/developer/vpd.integration.controller.ts", "responses": { "201": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationVpdController_addEntry_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationalVpdCreateVpdEntryDto" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/integrations/v1/vpd/entries/{id}": { "delete": { "tags": [ "Vpd operations" ], "operationId": "IntegrationVpdController_removeEntry", "summary": "Remove Entry — Vpd", "description": "Requires vpd:write. Operational mutation requires the explicitly enabled isolated SIMULATION/SANDBOX pilot. Domain permissions, source protection and retained-ledger restrictions still apply. Do not retry an uncertain mutation automatically unless its endpoint explicitly supports persisted idempotency; query the resource first.", "security": [ { "IntegrationKey": [] } ], "x-required-scope": "vpd:write", "x-generated-from": "backend/src/developer/vpd.integration.controller.ts", "responses": { "200": { "description": "Successful domain operation. Local writes and reads do not constitute live SICPA confirmation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationVpdController_removeEntry_Response" } } } }, "400": { "description": "Invalid request. Unknown fields, malformed values and invalid lifecycle transitions are rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, expired, revoked or invalid integration key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Scope missing, account disabled or isolated pilot unavailable. A key cannot approve inventory or enable live release.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Record not found in the calling account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, protected retained evidence, unavailable stock, allocation overlap or idempotency conflict. Reconcile before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request exceeds the 1 MiB integration limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Use application/json for a JSON request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded. Honor Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } } }, "components": { "securitySchemes": { "IntegrationKey": { "type": "http", "scheme": "bearer", "bearerFormat": "VapeTax scoped integration key", "description": "One-time generated key from Account → Developer; includes deployment environment and random public ID." }, "OwnerSession": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Existing browser owner session. Never give this token to the warehouse connector." } }, "schemas": { "Error": { "type": "object", "additionalProperties": true, "properties": { "statusCode": { "type": "integer" }, "code": { "type": "string" }, "message": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "error": { "type": "string" } }, "required": [ "message" ], "description": "User-presentable error. Stable code is returned for integration auth, idempotency, restore and conflict conditions. Validation errors may instead contain message strings without code." }, "BarcodeInput": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 80, "minLength": 1, "description": "Existing packaging barcode. Normalisation removes whitespace and an optional (01) GTIN wrapper; result must be 4–64 printable ASCII characters without spaces. Product barcodes do not identify physical inventory." }, "level": { "type": "string", "enum": [ "ITEM", "PACK", "CASE", "MASTER", "PALLET" ], "default": "ITEM" }, "label": { "type": "string", "maxLength": 60 }, "unitsPerPack": { "type": "integer", "minimum": 1, "maximum": 10000000, "default": 1, "description": "ITEM requires 1. Derived from containsQty × inner units when containment is supplied; caller value is ignored in that case." }, "containsCode": { "type": "string", "maxLength": 80, "nullable": true, "description": "Another barcode in this same product. Both containment fields are required together. ITEM cannot contain another layer. Cycles and more than 30 layers are rejected." }, "containsQty": { "type": "integer", "minimum": 2, "maximum": 1000000, "nullable": true } }, "required": [ "code" ] }, "ProductInput": { "type": "object", "additionalProperties": false, "properties": { "externalProductId": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^\\S(?:.*\\S)?$", "description": "Stable case-sensitive product ID from this integration. Do not change it across retries; no leading/trailing whitespace." }, "name": { "type": "string", "maxLength": 160, "minLength": 1, "description": "Trimmed; must not be blank." }, "sku": { "type": "string", "maxLength": 80 }, "brand": { "type": "string", "maxLength": 80 }, "volumeMl": { "type": "number", "minimum": 0.001, "maximum": 100000, "multipleOf": 0.001, "description": "Liquid volume in ml for the catalogue item, at most 3 decimal places. Omit when unknown. Catalogue volume does not establish verified duty inventory." }, "ecid": { "type": "string", "maxLength": 60 }, "notes": { "type": "string", "maxLength": 2000 }, "barcodes": { "type": "array", "items": { "$ref": "#/components/schemas/BarcodeInput" }, "maxItems": 20 } }, "required": [ "externalProductId", "name" ] }, "ProductImport": { "type": "object", "additionalProperties": false, "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductInput" }, "maxItems": 100, "minItems": 1, "description": "Atomic batch. Repeated external IDs, duplicate packaging barcodes and invalid containment reject the whole batch." } }, "required": [ "products" ] }, "ImportedProduct": { "type": "object", "additionalProperties": false, "properties": { "externalProductId": { "type": "string", "maxLength": 128 }, "productId": { "type": "string", "maxLength": 128, "minLength": 1 } }, "required": [ "externalProductId", "productId" ] }, "ImportResult": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1 }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ImportedProduct" }, "maxItems": 100 }, "replayed": { "type": "boolean" } }, "required": [ "id", "products", "replayed" ] }, "Barcode": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1 }, "code": { "type": "string", "maxLength": 64 }, "level": { "type": "string", "enum": [ "ITEM", "PACK", "CASE", "MASTER", "PALLET" ] }, "label": { "type": "string", "maxLength": 60 }, "unitsPerPack": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "containsCode": { "type": "string", "maxLength": 64, "nullable": true }, "containsQty": { "type": "integer", "nullable": true }, "containsBarcodeId": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true } }, "required": [ "id", "code", "level", "label", "unitsPerPack" ], "description": "Product packaging information; additive barcode metadata may be returned." }, "Product": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1 }, "externalProductId": { "type": "string", "maxLength": 128, "nullable": true, "description": "Mapping from this integration, or null when no mapping belongs to it." }, "name": { "type": "string", "maxLength": 160 }, "sku": { "type": "string", "maxLength": 80 }, "brand": { "type": "string", "maxLength": 80 }, "volumeMl": { "type": "number", "nullable": true }, "ecid": { "type": "string", "maxLength": 60 }, "notes": { "type": "string", "maxLength": 2000 }, "barcodes": { "type": "array", "items": { "$ref": "#/components/schemas/Barcode" }, "maxItems": 20 } }, "required": [ "id", "externalProductId", "name", "sku", "brand", "volumeMl", "ecid", "notes", "barcodes" ] }, "ProductPage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Product" }, "maxItems": 100 }, "nextCursor": { "type": "string", "maxLength": 128, "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Capabilities": { "type": "object", "additionalProperties": false, "properties": { "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "operations": { "type": "array", "items": { "type": "string", "enum": [ "products:read", "products:write", "inventory:read", "inventory:write", "releases:validate", "releases:write", "releases:read" ] }, "maxItems": 7, "description": "Effective scopes granted to the calling key." }, "releaseAcceptanceEnabled": { "type": "boolean", "description": "True only for an explicitly enabled isolated simulation/sandbox pilot. Always false in LIVE." }, "limits": { "type": "object", "additionalProperties": true, "properties": { "productsPerImport": { "type": "integer", "enum": [ 100 ] }, "barcodesPerProduct": { "type": "integer", "enum": [ 20 ] }, "bodyBytes": { "type": "integer", "enum": [ 1048576 ] }, "requestsPerKeyPerMinute": { "type": "integer", "enum": [ 60 ] }, "requestsPerAccountPerMinute": { "type": "integer", "enum": [ 300 ] }, "manifestRetailUnits": { "type": "integer", "enum": [ 5000 ] }, "manifestAggregates": { "type": "integer", "enum": [ 500 ] }, "releaseAggregateRoots": { "type": "integer", "enum": [ 500 ] }, "releaseLooseStamps": { "type": "integer", "enum": [ 5000 ] }, "releaseExpandedAggregates": { "type": "integer", "enum": [ 5000 ] }, "releaseRetailUnits": { "type": "integer", "enum": [ 100000 ] }, "releaseLots": { "type": "integer", "enum": [ 1000 ] }, "releaseDepth": { "type": "integer", "enum": [ 30 ] }, "maxBackdateDays": { "type": "integer", "enum": [ 7 ] }, "clockSkewSeconds": { "type": "integer", "enum": [ 300 ] } }, "required": [ "productsPerImport", "barcodesPerProduct", "bodyBytes", "requestsPerKeyPerMinute", "requestsPerAccountPerMinute" ] }, "operationalWritesEnabled": { "type": "boolean", "description": "True only for an explicitly enabled isolated non-production pilot. Does not grant scopes or owner approval." }, "documentationUrl": { "type": "string", "format": "uri", "example": "https://vapetax.co.uk/docs" } }, "required": [ "environment", "operations", "releaseAcceptanceEnabled", "limits" ] }, "ApiKeyMetadata": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1 }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "products:read", "products:write", "inventory:read", "inventory:write", "releases:validate", "releases:write", "releases:read" ] }, "maxItems": 7, "minItems": 1, "uniqueItems": true }, "expiresAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "prefix", "scopes", "expiresAt", "revokedAt", "lastUsedAt" ] }, "Integration": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1 }, "name": { "type": "string", "maxLength": 80 }, "system": { "type": "string", "maxLength": 80 }, "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "enabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyMetadata" } } }, "required": [ "id", "name", "system", "environment", "enabled", "createdAt", "keys" ] }, "Developer": { "type": "object", "additionalProperties": false, "properties": { "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "enabled": { "type": "boolean" }, "releaseAcceptanceEnabled": { "type": "boolean", "description": "True only for an explicitly enabled isolated simulation/sandbox pilot. Always false in LIVE." }, "availableScopes": { "type": "array", "items": { "type": "string", "enum": [ "products:read", "products:write", "inventory:read", "inventory:write", "releases:validate", "releases:write", "releases:read" ] }, "maxItems": 7 }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } }, "required": [ "environment", "enabled", "releaseAcceptanceEnabled", "availableScopes", "integrations" ] }, "CreateIntegration": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 80, "minLength": 1 }, "system": { "type": "string", "maxLength": 80 } }, "required": [ "name" ] }, "CreateKey": { "type": "object", "additionalProperties": false, "properties": { "scopes": { "type": "array", "items": { "type": "string", "enum": [ "products:read", "stock:read", "production:read", "purchases:read", "contacts:read", "stamps:read", "vpd:read", "products:write", "stock:write", "production:write", "purchases:write", "contacts:write", "stamps:write", "vpd:write", "inventory:read", "inventory:write", "orders:read", "orders:write", "releases:validate", "releases:write", "releases:read" ] }, "maxItems": 7, "minItems": 1, "uniqueItems": true, "description": "Only scopes currently listed by GET /developer may be granted. Select least privilege. Release/inventory scopes are unavailable while the pilot gate is closed." }, "expiresInDays": { "type": "integer", "minimum": 1, "maximum": 90, "default": 90 } }, "required": [ "scopes" ] }, "IssuedKey": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1 }, "key": { "type": "string", "maxLength": 256, "description": "Secret returned only by this response. Store on the client server; never include in source control, logs, URLs, browser storage or shared collections." }, "prefix": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "products:read", "products:write", "inventory:read", "inventory:write", "releases:validate", "releases:write", "releases:read" ] }, "maxItems": 7, "minItems": 1, "uniqueItems": true }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "key", "prefix", "expiresAt", "scopes", "revokedAt", "lastUsedAt" ] }, "Ok": { "type": "object", "additionalProperties": false, "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ] }, "CreateWarehouse": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^\\S(?:.*\\S)?$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "locationUrn": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^urn:lote:id:loc:WAA1a[A-Za-z0-9]+$" }, "machineUrn": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^urn:lote:id:loc:WAA1a[A-Za-z0-9]+$" }, "verificationEvidence": { "type": "string", "minLength": 10, "maxLength": 2000 }, "holdingType": { "type": "string", "enum": [ "DUTY_SUSPENDED", "FREE_CIRCULATION" ], "description": "Owner-reviewed treatment of these premises. Transfers require DUTY_SUSPENDED at both ends. Existing unclassified premises cannot be used for transfers." } }, "required": [ "reference", "name", "locationUrn", "machineUrn", "verificationEvidence" ] }, "Warehouse": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "reference": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "enabled": { "type": "boolean" }, "locationUrn": { "type": "string", "minLength": 1, "maxLength": 200 }, "machineUrn": { "type": "string", "minLength": 1, "maxLength": 200 }, "verificationEvidence": { "type": "string", "minLength": 10, "maxLength": 2000 }, "verifiedAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z." }, "holdingType": { "type": "string", "enum": [ "DUTY_SUSPENDED", "FREE_CIRCULATION" ], "nullable": true, "description": "Owner-reviewed treatment of these premises. Transfers require DUTY_SUSPENDED at both ends. Existing unclassified premises cannot be used for transfers." } }, "required": [ "id", "reference", "name", "environment", "enabled", "locationUrn", "machineUrn", "verificationEvidence", "verifiedAt" ], "description": "Owner management record, including verification evidence and enabled state. These private management fields are not returned to machine API keys." }, "InventorySource": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "PRODUCTION_ORDER", "STAMP_ORDER", "EXTERNAL_IMPORT", "EXTERNAL_UK" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Native production/stamp order ID for native sources; stable external batch reference otherwise." }, "actualQuantity": { "type": "integer", "minimum": 1, "maximum": 5000 }, "evidenceReference": { "type": "string", "minLength": 10, "maxLength": 2000 } }, "required": [ "type", "reference", "actualQuantity", "evidenceReference" ] }, "InventoryOpeningLot": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 128 }, "treatment": { "type": "string", "enum": [ "NEW_RELEASE", "RELEASE_FROM_BOND", "ALREADY_ACCOUNTED" ] }, "stampCodes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 5000, "minItems": 1 }, "priorVpdEntryId": { "type": "string", "minLength": 1, "maxLength": 80 }, "custodyEvidence": { "type": "string", "maxLength": 2000 }, "authorityEvidence": { "type": "string", "maxLength": 2000 } }, "required": [ "reference", "treatment", "stampCodes" ], "description": "Exact non-overlapping stamp allocation. RELEASE_FROM_BOND and ALREADY_ACCOUNTED require an eligible existing VPD entry; release from bond also requires custody/authority evidence. The whole source must be reconciled before approval." }, "InventoryAggregate": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 128 }, "urn": { "type": "string", "maxLength": 200 }, "stampCodes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 5000, "minItems": 0 }, "childCodes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 500, "minItems": 0 } }, "required": [ "code", "stampCodes", "childCodes" ], "description": "Complete aggregation contents, including local scan alias and canonical provider URN where supplied. No empty or quantity-only case; no cycle, duplicate placement or depth above 30." }, "InventoryManifestInput": { "type": "object", "additionalProperties": false, "properties": { "externalInventoryReference": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^\\S(?:.*\\S)?$" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 80 }, "productId": { "type": "string", "minLength": 1, "maxLength": 80 }, "volumeMl": { "type": "string", "pattern": "^(?:0|[1-9]\\d{0,5})(?:\\.\\d{1,3})?$", "description": "Positive liquid volume in ml, at most three decimal places; verified against the product and inventory evidence." }, "inventoryAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z." }, "ownershipEvidence": { "type": "string", "minLength": 10, "maxLength": 2000 }, "activationEvidence": { "type": "string", "minLength": 10, "maxLength": 2000 }, "source": { "$ref": "#/components/schemas/InventorySource" }, "lots": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryOpeningLot" }, "maxItems": 100, "minItems": 1 }, "aggregates": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryAggregate" }, "maxItems": 500, "minItems": 0 }, "batch": { "type": "string", "maxLength": 80, "description": "External source batch only. Native production/import metadata is frozen from its source." }, "expiryDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "External source expiry date only, YYYY-MM-DD. Must be a real calendar date." } }, "required": [ "externalInventoryReference", "version", "warehouseId", "productId", "volumeMl", "inventoryAt", "ownershipEvidence", "activationEvidence", "source", "lots", "aggregates" ], "description": "Complete source partition, at most 5,000 distinct retail units and 500 aggregate definitions per manifest. Staging records a validation report without adopting inventory or sending provider history. Actual volume is established from the verified product and source evidence." }, "InventoryReport": { "type": "object", "additionalProperties": true, "properties": { "errors": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 100 }, "message": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "code", "message" ] }, "maxItems": 100, "minItems": 0 }, "retailUnits": { "type": "integer", "minimum": 0, "description": "Observed count in the retained submission. INVALID manifests can exceed the 5,000-unit acceptance limit; the report preserves that count for review." }, "aggregateCount": { "type": "integer", "minimum": 0, "maximum": 500 } }, "required": [ "errors", "retailUnits", "aggregateCount" ] }, "InventoryManifest": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "externalInventoryReference": { "type": "string", "minLength": 1, "maxLength": 128 }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "status": { "type": "string", "enum": [ "READY_FOR_REVIEW", "INVALID", "APPROVED", "REJECTED" ] }, "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "report": { "$ref": "#/components/schemas/InventoryReport" }, "payload": { "type": "object", "additionalProperties": true, "description": "Retained raw input object after canonical ordering and value normalization, bounded by the request DTO and 1 MiB request limit. An INVALID record can contain semantically invalid values, such as an invalid inventory timestamp or a combined stamp count above the acceptance limit. Read report for the validation errors; this is not an approved InventoryManifestInput." }, "reviewReason": { "type": "string", "maxLength": 2000, "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z." }, "approvedAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z.", "nullable": true }, "replayed": { "type": "boolean" } }, "required": [ "id", "externalInventoryReference", "version", "status", "report" ] }, "InventoryReview": { "type": "object", "additionalProperties": false, "properties": { "reason": { "type": "string", "minLength": 10, "maxLength": 2000 } }, "required": [ "reason" ] }, "InventoryLot": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "manifestId": { "type": "string", "minLength": 1, "maxLength": 80 }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 80 }, "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "sourceKey": { "type": "string", "minLength": 1, "maxLength": 400 }, "origin": { "type": "string", "enum": [ "IMPORT", "UK_MANUFACTURED" ] }, "productId": { "type": "string", "minLength": 1, "maxLength": 80 }, "productName": { "type": "string", "minLength": 1, "maxLength": 200 }, "volumeMl": { "type": "string", "pattern": "^(?:0|[1-9]\\d{0,5})(?:\\.\\d{1,3})?$", "description": "Positive liquid volume in ml, at most three decimal places; verified against the product and inventory evidence." }, "quantity": { "type": "integer", "minimum": 1, "maximum": 5000 }, "remainingQuantity": { "type": "integer", "minimum": 0, "maximum": 5000 }, "treatment": { "type": "string", "enum": [ "NEW_RELEASE", "RELEASE_FROM_BOND", "ALREADY_ACCOUNTED" ] }, "priorVpdEntryId": { "type": "string", "maxLength": 80, "nullable": true }, "evidence": { "type": "object", "additionalProperties": true } }, "required": [ "id", "manifestId", "warehouseId", "environment", "sourceKey", "origin", "productId", "productName", "volumeMl", "quantity", "remainingQuantity", "treatment", "priorVpdEntryId", "evidence" ] }, "ReleaseParty": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "reference", "name" ] }, "ReleaseOperator": { "type": "object", "additionalProperties": false, "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 128 }, "displayName": { "type": "string", "maxLength": 200 } }, "required": [ "reference" ] }, "ExpectedReleaseLine": { "type": "object", "additionalProperties": false, "properties": { "inventoryLotId": { "type": "string", "minLength": 1, "maxLength": 80 }, "externalLineId": { "type": "string", "maxLength": 128 }, "retailUnits": { "type": "integer", "minimum": 1, "maximum": 100000 }, "liquidMlPerRetailUnit": { "type": "string", "pattern": "^(?:0|[1-9]\\d{0,8})(?:\\.\\d{1,3})?$", "description": "Positive liquid volume in ml, at most three decimal places; verified against the product and inventory evidence." } }, "required": [ "inventoryLotId", "retailUnits", "liquidMlPerRetailUnit" ] }, "ReleaseInput": { "type": "object", "additionalProperties": false, "properties": { "externalDespatchId": { "type": "string", "minLength": 1, "maxLength": 128 }, "externalOrderId": { "type": "string", "maxLength": 128 }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 80 }, "releasedAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z." }, "releaseType": { "type": "string", "enum": [ "UK_RELEASE_FOR_CONSUMPTION" ] }, "customer": { "$ref": "#/components/schemas/ReleaseParty" }, "invoiceReference": { "type": "string", "maxLength": 128 }, "operator": { "$ref": "#/components/schemas/ReleaseOperator" }, "aggregationCodes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "maxItems": 500, "minItems": 0 }, "stampCodes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "maxItems": 5000, "minItems": 0 }, "expectedLines": { "type": "array", "items": { "$ref": "#/components/schemas/ExpectedReleaseLine" }, "maxItems": 1000, "minItems": 1 } }, "required": [ "externalDespatchId", "warehouseId", "releasedAt", "releaseType", "customer", "operator" ], "description": "Select approved inventory in one verified warehouse using at least one root/loose stamp. No unknown-code import. Expected lines assert server-resolved quantities/volumes and cannot override them. Parent+child, duplicate identities, wrong premises, already released stock and ambiguous prior-duty allocations fail atomically. The timestamp is the actual free-circulation event, not the manufacture/import date; preserve its original offset in your persisted request. Multiple partial deliveries need distinct despatch IDs." }, "ReleasePreviewLine": { "type": "object", "additionalProperties": false, "properties": { "inventoryLotId": { "type": "string", "minLength": 1, "maxLength": 80 }, "retailUnits": { "type": "integer", "minimum": 1, "maximum": 100000 }, "product": { "type": "string", "maxLength": 200 }, "liquidMlPerRetailUnit": { "type": "string", "pattern": "^(?:0|[1-9]\\d{0,5})(?:\\.\\d{1,3})?$", "description": "Positive liquid volume in ml, at most three decimal places; verified against the product and inventory evidence." }, "totalLiquidMl": { "type": "string" }, "treatment": { "type": "string", "enum": [ "NEW_RELEASE", "RELEASE_FROM_BOND", "ALREADY_ACCOUNTED" ] }, "dutyPence": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, "required": [ "inventoryLotId", "retailUnits", "product", "liquidMlPerRetailUnit", "totalLiquidMl", "treatment", "dutyPence" ] }, "ReleaseValidation": { "type": "object", "additionalProperties": false, "properties": { "eligible": { "type": "boolean", "enum": [ true ] }, "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "retailUnits": { "type": "integer", "minimum": 1, "maximum": 100000 }, "totalLiquidMl": { "type": "string" }, "newDutyPence": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/ReleasePreviewLine" }, "maxItems": 1000, "minItems": 0 }, "recorded": { "type": "boolean", "enum": [ false ] } }, "required": [ "eligible", "environment", "retailUnits", "totalLiquidMl", "newDutyPence", "lines", "recorded" ] }, "ReleaseAccounting": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "enum": [ "POSTED", "REFERENCED_PRIOR_DUTY" ] }, "newDutyPence": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "vpdOrderIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "maxItems": 1000, "minItems": 0 }, "existingDutyEntryIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "maxItems": 1000, "minItems": 0 }, "retailUnits": { "type": "integer", "minimum": 1, "maximum": 100000 }, "totalLiquidMl": { "type": "string" } }, "required": [ "status", "newDutyPence", "vpdOrderIds", "existingDutyEntryIds", "retailUnits", "totalLiquidMl" ] }, "ReleaseEvent": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "status": { "type": "string", "minLength": 1, "maxLength": 40 }, "deliveryState": { "type": "string", "minLength": 1, "maxLength": 40 }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z.", "nullable": true }, "diagnostic": { "type": "string", "maxLength": 500 } }, "required": [ "id", "status", "deliveryState", "environment", "providerConfirmed" ] }, "ReleaseNotification": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "enum": [ "CONFIRMED", "SIMULATED", "ATTENTION_REQUIRED", "QUEUED" ] }, "eventCount": { "type": "integer", "minimum": 0, "maximum": 100000 }, "confirmedEvents": { "type": "integer", "minimum": 0, "maximum": 100000 }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseEvent" }, "maxItems": 100000, "minItems": 0 } }, "required": [ "status", "eventCount", "confirmedEvents", "events" ], "description": "Inspect each event and environment. CONFIRMED can be a sandbox result; providerConfirmed and environment must both be considered. Queued/simulated/attention states never establish live provider acceptance. Duty posting does not mean duty payment." }, "ReleaseResult": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "externalDespatchId": { "type": "string", "minLength": 1, "maxLength": 128 }, "externalOrderId": { "type": "string", "maxLength": 128 }, "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "releaseStatus": { "type": "string", "enum": [ "RECORDED" ] }, "releasedAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z." }, "receivedAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z." }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 80 }, "accounting": { "$ref": "#/components/schemas/ReleaseAccounting" }, "notification": { "$ref": "#/components/schemas/ReleaseNotification" }, "lines": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "maxItems": 1000, "minItems": 0 }, "statusUrl": { "type": "string", "minLength": 1, "maxLength": 300 }, "replayed": { "type": "boolean" } }, "required": [ "id", "externalDespatchId", "environment", "releaseStatus", "accounting", "notification", "statusUrl" ] }, "ReleaseEvidence": { "type": "object", "additionalProperties": true, "description": "Owner-authorised immutable operation evidence, retained input/selection, line allocations, inventory provenance, accounting and provider events/attempts. No API keys, secret digests or provider credentials. Historical evidence; never executable input for a restore or retransmission." }, "WarehousePage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" }, "maxItems": 100, "minItems": 0 }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "InventoryManifestPage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryManifest" }, "maxItems": 50, "minItems": 0 }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "InventoryLotPage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryLot" }, "maxItems": 50, "minItems": 0 }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "ReleaseResultPage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseResult" }, "maxItems": 50, "minItems": 0 }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "PublicWarehouse": { "type": "object", "additionalProperties": false, "description": "Enabled warehouse available to this integration in its account and environment. Verification evidence and management flags are not exposed.", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "reference": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "environment": { "type": "string", "enum": [ "SIMULATION", "SANDBOX", "LIVE" ] }, "locationUrn": { "type": "string", "minLength": 1, "maxLength": 200 }, "machineUrn": { "type": "string", "minLength": 1, "maxLength": 200 }, "verifiedAt": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp with explicit timezone offset or Z." }, "holdingType": { "type": "string", "enum": [ "DUTY_SUSPENDED", "FREE_CIRCULATION" ], "nullable": true, "description": "Owner-reviewed treatment of these premises. Transfers require DUTY_SUSPENDED at both ends. Existing unclassified premises cannot be used for transfers." } }, "required": [ "id", "reference", "name", "environment", "locationUrn", "machineUrn", "verifiedAt" ] }, "PublicWarehousePage": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicWarehouse" }, "maxItems": 100, "minItems": 0 }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "IntegrationContactsController_create_Response": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "companyName": { "type": "string" }, "contactName": { "type": "string" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "regLine1": { "type": "string" }, "regLine2": { "type": "string" }, "regCity": { "type": "string" }, "regCountry": { "type": "string" }, "regPostcode": { "type": "string" }, "shipLine1": { "type": "string" }, "shipLine2": { "type": "string" }, "shipCity": { "type": "string" }, "shipCountry": { "type": "string" }, "shipPostcode": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "taxNumber": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "name", "companyName", "contactName", "isCustomer", "isSupplier", "regLine1", "regLine2", "regCity", "regCountry", "regPostcode", "shipLine1", "shipLine2", "shipCity", "shipCountry", "shipPostcode", "phone", "email", "taxNumber", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/contacts.integration.controller.ts" }, "OperationalContactsCreateContactDto": { "type": "object", "additionalProperties": false, "properties": { "contactName": { "type": "string", "minLength": 1, "maxLength": 200 }, "companyName": { "type": "string", "maxLength": 200 }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "regLine1": { "type": "string", "maxLength": 200 }, "regLine2": { "type": "string", "maxLength": 200 }, "regCity": { "type": "string", "maxLength": 120 }, "regCountry": { "type": "string", "maxLength": 120 }, "regPostcode": { "type": "string", "maxLength": 20 }, "shipLine1": { "type": "string", "maxLength": 200 }, "shipLine2": { "type": "string", "maxLength": 200 }, "shipCity": { "type": "string", "maxLength": 120 }, "shipCountry": { "type": "string", "maxLength": 120 }, "shipPostcode": { "type": "string", "maxLength": 20 }, "phone": { "type": "string", "maxLength": 120 }, "email": { "type": "string", "maxLength": 200 }, "taxNumber": { "type": "string", "maxLength": 120 }, "notes": { "type": "string", "maxLength": 2000 } }, "required": [ "contactName" ], "x-generated-from": "backend/src/contacts/dto.ts" }, "IntegrationContactsController_update_Response": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "companyName": { "type": "string" }, "contactName": { "type": "string" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "regLine1": { "type": "string" }, "regLine2": { "type": "string" }, "regCity": { "type": "string" }, "regCountry": { "type": "string" }, "regPostcode": { "type": "string" }, "shipLine1": { "type": "string" }, "shipLine2": { "type": "string" }, "shipCity": { "type": "string" }, "shipCountry": { "type": "string" }, "shipPostcode": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "taxNumber": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "name", "companyName", "contactName", "isCustomer", "isSupplier", "regLine1", "regLine2", "regCity", "regCountry", "regPostcode", "shipLine1", "shipLine2", "shipCity", "shipCountry", "shipPostcode", "phone", "email", "taxNumber", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/contacts.integration.controller.ts" }, "OperationalContactsUpdateContactDto": { "type": "object", "additionalProperties": false, "properties": { "contactName": { "type": "string", "minLength": 1, "maxLength": 200 }, "companyName": { "type": "string", "maxLength": 200 }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "regLine1": { "type": "string", "maxLength": 200 }, "regLine2": { "type": "string", "maxLength": 200 }, "regCity": { "type": "string", "maxLength": 120 }, "regCountry": { "type": "string", "maxLength": 120 }, "regPostcode": { "type": "string", "maxLength": 20 }, "shipLine1": { "type": "string", "maxLength": 200 }, "shipLine2": { "type": "string", "maxLength": 200 }, "shipCity": { "type": "string", "maxLength": 120 }, "shipCountry": { "type": "string", "maxLength": 120 }, "shipPostcode": { "type": "string", "maxLength": 20 }, "phone": { "type": "string", "maxLength": 120 }, "email": { "type": "string", "maxLength": 200 }, "taxNumber": { "type": "string", "maxLength": 120 }, "notes": { "type": "string", "maxLength": 2000 } }, "x-generated-from": "backend/src/contacts/dto.ts" }, "IntegrationContactsController_remove_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/contacts.integration.controller.ts" }, "IntegrationInventoryOperationsController_units_Response": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "stampCode": { "type": "string" }, "status": { "type": "string", "enum": [ "SCANNED", "ACTIVATED", "AGGREGATED", "SHIPPED", "RECEIVED", "RELEASED", "DESTROYED" ], "nullable": true }, "inventoryLotId": { "type": "string" }, "product": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sku": { "type": "string" }, "liquidMlPerRetailUnit": { "type": "string" } }, "required": [ "id", "name", "sku", "liquidMlPerRetailUnit" ], "additionalProperties": false }, "barcodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string" }, "unitsPerPack": { "type": "number" }, "containsBarcodeId": { "type": "string", "nullable": true }, "containsQty": { "type": "number", "nullable": true } }, "required": [ "id", "code", "level", "unitsPerPack", "containsBarcodeId", "containsQty" ], "additionalProperties": false } }, "batch": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "expiryDate": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "productionNumber": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "warehouseId": { "type": "string" }, "treatment": { "type": "string" }, "availability": { "type": "string" }, "orderAllocationId": { "type": "string", "nullable": true }, "externalOrderId": { "type": "string", "nullable": true }, "aggregation": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "parentId": { "type": "string", "nullable": true } }, "required": [ "id", "code", "parentId" ], "additionalProperties": false, "nullable": true } }, "required": [ "id", "stampCode", "status", "inventoryLotId", "product", "barcodes", "batch", "expiryDate", "productionNumber", "warehouseId", "treatment", "availability", "orderAllocationId", "externalOrderId", "aggregation" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "OperationalDeveloperInventoryLookupDto": { "type": "object", "additionalProperties": false, "properties": { "cursor": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" }, "sku": { "type": "string", "maxLength": 80 }, "barcode": { "type": "string", "maxLength": 64 }, "batch": { "type": "string", "maxLength": 80 }, "productionNumber": { "type": "string", "maxLength": 128 }, "warehouseId": { "type": "string", "maxLength": 80 }, "inventoryLotId": { "type": "string", "maxLength": 80 }, "aggregationCode": { "type": "string", "maxLength": 200 }, "stampCode": { "type": "string", "maxLength": 128 }, "availability": { "type": "string", "enum": [ "AVAILABLE", "RESERVED", "RELEASED" ] } }, "x-generated-from": "backend/src/developer/dto-inventory-operations.ts" }, "IntegrationInventoryOperationsController_lots_Response": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string" }, "productName": { "type": "string" }, "liquidMlPerRetailUnit": { "type": "string" }, "openingWarehouseId": { "type": "string" }, "quantity": { "type": "number" }, "remainingQuantity": { "type": "number" }, "treatment": { "type": "string" }, "origin": { "type": "string" }, "metadata": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ] } }, "required": [ "id", "productId", "productName", "liquidMlPerRetailUnit", "openingWarehouseId", "quantity", "remainingQuantity", "treatment", "origin", "metadata" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "IntegrationInventoryOperationsController_scans_Response": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "inventoryApproved": { "type": "boolean" }, "inventoryLotId": { "type": "string", "nullable": true }, "releaseEligibility": { "type": "string" }, "activatedAt": { "type": "string", "nullable": true }, "product": { "type": "object", "properties": {}, "additionalProperties": true, "nullable": true }, "sku": { "type": "string", "nullable": true }, "barcode": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string" }, "unitsPerPack": { "type": "number" } }, "required": [ "id", "code", "level", "unitsPerPack" ], "additionalProperties": false, "nullable": true }, "batch": { "type": "string", "nullable": true }, "expiryDate": { "type": "string", "nullable": true }, "productionNumber": { "type": "string", "nullable": true }, "metadataSource": { "type": "string" }, "id": { "type": "string" }, "stampCode": { "type": "string" }, "status": { "type": "string", "enum": [ "SCANNED", "ACTIVATED", "AGGREGATED", "SHIPPED", "RECEIVED", "RELEASED", "DESTROYED" ] }, "stampOrderId": { "type": "string", "nullable": true }, "aggregation": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "parentId": { "type": "string", "nullable": true } }, "required": [ "id", "code", "parentId" ], "additionalProperties": false, "nullable": true } }, "required": [ "inventoryApproved", "inventoryLotId", "releaseEligibility", "activatedAt", "product", "sku", "barcode", "batch", "expiryDate", "productionNumber", "metadataSource", "id", "stampCode", "status", "stampOrderId", "aggregation" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "IntegrationInventoryOperationsController_aggregations_Response": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "releaseEligibility": { "type": "string" }, "product": { "type": "object", "properties": {}, "additionalProperties": true, "nullable": true }, "sku": { "type": "string", "nullable": true }, "barcode": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string" }, "unitsPerPack": { "type": "number" } }, "required": [ "id", "code", "level", "unitsPerPack" ], "additionalProperties": false, "nullable": true }, "batch": { "type": "string", "nullable": true }, "expiryDate": { "type": "string", "nullable": true }, "productionNumber": { "type": "string", "nullable": true }, "metadataSource": { "type": "string", "nullable": true }, "id": { "type": "string" }, "code": { "type": "string" }, "urn": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "SHIPPED", "RECEIVED", "RELEASED", "CLOSED", "DISAGGREGATED" ] }, "parentId": { "type": "string", "nullable": true }, "childCount": { "type": "number" }, "recordedStampCount": { "type": "number" }, "contentsKnown": { "type": "boolean" } }, "required": [ "releaseEligibility", "id", "code", "urn", "status", "parentId", "childCount", "recordedStampCount", "contentsKnown" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "IntegrationInventoryOperationsController_transfer_Response": { "type": "object", "properties": { "replayed": { "type": "boolean" }, "createdAt": { "type": "string" }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalTransferId": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "fromWarehouseId": { "type": "string" }, "toWarehouseId": { "type": "string" }, "occurredAt": { "type": "string" }, "retailUnits": { "type": "number" }, "accounting": { "type": "object", "properties": { "status": { "type": "string" }, "newDutyPence": { "type": "number" } }, "required": [ "status", "newDutyPence" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false } }, "required": [ "replayed", "createdAt", "id", "externalTransferId", "environment", "status", "fromWarehouseId", "toWarehouseId", "occurredAt", "retailUnits", "accounting", "notification" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "OperationalDeveloperInventoryTransferDto": { "type": "object", "additionalProperties": false, "properties": { "aggregationCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 500 }, "stampCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 5000 }, "externalTransferId": { "type": "string", "minLength": 1, "maxLength": 128 }, "fromWarehouseId": { "type": "string", "minLength": 1, "maxLength": 80 }, "toWarehouseId": { "type": "string", "minLength": 1, "maxLength": 80 }, "movementType": { "type": "string", "enum": [ "DUTY_SUSPENDED_TRANSFER" ] }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "T.*(?:Z|[+-]\\d{2}:\\d{2})$" }, "custodyEvidence": { "type": "string", "minLength": 10, "maxLength": 2000 }, "authorityEvidence": { "type": "string", "minLength": 10, "maxLength": 2000 } }, "required": [ "externalTransferId", "fromWarehouseId", "toWarehouseId", "movementType", "occurredAt", "custodyEvidence", "authorityEvidence" ], "x-generated-from": "backend/src/developer/dto-inventory-operations.ts" }, "OperationalDeveloperExactSelectionDto": { "type": "object", "additionalProperties": false, "properties": { "aggregationCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 500 }, "stampCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 5000 } }, "x-generated-from": "backend/src/developer/dto-inventory-operations.ts" }, "IntegrationInventoryOperationsController_transfers_Response": { "oneOf": [ { "type": "object", "properties": { "createdAt": { "type": "string" }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalTransferId": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "fromWarehouseId": { "type": "string" }, "toWarehouseId": { "type": "string" }, "occurredAt": { "type": "string" }, "retailUnits": { "type": "number" }, "accounting": { "type": "object", "properties": { "status": { "type": "string" }, "newDutyPence": { "type": "number" } }, "required": [ "status", "newDutyPence" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false } }, "required": [ "createdAt", "id", "externalTransferId", "environment", "status", "fromWarehouseId", "toWarehouseId", "occurredAt", "retailUnits", "accounting", "notification" ], "additionalProperties": false }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string" }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalTransferId": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "fromWarehouseId": { "type": "string" }, "toWarehouseId": { "type": "string" }, "occurredAt": { "type": "string" }, "retailUnits": { "type": "number" }, "accounting": { "type": "object", "properties": { "status": { "type": "string" }, "newDutyPence": { "type": "number" } }, "required": [ "status", "newDutyPence" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false } }, "required": [ "createdAt", "id", "externalTransferId", "environment", "status", "fromWarehouseId", "toWarehouseId", "occurredAt", "retailUnits", "accounting", "notification" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ], "additionalProperties": false } ], "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "OperationalDeveloperOperationListDto": { "type": "object", "additionalProperties": false, "properties": { "cursor": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" }, "externalOrderId": { "type": "string", "maxLength": 128 }, "externalAllocationId": { "type": "string", "maxLength": 128 }, "externalTransferId": { "type": "string", "maxLength": 128 } }, "x-generated-from": "backend/src/developer/dto-inventory-operations.ts" }, "IntegrationInventoryOperationsController_transferDetail_Response": { "oneOf": [ { "type": "object", "properties": { "createdAt": { "type": "string" }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalTransferId": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "fromWarehouseId": { "type": "string" }, "toWarehouseId": { "type": "string" }, "occurredAt": { "type": "string" }, "retailUnits": { "type": "number" }, "accounting": { "type": "object", "properties": { "status": { "type": "string" }, "newDutyPence": { "type": "number" } }, "required": [ "status", "newDutyPence" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false } }, "required": [ "createdAt", "id", "externalTransferId", "environment", "status", "fromWarehouseId", "toWarehouseId", "occurredAt", "retailUnits", "accounting", "notification" ], "additionalProperties": false }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string" }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalTransferId": { "type": "string" }, "environment": { "type": "string" }, "status": { "type": "string" }, "fromWarehouseId": { "type": "string" }, "toWarehouseId": { "type": "string" }, "occurredAt": { "type": "string" }, "retailUnits": { "type": "number" }, "accounting": { "type": "object", "properties": { "status": { "type": "string" }, "newDutyPence": { "type": "number" } }, "required": [ "status", "newDutyPence" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false } }, "required": [ "createdAt", "id", "externalTransferId", "environment", "status", "fromWarehouseId", "toWarehouseId", "occurredAt", "retailUnits", "accounting", "notification" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ], "additionalProperties": false } ], "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "IntegrationInventoryOperationsController_reserve_Response": { "type": "object", "properties": { "replayed": { "type": "boolean" }, "createdAt": { "type": "string" }, "cancelledAt": { "type": "string", "nullable": true }, "cancellationReason": { "type": "string", "nullable": true }, "accounting": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalAllocationId": { "type": "string" }, "externalOrderId": { "type": "string" }, "environment": { "type": "string" }, "warehouseId": { "type": "string" }, "status": { "type": "string" }, "retailUnits": { "type": "number" }, "reservedUnits": { "type": "number" }, "releasedUnits": { "type": "number" }, "cancelledUnits": { "type": "number" } }, "required": [ "replayed", "createdAt", "cancelledAt", "cancellationReason", "accounting", "notification", "id", "externalAllocationId", "externalOrderId", "environment", "warehouseId", "status", "retailUnits", "reservedUnits", "releasedUnits", "cancelledUnits" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "OperationalDeveloperReserveOrderDto": { "type": "object", "additionalProperties": false, "properties": { "aggregationCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 500 }, "stampCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 5000 }, "externalAllocationId": { "type": "string", "minLength": 1, "maxLength": 128 }, "externalOrderId": { "type": "string", "minLength": 1, "maxLength": 128 }, "warehouseId": { "type": "string", "minLength": 1, "maxLength": 80 } }, "required": [ "externalAllocationId", "externalOrderId", "warehouseId" ], "x-generated-from": "backend/src/developer/dto-inventory-operations.ts" }, "IntegrationInventoryOperationsController_allocations_Response": { "oneOf": [ { "type": "object", "properties": { "createdAt": { "type": "string" }, "cancelledAt": { "type": "string", "nullable": true }, "cancellationReason": { "type": "string", "nullable": true }, "accounting": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalAllocationId": { "type": "string" }, "externalOrderId": { "type": "string" }, "environment": { "type": "string" }, "warehouseId": { "type": "string" }, "status": { "type": "string" }, "retailUnits": { "type": "number" }, "reservedUnits": { "type": "number" }, "releasedUnits": { "type": "number" }, "cancelledUnits": { "type": "number" } }, "required": [ "createdAt", "cancelledAt", "cancellationReason", "accounting", "notification", "id", "externalAllocationId", "externalOrderId", "environment", "warehouseId", "status", "retailUnits", "reservedUnits", "releasedUnits", "cancelledUnits" ], "additionalProperties": false }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string" }, "cancelledAt": { "type": "string", "nullable": true }, "cancellationReason": { "type": "string", "nullable": true }, "accounting": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalAllocationId": { "type": "string" }, "externalOrderId": { "type": "string" }, "environment": { "type": "string" }, "warehouseId": { "type": "string" }, "status": { "type": "string" }, "retailUnits": { "type": "number" }, "reservedUnits": { "type": "number" }, "releasedUnits": { "type": "number" }, "cancelledUnits": { "type": "number" } }, "required": [ "createdAt", "cancelledAt", "cancellationReason", "accounting", "notification", "id", "externalAllocationId", "externalOrderId", "environment", "warehouseId", "status", "retailUnits", "reservedUnits", "releasedUnits", "cancelledUnits" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ], "additionalProperties": false } ], "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "IntegrationInventoryOperationsController_allocation_Response": { "oneOf": [ { "type": "object", "properties": { "createdAt": { "type": "string" }, "cancelledAt": { "type": "string", "nullable": true }, "cancellationReason": { "type": "string", "nullable": true }, "accounting": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalAllocationId": { "type": "string" }, "externalOrderId": { "type": "string" }, "environment": { "type": "string" }, "warehouseId": { "type": "string" }, "status": { "type": "string" }, "retailUnits": { "type": "number" }, "reservedUnits": { "type": "number" }, "releasedUnits": { "type": "number" }, "cancelledUnits": { "type": "number" } }, "required": [ "createdAt", "cancelledAt", "cancellationReason", "accounting", "notification", "id", "externalAllocationId", "externalOrderId", "environment", "warehouseId", "status", "retailUnits", "reservedUnits", "releasedUnits", "cancelledUnits" ], "additionalProperties": false }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string" }, "cancelledAt": { "type": "string", "nullable": true }, "cancellationReason": { "type": "string", "nullable": true }, "accounting": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalAllocationId": { "type": "string" }, "externalOrderId": { "type": "string" }, "environment": { "type": "string" }, "warehouseId": { "type": "string" }, "status": { "type": "string" }, "retailUnits": { "type": "number" }, "reservedUnits": { "type": "number" }, "releasedUnits": { "type": "number" }, "cancelledUnits": { "type": "number" } }, "required": [ "createdAt", "cancelledAt", "cancellationReason", "accounting", "notification", "id", "externalAllocationId", "externalOrderId", "environment", "warehouseId", "status", "retailUnits", "reservedUnits", "releasedUnits", "cancelledUnits" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ], "additionalProperties": false } ], "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "IntegrationInventoryOperationsController_cancel_Response": { "type": "object", "properties": { "replayed": { "type": "boolean" }, "createdAt": { "type": "string" }, "cancelledAt": { "type": "string", "nullable": true }, "cancellationReason": { "type": "string", "nullable": true }, "accounting": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalAllocationId": { "type": "string" }, "externalOrderId": { "type": "string" }, "environment": { "type": "string" }, "warehouseId": { "type": "string" }, "status": { "type": "string" }, "retailUnits": { "type": "number" }, "reservedUnits": { "type": "number" }, "releasedUnits": { "type": "number" }, "cancelledUnits": { "type": "number" } }, "required": [ "replayed", "createdAt", "cancelledAt", "cancellationReason", "accounting", "notification", "id", "externalAllocationId", "externalOrderId", "environment", "warehouseId", "status", "retailUnits", "reservedUnits", "releasedUnits", "cancelledUnits" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "OperationalDeveloperCancelOrderAllocationDto": { "type": "object", "additionalProperties": false, "properties": { "reason": { "type": "string", "minLength": 10, "maxLength": 2000 } }, "required": [ "reason" ], "x-generated-from": "backend/src/developer/dto-inventory-operations.ts" }, "DeveloperOrderAllocationController_cancel_Response": { "type": "object", "properties": { "replayed": { "type": "boolean" }, "createdAt": { "type": "string" }, "cancelledAt": { "type": "string", "nullable": true }, "cancellationReason": { "type": "string", "nullable": true }, "accounting": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ], "additionalProperties": false }, "notification": { "type": "object", "properties": { "status": { "type": "string" }, "providerConfirmed": { "type": "boolean" } }, "required": [ "status", "providerConfirmed" ], "additionalProperties": false }, "selection": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "externalAllocationId": { "type": "string" }, "externalOrderId": { "type": "string" }, "environment": { "type": "string" }, "warehouseId": { "type": "string" }, "status": { "type": "string" }, "retailUnits": { "type": "number" }, "reservedUnits": { "type": "number" }, "releasedUnits": { "type": "number" }, "cancelledUnits": { "type": "number" } }, "required": [ "replayed", "createdAt", "cancelledAt", "cancellationReason", "accounting", "notification", "id", "externalAllocationId", "externalOrderId", "environment", "warehouseId", "status", "retailUnits", "reservedUnits", "releasedUnits", "cancelledUnits" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/inventory-operations.controller.ts" }, "IntegrationOperationalReadController_catalogue_Response": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "sku": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "ecid": { "type": "string" }, "manufacturerId": { "type": "string", "nullable": true }, "notes": { "type": "string" }, "recipe": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide.", "nullable": true }, "barcodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string", "enum": [ "ITEM", "PACK", "CASE", "MASTER", "PALLET" ] }, "label": { "type": "string" }, "unitsPerPack": { "type": "integer" }, "containsQty": { "type": "integer", "nullable": true }, "containsBarcodeId": { "type": "string", "nullable": true } }, "additionalProperties": false } } }, "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true, "description": "Pass as cursor for the next page. null means no further page." } }, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "OperationalDeveloperOperationalQuery": { "type": "object", "additionalProperties": false, "properties": { "cursor": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "sku": { "type": "string", "maxLength": 160 }, "barcode": { "type": "string", "maxLength": 160 }, "batch": { "type": "string", "maxLength": 160 }, "productionNumber": { "type": "string", "maxLength": 160 } }, "x-generated-from": "backend/src/developer/operational-dto.ts" }, "IntegrationOperationalReadController_product_Response": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "sku": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "ecid": { "type": "string" }, "manufacturerId": { "type": "string", "nullable": true }, "notes": { "type": "string" }, "recipe": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide.", "nullable": true }, "barcodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string", "enum": [ "ITEM", "PACK", "CASE", "MASTER", "PALLET" ] }, "label": { "type": "string" }, "unitsPerPack": { "type": "integer" }, "containsQty": { "type": "integer", "nullable": true }, "containsBarcodeId": { "type": "string", "nullable": true } }, "additionalProperties": false } } }, "additionalProperties": false, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_productionOrders_Response": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "client": { "type": "string" }, "product": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "batch": { "type": "string" }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "enum": [ "PLANNED", "IN_PROGRESS", "COMPLETE" ] }, "notes": { "type": "string" }, "planned": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide." }, "actual": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide.", "nullable": true }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true, "description": "Pass as cursor for the next page. null means no further page." } }, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_production_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "client": { "type": "string" }, "product": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "batch": { "type": "string" }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "enum": [ "PLANNED", "IN_PROGRESS", "COMPLETE" ] }, "notes": { "type": "string" }, "planned": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide." }, "actual": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide.", "nullable": true }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_purchaseOrders_Response": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "supplier": { "type": "string" }, "status": { "type": "string", "description": "Purchase order lifecycle status." }, "notes": { "type": "string" }, "lines": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide." }, "currency": { "type": "string" }, "deliveryCharge": { "type": "number" }, "value": { "type": "number" }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true, "description": "Pass as cursor for the next page. null means no further page." } }, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_purchase_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "supplier": { "type": "string" }, "status": { "type": "string", "description": "Purchase order lifecycle status." }, "notes": { "type": "string" }, "lines": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide." }, "currency": { "type": "string" }, "deliveryCharge": { "type": "number" }, "value": { "type": "number" }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_contacts_Response": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "name": { "type": "string" }, "companyName": { "type": "string" }, "contactName": { "type": "string" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "regLine1": { "type": "string" }, "regLine2": { "type": "string" }, "regCity": { "type": "string" }, "regCountry": { "type": "string" }, "regPostcode": { "type": "string" }, "shipLine1": { "type": "string" }, "shipLine2": { "type": "string" }, "shipCity": { "type": "string" }, "shipCountry": { "type": "string" }, "shipPostcode": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "taxNumber": { "type": "string" }, "notes": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true, "description": "Pass as cursor for the next page. null means no further page." } }, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_contact_Response": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "companyName": { "type": "string" }, "contactName": { "type": "string" }, "isCustomer": { "type": "boolean" }, "isSupplier": { "type": "boolean" }, "regLine1": { "type": "string" }, "regLine2": { "type": "string" }, "regCity": { "type": "string" }, "regCountry": { "type": "string" }, "regPostcode": { "type": "string" }, "shipLine1": { "type": "string" }, "shipLine2": { "type": "string" }, "shipCity": { "type": "string" }, "shipCountry": { "type": "string" }, "shipPostcode": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "taxNumber": { "type": "string" }, "notes": { "type": "string" } }, "additionalProperties": false, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_stock_Response": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "type": { "type": "string" }, "qtyMl": { "type": "number" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "nicType": { "type": "string" }, "concentration": { "type": "number" }, "qtyMl": { "type": "number" }, "unit": { "type": "string" }, "supplier": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "nicType": { "type": "string" }, "concentration": { "type": "number" }, "qtyMl": { "type": "number" }, "unit": { "type": "string" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "form": { "type": "string" }, "strength": { "type": "number" }, "unit": { "type": "string" }, "qty": { "type": "number" }, "supplier": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "form": { "type": "string" }, "strength": { "type": "number" }, "unit": { "type": "string" }, "qty": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "powderG": { "type": "number" }, "liquidMl": { "type": "number" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "kind": { "type": "string" }, "qtyG": { "type": "number" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "supplier": { "type": "string" }, "stockMl": { "type": "number" }, "allocationZone": { "type": "string" }, "notes": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "code": { "type": "string" }, "name": { "type": "string" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "pricePerUnit": { "type": "number", "nullable": true }, "priceUnit": { "type": "string" }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "sku": { "type": "string" }, "flavour": { "type": "string" }, "strength": { "type": "string" }, "qty": { "type": "integer" }, "notes": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "sku": { "type": "string" }, "flavour": { "type": "string" }, "strength": { "type": "string" }, "qty": { "type": "integer" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "pricePerLabel": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "sizeMl": { "type": "integer" }, "qty": { "type": "integer" }, "notes": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "sizeMl": { "type": "integer" }, "qty": { "type": "integer" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "pricePerBottle": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } ] } }, "nextCursor": { "type": "string", "nullable": true, "description": "Pass as cursor for the next page. null means no further page." } }, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_stampOrders_Response": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "mfg": { "type": "string" }, "party": { "type": "string" }, "stockKey": { "type": "string" }, "qty": { "type": "integer" }, "ref": { "type": "string" }, "notes": { "type": "string" }, "status": { "type": "string", "enum": [ "STAMP_ACTIVATED", "PRODUCT_DUTY_SUSPENDED", "PRODUCT_IN_FREE_ZONE", "PRODUCT_SHIPPED" ] }, "customer": { "type": "string" }, "shippingAddress": { "type": "string" }, "stage": { "type": "string", "enum": [ "IN_PRODUCTION", "STAMPS_ORDERED", "STAMPS_RECEIVED", "STAMPS_ACTIVATED", "SHIPPED", "RECEIVED" ] }, "stageData": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide." }, "items": { "description": "Stored domain JSON; planned/actual/recipe shapes are described in the workflow guide." }, "stockLocation": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true, "description": "Pass as cursor for the next page. null means no further page." } }, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationOperationalReadController_manufacturers_Response": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "country": { "type": "string" }, "contact": { "type": "string" }, "keyPerson": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true, "description": "Pass as cursor for the next page. null means no further page." } }, "x-generated-from": "backend/src/developer/operational-read.controller.ts" }, "IntegrationProductionOrdersController_create_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "client": { "type": "string" }, "product": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "batch": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true }, "status": { "type": "string" }, "notes": { "type": "string" }, "planned": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "actual": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "client", "product", "productId", "sku", "batch", "expiryDate", "status", "notes", "planned", "actual", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "OperationalProductionordersCreateProductionOrderDto": { "type": "object", "additionalProperties": false, "properties": { "client": { "type": "string", "maxLength": 200 }, "product": { "type": "string", "maxLength": 200 }, "sku": { "type": "string", "maxLength": 120 }, "notes": { "type": "string", "maxLength": 2000 }, "planned": { "type": "object", "additionalProperties": true }, "batch": { "type": "string", "maxLength": 80, "description": "the manufacturer's own batch / lot number (blank = the order code stands in)" }, "expiryDate": { "type": "string", "nullable": true, "description": "product expiry for this batch - ISO or dd/mm/yyyy; '' / null clears it" }, "productId": { "type": "string", "nullable": true, "maxLength": 60, "description": "optional: the catalogue product (Products & Barcodes) this run makes" } }, "x-generated-from": "backend/src/production-orders/dto.ts", "description": "Planned figures arrive as a JSON object mirroring the prototype's shape.\r\nNumeric fields are coerced with parseFloat/parseInt-style \"|| 0\" semantics\r\nin the service, so we accept them loosely here (@Allow keeps them past the\r\nwhitelist without imposing a type the prototype never enforced)." }, "IntegrationProductionOrdersController_importMany_Response": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "properties": { "row": { "type": "number" }, "id": { "type": "string" }, "code": { "type": "string" } }, "required": [ "row", "id", "code" ], "additionalProperties": false } } }, "required": [ "created" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "OperationalProductionordersImportProductionOrdersDto": { "type": "object", "additionalProperties": false, "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalProductionordersCreateProductionOrderDto" }, "minItems": 1, "maxItems": 200 } }, "required": [ "orders" ], "x-generated-from": "backend/src/production-orders/dto.ts", "description": "Several orders at once - the rows of an uploaded Excel / CSV file." }, "IntegrationProductionOrdersController_update_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "client": { "type": "string" }, "product": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "batch": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true }, "status": { "type": "string" }, "notes": { "type": "string" }, "planned": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "actual": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "client", "product", "productId", "sku", "batch", "expiryDate", "status", "notes", "planned", "actual", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "OperationalProductionordersUpdateProductionOrderDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string", "description": "ISO or dd/mm/yyyy - parsed with parseDateInput." }, "client": { "type": "string", "maxLength": 200 }, "product": { "type": "string", "maxLength": 200 }, "sku": { "type": "string", "maxLength": 120 }, "notes": { "type": "string", "maxLength": 2000 }, "batch": { "type": "string", "maxLength": 80 }, "expiryDate": { "type": "string", "nullable": true, "description": "'' / null clears it" }, "productId": { "type": "string", "nullable": true, "maxLength": 60, "description": "catalogue product link; null clears it" }, "bottlesPlanned": {}, "pgPlanned": {}, "vgPlanned": {}, "nicPlanned": {}, "flavPlanned": {}, "cbdPlanned": {}, "labelsPlanned": {}, "stampsPlanned": {}, "unitsPerCase": { "description": "items per case; the packing windows enforce it (0 clears)" }, "nicType": {}, "nicConc": {}, "nicUnit": {}, "flavCode": {}, "flavourings": { "description": "several flavourings: [{ code, ml }] - replaces flavCode/flavPlanned when sent" }, "cbdForm": {}, "cbdStrength": {}, "cbdUnit": {}, "labelSku": {} }, "x-generated-from": "backend/src/production-orders/dto.ts" }, "IntegrationProductionOrdersController_start_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "client": { "type": "string" }, "product": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "batch": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true }, "status": { "type": "string" }, "notes": { "type": "string" }, "planned": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "actual": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "client", "product", "productId", "sku", "batch", "expiryDate", "status", "notes", "planned", "actual", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "IntegrationProductionOrdersController_complete_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "client": { "type": "string" }, "product": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "batch": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true }, "status": { "type": "string" }, "notes": { "type": "string" }, "planned": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "actual": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "client", "product", "productId", "sku", "batch", "expiryDate", "status", "notes", "planned", "actual", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "OperationalProductionordersCompleteProductionOrderDto": { "type": "object", "additionalProperties": false, "properties": { "bottlesActual": {}, "pgActual": {}, "vgActual": {}, "nicActual": {}, "flavActual": {}, "flavourings": { "description": "per-flavouring actuals [{ code, ml }] when the order uses several" }, "cbdActual": {}, "labelsActual": {}, "stampsActual": {}, "varianceNote": { "type": "string", "maxLength": 2000 } }, "x-generated-from": "backend/src/production-orders/dto.ts" }, "IntegrationProductionOrdersController_saveActuals_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "client": { "type": "string" }, "product": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "batch": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true }, "status": { "type": "string" }, "notes": { "type": "string" }, "planned": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "actual": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "client", "product", "productId", "sku", "batch", "expiryDate", "status", "notes", "planned", "actual", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "IntegrationProductionOrdersController_remove_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "IntegrationProductionOrdersController_uploadInvoice_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "client": { "type": "string" }, "product": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "batch": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true }, "status": { "type": "string" }, "notes": { "type": "string" }, "planned": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "actual": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "client", "product", "productId", "sku", "batch", "expiryDate", "status", "notes", "planned", "actual", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "OperationalProductionordersInvoiceUploadDto": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 200 }, "type": { "type": "string", "maxLength": 120 }, "dataBase64": { "type": "string" } }, "x-generated-from": "backend/src/production-orders/dto.ts" }, "IntegrationProductionOrdersController_downloadInvoice_Response": { "type": "object", "properties": {}, "additionalProperties": true, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "IntegrationProductionOrdersController_deleteInvoice_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/production-orders.integration.controller.ts" }, "IntegrationProductsController_lookup_Response": { "oneOf": [ { "type": "object", "properties": { "found": { "type": "boolean" }, "code": { "type": "string" }, "barcode": { "type": "object", "properties": {}, "additionalProperties": true }, "product": { "type": "object", "properties": {}, "additionalProperties": true } }, "required": [ "found", "code" ], "additionalProperties": false }, { "type": "object", "properties": { "found": { "type": "boolean" }, "code": { "type": "string" }, "barcode": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" }, "containsQty": { "type": "number", "nullable": true }, "containsBarcodeId": { "type": "string", "nullable": true }, "containsCode": { "type": "string", "nullable": true }, "containsLabel": { "type": "string", "nullable": true }, "kind": { "type": "string", "enum": [ "EAN-8", "UPC-A", "EAN-13", "GTIN-14", "OTHER" ] }, "checkOk": { "type": "boolean", "nullable": true }, "casesPacked": { "type": "number" }, "casesReceived": { "type": "number" }, "unitsPacked": { "type": "number" }, "unitsReceived": { "type": "number" }, "createdAt": { "type": "string" } }, "required": [ "id", "productId", "code", "level", "label", "unitsPerPack", "containsQty", "containsBarcodeId", "containsCode", "containsLabel", "kind", "checkOk", "casesPacked", "casesReceived", "unitsPacked", "unitsReceived", "createdAt" ], "additionalProperties": false }, "product": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "sku": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "ecid": { "type": "string" } }, "required": [ "id", "name", "brand", "sku", "volumeMl", "ecid" ], "additionalProperties": false } }, "required": [ "found", "code", "barcode", "product" ], "additionalProperties": false } ], "x-generated-from": "backend/src/developer/products.integration.controller.ts" }, "IntegrationProductsController_create_Response": { "type": "object", "properties": { "barcodes": { "type": "array", "items": { "type": "object", "properties": { "casesPacked": { "type": "number" }, "casesReceived": { "type": "number" }, "unitsPacked": { "type": "number" }, "unitsReceived": { "type": "number" }, "id": { "type": "string" }, "productId": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" }, "containsQty": { "type": "number", "nullable": true }, "containsBarcodeId": { "type": "string", "nullable": true }, "containsCode": { "type": "string", "nullable": true }, "containsLabel": { "type": "string", "nullable": true }, "kind": { "type": "string", "enum": [ "EAN-8", "UPC-A", "EAN-13", "GTIN-14", "OTHER" ] }, "checkOk": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string" } }, "required": [ "casesPacked", "casesReceived", "unitsPacked", "unitsReceived", "id", "productId", "code", "level", "label", "unitsPerPack", "containsQty", "containsBarcodeId", "containsCode", "containsLabel", "kind", "checkOk", "createdAt" ], "additionalProperties": false } }, "casesPacked": { "type": "number" }, "casesReceived": { "type": "number" }, "unitsPacked": { "type": "number" }, "unitsReceived": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "sku": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "ecid": { "type": "string" }, "notes": { "type": "string" }, "recipe": { "type": "object", "properties": { "pgMl": { "type": "number" }, "vgMl": { "type": "number" }, "nicType": { "type": "string" }, "nicConc": { "type": "string" }, "nicUnit": { "type": "string", "enum": [ "g", "kg", "ml" ] }, "nicMl": { "type": "number" }, "flavourings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "ml": { "type": "number" } }, "required": [ "code", "ml" ], "additionalProperties": false } }, "cbdForm": { "type": "string" }, "cbdStrength": { "type": "string" }, "cbdUnit": { "type": "string", "enum": [ "", "g", "ml" ] }, "cbdQty": { "type": "number" }, "labelSku": { "type": "string" } }, "required": [ "pgMl", "vgMl", "nicType", "nicConc", "nicUnit", "nicMl", "flavourings", "cbdForm", "cbdStrength", "cbdUnit", "cbdQty", "labelSku" ], "additionalProperties": false, "nullable": true }, "manufacturerId": { "type": "string", "nullable": true }, "manufacturerName": { "type": "string", "nullable": true }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "barcodes", "casesPacked", "casesReceived", "unitsPacked", "unitsReceived", "id", "name", "brand", "sku", "volumeMl", "ecid", "notes", "recipe", "manufacturerId", "manufacturerName", "createdBy", "createdAt", "updatedAt" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/products.integration.controller.ts" }, "OperationalProductsCreateProductDto": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "brand": { "type": "string", "maxLength": 80 }, "sku": { "type": "string", "maxLength": 80 }, "volumeMl": { "type": "number", "minimum": 0, "maximum": 100000 }, "ecid": { "type": "string", "maxLength": 60 }, "notes": { "type": "string", "maxLength": 2000 }, "manufacturerId": { "type": "string", "nullable": true, "maxLength": 60, "description": "one of the account's manufacturers; omit / null = made by us" }, "recipe": { "type": "object", "additionalProperties": true, "nullable": true, "description": "ingredients of one bottle (see ProductsService.cleanRecipe); null clears" }, "barcodes": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalProductsBarcodeDto" }, "maxItems": 20 } }, "required": [ "name" ], "x-generated-from": "backend/src/products/dto.ts" }, "OperationalProductsBarcodeDto": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 80 }, "level": { "type": "string", "enum": [ "ITEM", "PACK", "CASE", "MASTER", "PALLET" ] }, "label": { "type": "string", "maxLength": 60 }, "unitsPerPack": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "containsQty": { "type": "integer", "nullable": true, "minimum": 2, "maximum": 1000000, "description": "Packing structure: this layer holds `containsQty` of the barcode `containsCode`\r\n(another barcode of the same product). Units are then worked out for you." }, "containsCode": { "type": "string", "nullable": true, "maxLength": 80 } }, "required": [ "code" ], "x-generated-from": "backend/src/products/dto.ts", "description": "One barcode = one pack level of a product (single item, pack of 5, case…)." }, "IntegrationProductsController_updateBarcode_Response": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" }, "containsQty": { "type": "number", "nullable": true }, "containsBarcodeId": { "type": "string", "nullable": true }, "containsCode": { "type": "string", "nullable": true }, "containsLabel": { "type": "string", "nullable": true }, "kind": { "type": "string", "enum": [ "EAN-8", "UPC-A", "EAN-13", "GTIN-14", "OTHER" ] }, "checkOk": { "type": "boolean", "nullable": true }, "casesPacked": { "type": "number" }, "casesReceived": { "type": "number" }, "unitsPacked": { "type": "number" }, "unitsReceived": { "type": "number" }, "createdAt": { "type": "string" } }, "required": [ "id", "productId", "code", "level", "label", "unitsPerPack", "containsQty", "containsBarcodeId", "containsCode", "containsLabel", "kind", "checkOk", "casesPacked", "casesReceived", "unitsPacked", "unitsReceived", "createdAt" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/products.integration.controller.ts" }, "OperationalProductsUpdateBarcodeDto": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 80 }, "level": { "type": "string", "enum": [ "ITEM", "PACK", "CASE", "MASTER", "PALLET" ] }, "label": { "type": "string", "maxLength": 60 }, "unitsPerPack": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "containsQty": { "type": "integer", "nullable": true, "minimum": 2, "maximum": 1000000, "description": "null / '' on containsCode clears the structure link (layer holds loose items)" }, "containsCode": { "type": "string", "nullable": true, "maxLength": 80 } }, "x-generated-from": "backend/src/products/dto.ts" }, "IntegrationProductsController_removeBarcode_Response": { "type": "object", "properties": { "ok": { "type": "boolean" }, "unlinkedCases": { "type": "number" } }, "required": [ "ok", "unlinkedCases" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/products.integration.controller.ts" }, "IntegrationProductsController_linkAggregate_Response": { "type": "object", "properties": { "ok": { "type": "boolean" }, "productBarcodeId": { "type": "string", "nullable": true } }, "required": [ "ok", "productBarcodeId" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/products.integration.controller.ts" }, "OperationalProductsLinkAggregateDto": { "type": "object", "additionalProperties": false, "properties": { "productBarcodeId": { "type": "string", "nullable": true, "maxLength": 60 } }, "x-generated-from": "backend/src/products/dto.ts", "description": "Link (or unlink with null) an aggregation unit to the product barcode it holds." }, "IntegrationProductsController_update_Response": { "type": "object", "properties": { "barcodes": { "type": "array", "items": { "type": "object", "properties": { "casesPacked": { "type": "number" }, "casesReceived": { "type": "number" }, "unitsPacked": { "type": "number" }, "unitsReceived": { "type": "number" }, "id": { "type": "string" }, "productId": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" }, "containsQty": { "type": "number", "nullable": true }, "containsBarcodeId": { "type": "string", "nullable": true }, "containsCode": { "type": "string", "nullable": true }, "containsLabel": { "type": "string", "nullable": true }, "kind": { "type": "string", "enum": [ "EAN-8", "UPC-A", "EAN-13", "GTIN-14", "OTHER" ] }, "checkOk": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string" } }, "required": [ "casesPacked", "casesReceived", "unitsPacked", "unitsReceived", "id", "productId", "code", "level", "label", "unitsPerPack", "containsQty", "containsBarcodeId", "containsCode", "containsLabel", "kind", "checkOk", "createdAt" ], "additionalProperties": false } }, "casesPacked": { "type": "number" }, "casesReceived": { "type": "number" }, "unitsPacked": { "type": "number" }, "unitsReceived": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "sku": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "ecid": { "type": "string" }, "notes": { "type": "string" }, "recipe": { "type": "object", "properties": { "pgMl": { "type": "number" }, "vgMl": { "type": "number" }, "nicType": { "type": "string" }, "nicConc": { "type": "string" }, "nicUnit": { "type": "string", "enum": [ "g", "kg", "ml" ] }, "nicMl": { "type": "number" }, "flavourings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "ml": { "type": "number" } }, "required": [ "code", "ml" ], "additionalProperties": false } }, "cbdForm": { "type": "string" }, "cbdStrength": { "type": "string" }, "cbdUnit": { "type": "string", "enum": [ "", "g", "ml" ] }, "cbdQty": { "type": "number" }, "labelSku": { "type": "string" } }, "required": [ "pgMl", "vgMl", "nicType", "nicConc", "nicUnit", "nicMl", "flavourings", "cbdForm", "cbdStrength", "cbdUnit", "cbdQty", "labelSku" ], "additionalProperties": false, "nullable": true }, "manufacturerId": { "type": "string", "nullable": true }, "manufacturerName": { "type": "string", "nullable": true }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "barcodes", "casesPacked", "casesReceived", "unitsPacked", "unitsReceived", "id", "name", "brand", "sku", "volumeMl", "ecid", "notes", "recipe", "manufacturerId", "manufacturerName", "createdBy", "createdAt", "updatedAt" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/products.integration.controller.ts" }, "OperationalProductsUpdateProductDto": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "brand": { "type": "string", "maxLength": 80 }, "sku": { "type": "string", "maxLength": 80 }, "volumeMl": { "type": "number", "minimum": 0, "maximum": 100000 }, "ecid": { "type": "string", "maxLength": 60 }, "notes": { "type": "string", "maxLength": 2000 }, "manufacturerId": { "type": "string", "nullable": true, "maxLength": 60, "description": "null clears it (made by us)" }, "recipe": { "type": "object", "additionalProperties": true, "nullable": true, "description": "ingredients of one bottle (see cleanRecipe); null clears" } }, "x-generated-from": "backend/src/products/dto.ts" }, "IntegrationProductsController_remove_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/products.integration.controller.ts" }, "IntegrationProductsController_addBarcode_Response": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string" }, "code": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" }, "containsQty": { "type": "number", "nullable": true }, "containsBarcodeId": { "type": "string", "nullable": true }, "containsCode": { "type": "string", "nullable": true }, "containsLabel": { "type": "string", "nullable": true }, "kind": { "type": "string", "enum": [ "EAN-8", "UPC-A", "EAN-13", "GTIN-14", "OTHER" ] }, "checkOk": { "type": "boolean", "nullable": true }, "casesPacked": { "type": "number" }, "casesReceived": { "type": "number" }, "unitsPacked": { "type": "number" }, "unitsReceived": { "type": "number" }, "createdAt": { "type": "string" } }, "required": [ "id", "productId", "code", "level", "label", "unitsPerPack", "containsQty", "containsBarcodeId", "containsCode", "containsLabel", "kind", "checkOk", "casesPacked", "casesReceived", "unitsPacked", "unitsReceived", "createdAt" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/products.integration.controller.ts" }, "IntegrationPurchaseOrdersController_create_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "supplier": { "type": "string" }, "status": { "type": "string" }, "notes": { "type": "string" }, "lines": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "currency": { "type": "string" }, "deliveryCharge": { "type": "number" }, "value": { "type": "number" }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "supplier", "status", "notes", "lines", "currency", "deliveryCharge", "value", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts" }, "OperationalPurchaseordersCreatePurchaseOrderDto": { "type": "object", "additionalProperties": false, "properties": { "supplier": { "type": "string", "maxLength": 200 }, "currency": { "type": "string", "enum": [ "GBP", "EUR", "USD", "CNY" ] }, "deliveryCharge": { "type": "number", "minimum": 0 }, "notes": { "type": "string", "maxLength": 2000 }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalPurchaseordersPoLineDto" }, "minItems": 1 }, "invoice": { "$ref": "#/components/schemas/OperationalPurchaseordersInvoiceFileDto" } }, "required": [ "supplier", "lines" ], "x-generated-from": "backend/src/purchase-orders/dto.ts" }, "OperationalPurchaseordersPoLineDto": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "maxLength": 60 }, "itemCode": { "type": "string", "maxLength": 60 }, "desc": { "type": "string", "maxLength": 300 }, "qty": { "type": "number", "minimum": 0 }, "metric": { "type": "string", "maxLength": 40 }, "unit": { "type": "number", "minimum": 0 } }, "required": [ "type", "qty", "unit" ], "x-generated-from": "backend/src/purchase-orders/dto.ts", "description": "One purchase-order line item: { type, itemCode, desc, qty, metric, unit }." }, "OperationalPurchaseordersInvoiceFileDto": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 200 }, "type": { "type": "string", "maxLength": 120 }, "dataBase64": { "type": "string" } }, "required": [ "name", "type", "dataBase64" ], "x-generated-from": "backend/src/purchase-orders/dto.ts", "description": "JSON file upload: { name, type, dataBase64 } (≤3MB decoded)." }, "IntegrationPurchaseOrdersController_update_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "supplier": { "type": "string" }, "status": { "type": "string" }, "notes": { "type": "string" }, "lines": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "currency": { "type": "string" }, "deliveryCharge": { "type": "number" }, "value": { "type": "number" }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "supplier", "status", "notes", "lines", "currency", "deliveryCharge", "value", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts" }, "OperationalPurchaseordersUpdatePurchaseOrderDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string", "description": "ISO or dd/mm/yyyy - parsed with parseDateInput." }, "supplier": { "type": "string", "maxLength": 200 }, "status": { "type": "string", "enum": [ "Pending", "Partially received", "Received", "Cancelled" ] }, "currency": { "type": "string", "enum": [ "GBP", "EUR", "USD", "CNY" ] }, "deliveryCharge": { "type": "number", "minimum": 0 }, "notes": { "type": "string", "maxLength": 2000 }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalPurchaseordersPoLineDto" } } }, "x-generated-from": "backend/src/purchase-orders/dto.ts" }, "IntegrationPurchaseOrdersController_setStatus_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "supplier": { "type": "string" }, "status": { "type": "string" }, "notes": { "type": "string" }, "lines": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "currency": { "type": "string" }, "deliveryCharge": { "type": "number" }, "value": { "type": "number" }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "supplier", "status", "notes", "lines", "currency", "deliveryCharge", "value", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts" }, "OperationalPurchaseordersUpdatePoStatusDto": { "type": "object", "additionalProperties": false, "properties": { "status": { "enum": [ "Pending", "Partially received", "Received", "Cancelled" ] } }, "required": [ "status" ], "x-generated-from": "backend/src/purchase-orders/dto.ts" }, "IntegrationPurchaseOrdersController_remove_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts" }, "IntegrationPurchaseOrdersController_uploadInvoice_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "supplier": { "type": "string" }, "status": { "type": "string" }, "notes": { "type": "string" }, "lines": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "currency": { "type": "string" }, "deliveryCharge": { "type": "number" }, "value": { "type": "number" }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "supplier", "status", "notes", "lines", "currency", "deliveryCharge", "value", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts" }, "IntegrationPurchaseOrdersController_downloadInvoice_Response": { "type": "object", "properties": {}, "additionalProperties": true, "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts" }, "IntegrationPurchaseOrdersController_deleteInvoice_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "supplier": { "type": "string" }, "status": { "type": "string" }, "notes": { "type": "string" }, "lines": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "currency": { "type": "string" }, "deliveryCharge": { "type": "number" }, "value": { "type": "number" }, "invFileName": { "type": "string", "nullable": true }, "invFileType": { "type": "string", "nullable": true } }, "required": [ "id", "code", "date", "supplier", "status", "notes", "lines", "currency", "deliveryCharge", "value", "invFileName", "invFileType" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/purchase-orders.integration.controller.ts" }, "IntegrationStampsController_verifyScans_Response": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "uid": { "type": "string", "nullable": true }, "verdict": { "type": "string", "enum": [ "ok", "invalid", "duplicate", "already_activated", "not_activated", "already_packed", "already_received", "released", "destroyed" ] } }, "required": [ "code", "uid", "verdict" ], "additionalProperties": false } }, "ok": { "type": "number" } }, "required": [ "results", "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsVerifyScansDto": { "type": "object", "additionalProperties": false, "properties": { "codes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "minItems": 1, "maxItems": 5000 }, "mode": { "type": "string", "enum": [ "activate", "pack", "receive", "release" ], "description": "activate (default): codes must be NEW - never activated before.\r\npack: codes must be EXISTING activated stamps that are not yet in a case.\r\nreceive: inbound stamps - unknown codes are fine (activated overseas);\r\n only stamps that are packed here, destroyed or already received fail.\r\nrelease: stamps leaving duty suspension - must be here (ACTIVATED or\r\n RECEIVED) and loose; stamps inside a case release with the case." } }, "required": [ "codes" ], "x-generated-from": "backend/src/stamps/dto.ts", "description": "Codes scanned in the UI - raw DataMatrix payloads or typed codes." }, "IntegrationStampsController_activateStamps_Response": { "type": "object", "properties": { "activated": { "type": "number" }, "skipped": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "uid": { "type": "string", "nullable": true }, "verdict": { "type": "string", "enum": [ "ok", "invalid", "duplicate", "already_activated", "not_activated", "already_packed", "already_received", "released", "destroyed" ] } }, "required": [ "code", "uid", "verdict" ], "additionalProperties": false } }, "totalOnOrder": { "type": "number" }, "order": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "mfg": { "type": "string" }, "party": { "type": "string" }, "stockKey": { "type": "string" }, "qty": { "type": "number" }, "ref": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "string" }, "shippingAddress": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "code", "date", "mfg", "party", "stockKey", "qty", "ref", "status", "customer", "shippingAddress", "notes" ], "additionalProperties": false }, "loteEvents": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "deliveryState": { "type": "string" }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "COMMISSIONING", "AGGREGATION", "DISAGGREGATION", "SHIPPING", "RECEIVING", "DESTROY", "SALE", "RETURN" ] }, "loteEventId": { "type": "string" }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "nullable": true }, "loteStatusCode": { "type": "number", "nullable": true }, "lastError": { "type": "string" }, "attempts": { "type": "number" }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "status", "deliveryState", "environment", "providerConfirmed", "confirmedAt", "id", "type", "loteEventId", "stampCount", "stampOrderId", "aggregateId", "loteStatusCode", "lastError", "attempts", "createdAt" ], "additionalProperties": false } } }, "required": [ "activated", "skipped", "totalOnOrder", "order", "loteEvents" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsActivateStampsDto": { "type": "object", "additionalProperties": false, "properties": { "codes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "minItems": 1, "maxItems": 5000 }, "mode": { "type": "string", "enum": [ "activate", "pack", "receive", "release" ], "description": "activate (default): codes must be NEW - never activated before.\r\npack: codes must be EXISTING activated stamps that are not yet in a case.\r\nreceive: inbound stamps - unknown codes are fine (activated overseas);\r\n only stamps that are packed here, destroyed or already received fail.\r\nrelease: stamps leaving duty suspension - must be here (ACTIVATED or\r\n RECEIVED) and loose; stamps inside a case release with the case." }, "stampOrderId": { "type": "string", "minLength": 1, "description": "StampOrder (receipt) the scanned stamps belong to." } }, "required": [ "codes", "stampOrderId" ], "x-generated-from": "backend/src/stamps/dto.ts" }, "IntegrationStampsController_activateAndPack_Response": { "type": "object", "properties": { "activated": { "type": "number" }, "aggregate": { "type": "object", "properties": { "productionOrderId": { "type": "string", "nullable": true }, "batch": { "type": "object", "properties": { "code": { "type": "string" }, "batch": { "type": "string" } }, "required": [ "code", "batch" ], "additionalProperties": false, "nullable": true }, "productBarcodeId": { "type": "string", "nullable": true }, "product": { "type": "object", "properties": { "productId": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "barcode": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" } }, "required": [ "productId", "name", "brand", "volumeMl", "barcode", "level", "label", "unitsPerPack" ], "additionalProperties": false, "nullable": true }, "id": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "string", "enum": [ "SHIPPED", "RECEIVED", "RELEASED", "CLOSED", "DISAGGREGATED" ] }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "parentCode": { "type": "string", "nullable": true }, "childCount": { "type": "number" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "nullable": true }, "brokenAt": { "type": "string", "nullable": true } }, "required": [ "productionOrderId", "batch", "productBarcodeId", "product", "id", "code", "status", "stampCount", "stampOrderId", "parentId", "parentCode", "childCount", "createdBy", "createdAt", "brokenAt" ], "additionalProperties": false }, "totalOnOrder": { "type": "number" }, "order": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "mfg": { "type": "string" }, "party": { "type": "string" }, "stockKey": { "type": "string" }, "qty": { "type": "number" }, "ref": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "string" }, "shippingAddress": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "code", "date", "mfg", "party", "stockKey", "qty", "ref", "status", "customer", "shippingAddress", "notes" ], "additionalProperties": false }, "loteEvents": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "deliveryState": { "type": "string" }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "COMMISSIONING", "AGGREGATION", "DISAGGREGATION", "SHIPPING", "RECEIVING", "DESTROY", "SALE", "RETURN" ] }, "loteEventId": { "type": "string" }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "nullable": true }, "loteStatusCode": { "type": "number", "nullable": true }, "lastError": { "type": "string" }, "attempts": { "type": "number" }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "status", "deliveryState", "environment", "providerConfirmed", "confirmedAt", "id", "type", "loteEventId", "stampCount", "stampOrderId", "aggregateId", "loteStatusCode", "lastError", "attempts", "createdAt" ], "additionalProperties": false } } }, "required": [ "activated", "aggregate", "totalOnOrder", "order", "loteEvents" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsActivateAndPackDto": { "type": "object", "additionalProperties": false, "properties": { "stampOrderId": { "type": "string", "minLength": 1 }, "caseCode": { "type": "string", "minLength": 1, "maxLength": 100 }, "codes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "minItems": 1, "maxItems": 5000 }, "productBarcodeId": { "type": "string", "maxLength": 60, "description": "optional: the product barcode (product + pack level) this unit holds" }, "productionOrderId": { "type": "string", "maxLength": 60, "description": "optional: the production order (batch) this unit is packed for" } }, "required": [ "stampOrderId", "caseCode", "codes" ], "x-generated-from": "backend/src/stamps/dto.ts", "description": "Activate & pack in one pass - fresh stamps straight off the line into a\r\ncase: each code is activated AND assigned to the case in a single scan." }, "IntegrationStampsController_destroyStamps_Response": { "type": "object", "properties": { "destroyed": { "type": "number" }, "loteEvents": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "deliveryState": { "type": "string" }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "COMMISSIONING", "AGGREGATION", "DISAGGREGATION", "SHIPPING", "RECEIVING", "DESTROY", "SALE", "RETURN" ] }, "loteEventId": { "type": "string" }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "nullable": true }, "loteStatusCode": { "type": "number", "nullable": true }, "lastError": { "type": "string" }, "attempts": { "type": "number" }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "status", "deliveryState", "environment", "providerConfirmed", "confirmedAt", "id", "type", "loteEventId", "stampCount", "stampOrderId", "aggregateId", "loteStatusCode", "lastError", "attempts", "createdAt" ], "additionalProperties": false } } }, "required": [ "destroyed", "loteEvents" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsDestroyStampsDto": { "type": "object", "additionalProperties": false, "properties": { "codes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "minItems": 1, "maxItems": 5000 }, "disposition": { "type": "string", "enum": [ "destroyed", "stolen", "expired", "damaged" ], "description": "Spec 7.6: destroyed | stolen | expired (lost) | damaged (wasted)." }, "notes": { "type": "string", "maxLength": 2000 }, "noPhoto": { "type": "boolean", "description": "Lost/stolen stamps cannot be photographed - explicit declaration that\r\nno picture evidence exists for this destruction." } }, "required": [ "codes", "disposition" ], "x-generated-from": "backend/src/stamps/dto.ts", "description": "Destroy loose activated stamps (damaged/lost/stolen/destroyed)." }, "IntegrationStampsController_shipStamps_Response": { "type": "object", "properties": { "shippedCases": { "type": "number" }, "shippedStamps": { "type": "number" }, "loteEvents": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "deliveryState": { "type": "string" }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "COMMISSIONING", "AGGREGATION", "DISAGGREGATION", "SHIPPING", "RECEIVING", "DESTROY", "SALE", "RETURN" ] }, "loteEventId": { "type": "string" }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "nullable": true }, "loteStatusCode": { "type": "number", "nullable": true }, "lastError": { "type": "string" }, "attempts": { "type": "number" }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "status", "deliveryState", "environment", "providerConfirmed", "confirmedAt", "id", "type", "loteEventId", "stampCount", "stampOrderId", "aggregateId", "loteStatusCode", "lastError", "attempts", "createdAt" ], "additionalProperties": false } } }, "required": [ "shippedCases", "shippedStamps", "loteEvents" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsShipStampsDto": { "type": "object", "additionalProperties": false, "properties": { "caseCodes": { "type": "array", "items": { "type": "string", "maxLength": 100 }, "maxItems": 500 }, "stampCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 5000 }, "customer": { "type": "string", "maxLength": 200 }, "destinationUrn": { "type": "string", "maxLength": 200, "description": "Destination location URN from the customer's VDS registration." }, "intendedRoute": { "type": "string", "maxLength": 500 }, "invoiceRef": { "type": "string", "maxLength": 100 } }, "required": [ "caseCodes", "stampCodes" ], "x-generated-from": "backend/src/stamps/dto.ts", "description": "Ship packed cases (and/or loose activated stamps) to a customer." }, "IntegrationStampsController_receiveStamps_Response": { "type": "object", "properties": { "productsReceived": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "barcode": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" }, "cases": { "type": "number" }, "units": { "type": "number" } }, "required": [ "productId", "name", "brand", "volumeMl", "barcode", "level", "label", "unitsPerPack", "cases", "units" ], "additionalProperties": false } }, "receivedCases": { "type": "number" }, "newCases": { "type": "number" }, "receivedStamps": { "type": "number" }, "unknownContents": { "type": "boolean" }, "loteEvents": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "deliveryState": { "type": "string" }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "COMMISSIONING", "AGGREGATION", "DISAGGREGATION", "SHIPPING", "RECEIVING", "DESTROY", "SALE", "RETURN" ] }, "loteEventId": { "type": "string" }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "nullable": true }, "loteStatusCode": { "type": "number", "nullable": true }, "lastError": { "type": "string" }, "attempts": { "type": "number" }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "status", "deliveryState", "environment", "providerConfirmed", "confirmedAt", "id", "type", "loteEventId", "stampCount", "stampOrderId", "aggregateId", "loteStatusCode", "lastError", "attempts", "createdAt" ], "additionalProperties": false } } }, "required": [ "productsReceived", "receivedCases", "newCases", "receivedStamps", "unknownContents", "loteEvents" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsReceiveStampsDto": { "type": "object", "additionalProperties": false, "properties": { "caseCodes": { "type": "array", "items": { "type": "string", "maxLength": 100 }, "maxItems": 500 }, "stampCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 5000 }, "sender": { "type": "string", "maxLength": 200, "description": "Who sent it - overseas manufacturer / supplier name." }, "stampOrderId": { "type": "string", "maxLength": 100, "description": "Cartor stamp order (receipt) these stamps came from - links inbound\r\nstamps that were activated outside this system back to the order, so\r\nthe order's activated count reflects them." }, "sourceUrn": { "type": "string", "maxLength": 200, "description": "Dispatching premises location URN (the overseas affixing site)." }, "intendedRoute": { "type": "string", "maxLength": 500 }, "invoiceRef": { "type": "string", "maxLength": 100 }, "productBarcodeId": { "type": "string", "maxLength": 60, "description": "optional: the product barcode printed on the cases being received" } }, "required": [ "caseCodes", "stampCodes" ], "x-generated-from": "backend/src/stamps/dto.ts", "description": "Receive inbound cases/stamps (e.g. from the overseas affixing premises)." }, "IntegrationStampsController_createAggregate_Response": { "type": "object", "properties": { "aggregate": { "type": "object", "properties": { "productionOrderId": { "type": "string", "nullable": true }, "batch": { "type": "object", "properties": { "code": { "type": "string" }, "batch": { "type": "string" } }, "required": [ "code", "batch" ], "additionalProperties": false, "nullable": true }, "productBarcodeId": { "type": "string", "nullable": true }, "product": { "type": "object", "properties": { "productId": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "barcode": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" } }, "required": [ "productId", "name", "brand", "volumeMl", "barcode", "level", "label", "unitsPerPack" ], "additionalProperties": false, "nullable": true }, "id": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "string", "enum": [ "SHIPPED", "RECEIVED", "RELEASED", "CLOSED", "DISAGGREGATED" ] }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "parentCode": { "type": "string", "nullable": true }, "childCount": { "type": "number" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "nullable": true }, "brokenAt": { "type": "string", "nullable": true } }, "required": [ "productionOrderId", "batch", "productBarcodeId", "product", "id", "code", "status", "stampCount", "stampOrderId", "parentId", "parentCode", "childCount", "createdBy", "createdAt", "brokenAt" ], "additionalProperties": false }, "units": { "type": "number" }, "loteEvents": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "deliveryState": { "type": "string" }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "COMMISSIONING", "AGGREGATION", "DISAGGREGATION", "SHIPPING", "RECEIVING", "DESTROY", "SALE", "RETURN" ] }, "loteEventId": { "type": "string" }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "nullable": true }, "loteStatusCode": { "type": "number", "nullable": true }, "lastError": { "type": "string" }, "attempts": { "type": "number" }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "status", "deliveryState", "environment", "providerConfirmed", "confirmedAt", "id", "type", "loteEventId", "stampCount", "stampOrderId", "aggregateId", "loteStatusCode", "lastError", "attempts", "createdAt" ], "additionalProperties": false } } }, "required": [ "aggregate", "units", "loteEvents" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsCreateAggregateDto": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 100 }, "stampCodes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 5000 }, "caseCodes": { "type": "array", "items": { "type": "string", "maxLength": 100 }, "maxItems": 1000, "description": "Nested aggregation: already-packed units (cases into a master box,\r\nmaster boxes into a pallet, …) going inside this label." }, "productBarcodeId": { "type": "string", "maxLength": 60, "description": "optional: the product barcode (product + pack level) this unit holds" }, "productionOrderId": { "type": "string", "maxLength": 60, "description": "optional: the production order (batch) this unit is packed for" } }, "required": [ "code" ], "x-generated-from": "backend/src/stamps/dto.ts", "description": "Pack activated stamps into a UK VDS case (UID-AG)." }, "IntegrationStampsController_createMasterAggregate_Response": { "type": "object", "properties": { "aggregate": { "type": "object", "properties": { "productionOrderId": { "type": "string", "nullable": true }, "batch": { "type": "object", "properties": { "code": { "type": "string" }, "batch": { "type": "string" } }, "required": [ "code", "batch" ], "additionalProperties": false, "nullable": true }, "productBarcodeId": { "type": "string", "nullable": true }, "product": { "type": "object", "properties": { "productId": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "barcode": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" } }, "required": [ "productId", "name", "brand", "volumeMl", "barcode", "level", "label", "unitsPerPack" ], "additionalProperties": false, "nullable": true }, "id": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "string", "enum": [ "SHIPPED", "RECEIVED", "RELEASED", "CLOSED", "DISAGGREGATED" ] }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "parentCode": { "type": "string", "nullable": true }, "childCount": { "type": "number" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "nullable": true }, "brokenAt": { "type": "string", "nullable": true } }, "required": [ "productionOrderId", "batch", "productBarcodeId", "product", "id", "code", "status", "stampCount", "stampOrderId", "parentId", "parentCode", "childCount", "createdBy", "createdAt", "brokenAt" ], "additionalProperties": false }, "cases": { "type": "number" }, "loteEvents": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "deliveryState": { "type": "string" }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "COMMISSIONING", "AGGREGATION", "DISAGGREGATION", "SHIPPING", "RECEIVING", "DESTROY", "SALE", "RETURN" ] }, "loteEventId": { "type": "string" }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "nullable": true }, "loteStatusCode": { "type": "number", "nullable": true }, "lastError": { "type": "string" }, "attempts": { "type": "number" }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "status", "deliveryState", "environment", "providerConfirmed", "confirmedAt", "id", "type", "loteEventId", "stampCount", "stampOrderId", "aggregateId", "loteStatusCode", "lastError", "attempts", "createdAt" ], "additionalProperties": false } } }, "required": [ "aggregate", "cases", "loteEvents" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsCreateMasterAggregateDto": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 100 }, "caseCodes": { "type": "array", "items": { "type": "string", "maxLength": 100 }, "minItems": 1, "maxItems": 1000 }, "productBarcodeId": { "type": "string", "maxLength": 60, "description": "optional: the product barcode (product + pack level) this unit holds" }, "productionOrderId": { "type": "string", "maxLength": 60, "description": "optional: the production order (batch) this unit is packed for" } }, "required": [ "code", "caseCodes" ], "x-generated-from": "backend/src/stamps/dto.ts" }, "IntegrationStampsController_listAggregates_Response": { "type": "array", "items": { "type": "object", "properties": { "productionOrderId": { "type": "string", "nullable": true }, "batch": { "type": "object", "properties": { "code": { "type": "string" }, "batch": { "type": "string" } }, "required": [ "code", "batch" ], "additionalProperties": false, "nullable": true }, "productBarcodeId": { "type": "string", "nullable": true }, "product": { "type": "object", "properties": { "productId": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "barcode": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" } }, "required": [ "productId", "name", "brand", "volumeMl", "barcode", "level", "label", "unitsPerPack" ], "additionalProperties": false, "nullable": true }, "id": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "string", "enum": [ "SHIPPED", "RECEIVED", "RELEASED", "CLOSED", "DISAGGREGATED" ] }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "parentCode": { "type": "string", "nullable": true }, "childCount": { "type": "number" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "nullable": true }, "brokenAt": { "type": "string", "nullable": true } }, "required": [ "productionOrderId", "batch", "productBarcodeId", "product", "id", "code", "status", "stampCount", "stampOrderId", "parentId", "parentCode", "childCount", "createdBy", "createdAt", "brokenAt" ], "additionalProperties": false }, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "IntegrationStampsController_listAggregateStamps_Response": { "type": "object", "properties": { "aggregate": { "type": "object", "properties": { "productionOrderId": { "type": "string", "nullable": true }, "batch": { "type": "object", "properties": { "code": { "type": "string" }, "batch": { "type": "string" } }, "required": [ "code", "batch" ], "additionalProperties": false, "nullable": true }, "productBarcodeId": { "type": "string", "nullable": true }, "product": { "type": "object", "properties": { "productId": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "barcode": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" } }, "required": [ "productId", "name", "brand", "volumeMl", "barcode", "level", "label", "unitsPerPack" ], "additionalProperties": false, "nullable": true }, "id": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "string", "enum": [ "SHIPPED", "RECEIVED", "RELEASED", "CLOSED", "DISAGGREGATED" ] }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "parentCode": { "type": "string", "nullable": true }, "childCount": { "type": "number" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "nullable": true }, "brokenAt": { "type": "string", "nullable": true } }, "required": [ "productionOrderId", "batch", "productBarcodeId", "product", "id", "code", "status", "stampCount", "stampOrderId", "parentId", "parentCode", "childCount", "createdBy", "createdAt", "brokenAt" ], "additionalProperties": false }, "stamps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "uid": { "type": "string" }, "status": { "type": "string", "enum": [ "SCANNED", "ACTIVATED", "AGGREGATED", "SHIPPED", "RECEIVED", "RELEASED", "DESTROYED" ] }, "scannedBy": { "type": "string" }, "activatedAt": { "type": "string", "nullable": true } }, "required": [ "id", "uid", "status", "scannedBy", "activatedAt" ], "additionalProperties": false } }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "stampCount": { "type": "number" }, "status": { "type": "string", "enum": [ "SHIPPED", "RECEIVED", "RELEASED", "CLOSED", "DISAGGREGATED" ] } }, "required": [ "id", "code", "stampCount", "status" ], "additionalProperties": false } } }, "required": [ "aggregate", "stamps", "children" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "IntegrationStampsController_breakAggregate_Response": { "type": "object", "properties": { "aggregate": { "type": "object", "properties": { "productionOrderId": { "type": "string", "nullable": true }, "batch": { "type": "object", "properties": { "code": { "type": "string" }, "batch": { "type": "string" } }, "required": [ "code", "batch" ], "additionalProperties": false, "nullable": true }, "productBarcodeId": { "type": "string", "nullable": true }, "product": { "type": "object", "properties": { "productId": { "type": "string" }, "name": { "type": "string" }, "brand": { "type": "string" }, "volumeMl": { "type": "number", "nullable": true }, "barcode": { "type": "string" }, "level": { "type": "string" }, "label": { "type": "string" }, "unitsPerPack": { "type": "number" } }, "required": [ "productId", "name", "brand", "volumeMl", "barcode", "level", "label", "unitsPerPack" ], "additionalProperties": false, "nullable": true }, "id": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "string", "enum": [ "SHIPPED", "RECEIVED", "RELEASED", "CLOSED", "DISAGGREGATED" ] }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "parentCode": { "type": "string", "nullable": true }, "childCount": { "type": "number" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string", "nullable": true }, "brokenAt": { "type": "string", "nullable": true } }, "required": [ "productionOrderId", "batch", "productBarcodeId", "product", "id", "code", "status", "stampCount", "stampOrderId", "parentId", "parentCode", "childCount", "createdBy", "createdAt", "brokenAt" ], "additionalProperties": false }, "loteEvents": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "deliveryState": { "type": "string" }, "environment": { "type": "string" }, "providerConfirmed": { "type": "boolean" }, "confirmedAt": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "COMMISSIONING", "AGGREGATION", "DISAGGREGATION", "SHIPPING", "RECEIVING", "DESTROY", "SALE", "RETURN" ] }, "loteEventId": { "type": "string" }, "stampCount": { "type": "number" }, "stampOrderId": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "nullable": true }, "loteStatusCode": { "type": "number", "nullable": true }, "lastError": { "type": "string" }, "attempts": { "type": "number" }, "createdAt": { "type": "string", "nullable": true } }, "required": [ "status", "deliveryState", "environment", "providerConfirmed", "confirmedAt", "id", "type", "loteEventId", "stampCount", "stampOrderId", "aggregateId", "loteStatusCode", "lastError", "attempts", "createdAt" ], "additionalProperties": false } } }, "required": [ "aggregate", "loteEvents" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "IntegrationStampsController_createManufacturer_Response": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "country": { "type": "string" }, "contact": { "type": "string" }, "keyPerson": { "type": "string" } }, "required": [ "id", "name", "address", "country", "contact", "keyPerson" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsCreateManufacturerDto": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "address": { "type": "string", "maxLength": 1000 }, "country": { "type": "string", "maxLength": 120 }, "contact": { "type": "string", "maxLength": 120 }, "keyPerson": { "type": "string", "maxLength": 200 } }, "required": [ "name" ], "x-generated-from": "backend/src/stamps/dto.ts" }, "IntegrationStampsController_updateManufacturer_Response": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "country": { "type": "string" }, "contact": { "type": "string" }, "keyPerson": { "type": "string" } }, "required": [ "id", "name", "address", "country", "contact", "keyPerson" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsUpdateManufacturerDto": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "address": { "type": "string", "maxLength": 1000 }, "country": { "type": "string", "maxLength": 120 }, "contact": { "type": "string", "maxLength": 120 }, "keyPerson": { "type": "string", "maxLength": 200 } }, "x-generated-from": "backend/src/stamps/dto.ts" }, "IntegrationStampsController_deleteManufacturer_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "IntegrationStampsController_importAggCodes_Response": { "type": "object", "properties": { "imported": { "type": "number" }, "duplicates": { "type": "number" }, "alreadyUsed": { "type": "number" }, "invalid": { "type": "number" }, "available": { "type": "number" } }, "required": [ "imported", "duplicates", "alreadyUsed", "invalid", "available" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalDeveloperAggCodesDto": { "type": "object", "additionalProperties": false, "properties": { "codes": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "minItems": 1, "maxItems": 5000 } }, "required": [ "codes" ], "x-generated-from": "backend/src/developer/operational-dto.ts" }, "IntegrationStampsController_aggCodeSummary_Response": { "type": "object", "properties": { "available": { "type": "number" }, "allocated": { "type": "number" } }, "required": [ "available", "allocated" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "IntegrationStampsController_caseLabels_Response": { "type": "object", "properties": { "uic": { "type": "string" }, "codes": { "type": "array", "items": { "type": "string" } }, "fromPool": { "type": "number" }, "sscc": { "type": "number" }, "demoCount": { "type": "number" }, "poolRemaining": { "type": "number" } }, "required": [ "uic", "codes", "fromPool", "sscc", "demoCount", "poolRemaining" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalDeveloperCaseLabelsDto": { "type": "object", "additionalProperties": false, "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 500 }, "prefix": { "type": "string", "maxLength": 40 } }, "required": [ "count" ], "x-generated-from": "backend/src/developer/operational-dto.ts" }, "IntegrationStampsController_saveScanPhotos_Response": { "type": "object", "properties": { "ok": { "type": "boolean" }, "saved": { "type": "number" } }, "required": [ "ok", "saved" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalDeveloperScanPhotosDto": { "type": "object", "additionalProperties": false, "properties": { "photos": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalDeveloperScanPhotoDto" }, "minItems": 1, "maxItems": 5 } }, "required": [ "photos" ], "x-generated-from": "backend/src/developer/operational-dto.ts" }, "OperationalDeveloperScanPhotoDto": { "type": "object", "additionalProperties": false, "properties": { "uid": { "type": "string", "maxLength": 200 }, "event": { "type": "string", "maxLength": 80 }, "type": { "type": "string", "maxLength": 80 }, "dataBase64": { "type": "string", "maxLength": 800000 } }, "required": [ "dataBase64" ], "x-generated-from": "backend/src/developer/operational-dto.ts" }, "IntegrationStampsController_listScanPhotos_Response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "event": { "type": "string" }, "takenBy": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "event", "takenBy", "createdAt" ], "additionalProperties": false }, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "IntegrationStampsController_getScanPhoto_Response": { "type": "object", "properties": {}, "additionalProperties": true, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "IntegrationStampsController_createOrder_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "mfg": { "type": "string" }, "party": { "type": "string" }, "stockKey": { "type": "string" }, "qty": { "type": "number" }, "ref": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "string" }, "shippingAddress": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "code", "date", "mfg", "party", "stockKey", "qty", "ref", "status", "customer", "shippingAddress", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalDeveloperCreateStampOrderDto": { "type": "object", "additionalProperties": false, "properties": { "mfg": { "enum": [ "My Manufacturing", "Third Party Manufacturing" ] }, "party": { "type": "string", "maxLength": 200, "description": "Third-party manufacturer name - required when mfg is Third Party Manufacturing." }, "qty": { "type": "integer", "minimum": 1 }, "ref": { "type": "string", "minLength": 1, "maxLength": 200 }, "status": { "type": "string", "enum": [ "Product duty suspended" ], "nullable": true }, "customer": { "type": "string", "maxLength": 200 }, "shippingAddress": { "type": "string", "maxLength": 1000 }, "notes": { "type": "string", "maxLength": 2000 } }, "required": [ "mfg", "qty", "ref" ], "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsCreateStampOrderDto": { "type": "object", "additionalProperties": false, "properties": { "mfg": { "enum": [ "My Manufacturing", "Third Party Manufacturing" ] }, "party": { "type": "string", "maxLength": 200, "description": "Third-party manufacturer name - required when mfg is Third Party Manufacturing." }, "qty": { "type": "integer", "minimum": 1 }, "ref": { "type": "string", "minLength": 1, "maxLength": 200 }, "status": { "enum": [ "Stamp activated", "Product duty suspended", "Product in free zone", "Product shipped" ] }, "customer": { "type": "string", "maxLength": 200 }, "shippingAddress": { "type": "string", "maxLength": 1000 }, "notes": { "type": "string", "maxLength": 2000 } }, "required": [ "mfg", "qty", "ref" ], "x-generated-from": "backend/src/stamps/dto.ts" }, "IntegrationStampsController_updateOrder_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "date": { "type": "string", "nullable": true }, "mfg": { "type": "string" }, "party": { "type": "string" }, "stockKey": { "type": "string" }, "qty": { "type": "number" }, "ref": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "string" }, "shippingAddress": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "code", "date", "mfg", "party", "stockKey", "qty", "ref", "status", "customer", "shippingAddress", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalDeveloperUpdateStampOrderDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string", "description": "ISO or dd/mm/yyyy." }, "mfg": { "enum": [ "My Manufacturing", "Third Party Manufacturing" ] }, "party": { "type": "string", "maxLength": 200 }, "qty": { "type": "integer", "minimum": 0 }, "ref": { "type": "string", "maxLength": 200 }, "status": { "type": "string", "enum": [ "Product duty suspended" ], "nullable": true }, "customer": { "type": "string", "maxLength": 200 }, "shippingAddress": { "type": "string", "maxLength": 1000 }, "notes": { "type": "string", "maxLength": 2000 } }, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "OperationalStampsUpdateStampOrderDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string", "description": "ISO or dd/mm/yyyy." }, "mfg": { "enum": [ "My Manufacturing", "Third Party Manufacturing" ] }, "party": { "type": "string", "maxLength": 200 }, "qty": { "type": "integer", "minimum": 0 }, "ref": { "type": "string", "maxLength": 200 }, "status": { "enum": [ "Stamp activated", "Product duty suspended", "Product in free zone", "Product shipped" ] }, "customer": { "type": "string", "maxLength": 200 }, "shippingAddress": { "type": "string", "maxLength": 1000 }, "notes": { "type": "string", "maxLength": 2000 } }, "x-generated-from": "backend/src/stamps/dto.ts" }, "IntegrationStampsController_deleteOrder_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stamps.integration.controller.ts" }, "IntegrationStockController_addPgvg_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "type": { "type": "string" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "type", "qtyMl", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddPgvgDto": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "PG", "VG" ] }, "qtyMl": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "expiryDate": { "type": "string" } }, "required": [ "type", "qtyMl" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_editPgvgLog_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "type": { "type": "string" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "type", "qtyMl", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockEditPgvgLogDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string" }, "type": { "type": "string", "enum": [ "PG", "VG" ] }, "qtyMl": { "type": "number", "minimum": 0 }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "expiryDate": { "type": "string" } }, "required": [ "type", "qtyMl" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_deletePgvgLog_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_addNicotine_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "nicType": { "type": "string" }, "concentration": { "type": "number" }, "qtyMl": { "type": "number" }, "unit": { "type": "string" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "nicType", "concentration", "qtyMl", "unit", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddNicotineDto": { "type": "object", "additionalProperties": false, "properties": { "nicType": { "type": "string", "maxLength": 60 }, "concentration": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "qtyMl": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "unit": { "type": "string", "enum": [ "ml", "g", "kg" ] }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "expiryDate": { "type": "string" } }, "required": [ "nicType", "concentration", "qtyMl" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_editNicLog_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "nicType": { "type": "string" }, "concentration": { "type": "number" }, "qtyMl": { "type": "number" }, "unit": { "type": "string" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "nicType", "concentration", "qtyMl", "unit", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockEditNicLogDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string" }, "nicType": { "type": "string", "maxLength": 60 }, "concentration": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "qtyMl": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": [ "ml", "g", "kg" ] }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "expiryDate": { "type": "string" } }, "required": [ "nicType", "concentration", "qtyMl" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_deleteNicLog_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_deleteNicotineStock_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_convertNicotine_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "nicType": { "type": "string" }, "concentration": { "type": "number" }, "qtyMl": { "type": "number" }, "unit": { "type": "string" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "nicType", "concentration", "qtyMl", "unit", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockConvertNicotineDto": { "type": "object", "additionalProperties": false, "properties": { "nicType": { "type": "string", "maxLength": 60 }, "concentration": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "fromUnit": { "type": "string", "enum": [ "g", "kg" ] }, "fromQty": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "solvent": { "type": "string", "enum": [ "PG", "VG" ] }, "solventMl": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 } }, "required": [ "nicType", "concentration", "fromUnit", "fromQty", "solvent", "solventMl" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_addSweetenerPowder_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "qtyG": { "type": "number" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "kind", "qtyG", "qtyMl", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddSweetenerPowderDto": { "type": "object", "additionalProperties": false, "properties": { "qty": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "unit": { "type": "string", "enum": [ "g", "kg" ] }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "expiryDate": { "type": "string" } }, "required": [ "qty" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_addSweetenerLiquid_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "qtyG": { "type": "number" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "kind", "qtyG", "qtyMl", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddSweetenerLiquidDto": { "type": "object", "additionalProperties": false, "properties": { "qtyMl": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "flavourCode": { "type": "string", "maxLength": 40 }, "flavourName": { "type": "string", "maxLength": 120 }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 } }, "required": [ "qtyMl", "flavourCode", "flavourName" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_convertSweetener_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "qtyG": { "type": "number" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "kind", "qtyG", "qtyMl", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockConvertSweetenerDto": { "type": "object", "additionalProperties": false, "properties": { "powderG": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "solvent": { "type": "string", "enum": [ "PG", "VG" ] }, "solventMl": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "flavourCode": { "type": "string", "maxLength": 40 }, "flavourName": { "type": "string", "maxLength": 120 }, "batch": { "type": "string", "maxLength": 120 } }, "required": [ "powderG", "solvent", "solventMl", "flavourCode", "flavourName" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_deleteSweetenerLog_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_addCbd_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "form": { "type": "string" }, "strength": { "type": "number" }, "unit": { "type": "string" }, "qty": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "form", "strength", "unit", "qty", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddCbdDto": { "type": "object", "additionalProperties": false, "properties": { "form": { "type": "string", "maxLength": 60 }, "strength": { "type": "number", "minimum": 0 }, "unit": { "type": "string", "enum": [ "g", "ml" ] }, "qty": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "supplier": { "type": "string", "maxLength": 200 }, "batch": { "type": "string", "maxLength": 120 }, "notes": { "type": "string", "maxLength": 2000 }, "expiryDate": { "type": "string" } }, "required": [ "form", "strength", "unit", "qty" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_convertCbd_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "form": { "type": "string" }, "strength": { "type": "number" }, "unit": { "type": "string" }, "qty": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "notes": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "form", "strength", "unit", "qty", "batch", "supplier", "notes", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockConvertCbdDto": { "type": "object", "additionalProperties": false, "properties": { "form": { "type": "string", "maxLength": 60 }, "strength": { "type": "number", "minimum": 0 }, "powderG": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "solvent": { "type": "string", "enum": [ "PG", "VG" ] }, "solventMl": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 } }, "required": [ "form", "strength", "powderG", "solvent", "solventMl" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_deleteCbdLog_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_deleteCbdStock_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_createFlavouring_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "supplier": { "type": "string" }, "stockMl": { "type": "number" }, "allocationZone": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "code", "name", "supplier", "stockMl", "allocationZone", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockCreateFlavouringDto": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 40 }, "name": { "type": "string", "maxLength": 200 }, "supplier": { "type": "string", "maxLength": 200 }, "initialMl": { "type": "number", "minimum": 0 }, "pricePerUnit": { "type": "number", "minimum": 0 }, "priceUnit": { "type": "string", "enum": [ "kg", "ml" ] }, "notes": { "type": "string", "maxLength": 2000 }, "allocationZone": { "type": "string", "maxLength": 80 }, "expiryDate": { "type": "string" } }, "required": [ "code", "name" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_addFlavouringStock_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "supplier": { "type": "string" }, "stockMl": { "type": "number" }, "allocationZone": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "code", "name", "supplier", "stockMl", "allocationZone", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddFlavStockDto": { "type": "object", "additionalProperties": false, "properties": { "qtyMl": { "type": "number", "minimum": 0, "exclusiveMinimum": true }, "batch": { "type": "string", "maxLength": 120 }, "pricePerUnit": { "type": "number", "minimum": 0 }, "priceUnit": { "type": "string", "enum": [ "kg", "ml" ] }, "expiryDate": { "type": "string" } }, "required": [ "qtyMl" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_updateFlavouring_Response": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "supplier": { "type": "string" }, "stockMl": { "type": "number" }, "allocationZone": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "id", "code", "name", "supplier", "stockMl", "allocationZone", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockUpdateFlavouringDto": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 40 }, "allocationZone": { "type": "string", "maxLength": 80 }, "name": { "type": "string", "maxLength": 200 }, "supplier": { "type": "string", "maxLength": 200 }, "notes": { "type": "string", "maxLength": 2000 }, "stockMl": { "type": "number", "minimum": 0, "description": "manual stock correction (stock-take) - sets the register stock directly." } }, "x-generated-from": "backend/src/stock/dto.ts", "description": "Update a flavouring's details, storage location, or a manual stock correction." }, "IntegrationStockController_editFlavLog_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "code": { "type": "string" }, "name": { "type": "string" }, "qtyMl": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "pricePerUnit": { "type": "number", "nullable": true }, "priceUnit": { "type": "string" }, "expiryDate": { "type": "string", "nullable": true } }, "required": [ "id", "date", "code", "name", "qtyMl", "batch", "supplier", "pricePerUnit", "priceUnit", "expiryDate" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockEditFlavLogDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string" }, "code": { "type": "string", "maxLength": 40 }, "qtyMl": { "type": "number", "minimum": 0 }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "pricePerUnit": { "type": "number", "minimum": 0 }, "priceUnit": { "type": "string", "enum": [ "kg", "ml" ] }, "expiryDate": { "type": "string" } }, "required": [ "code", "qtyMl" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_deleteFlavLog_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_deleteFlavouring_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_addLabel_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "flavour": { "type": "string" }, "strength": { "type": "string" }, "qty": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "pricePerLabel": { "type": "number", "nullable": true } }, "required": [ "id", "date", "sku", "flavour", "strength", "qty", "batch", "supplier", "pricePerLabel" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddLabelDto": { "type": "object", "additionalProperties": false, "properties": { "flavour": { "type": "string", "maxLength": 200 }, "strength": { "type": "string", "maxLength": 20 }, "sku": { "type": "string", "maxLength": 120 }, "qty": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "pricePerLabel": { "type": "number", "minimum": 0 }, "notes": { "type": "string", "maxLength": 2000 } }, "required": [ "flavour", "strength", "qty" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_addLabelStock_Response": { "type": "object", "properties": { "id": { "type": "string" }, "sku": { "type": "string" }, "flavour": { "type": "string" }, "strength": { "type": "string" }, "qty": { "type": "number" }, "notes": { "type": "string" } }, "required": [ "id", "sku", "flavour", "strength", "qty", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddLabelStockDto": { "type": "object", "additionalProperties": false, "properties": { "qty": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "required": [ "qty" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_editLblLog_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "sku": { "type": "string" }, "flavour": { "type": "string" }, "strength": { "type": "string" }, "qty": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "pricePerLabel": { "type": "number", "nullable": true } }, "required": [ "id", "date", "sku", "flavour", "strength", "qty", "batch", "supplier", "pricePerLabel" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockEditLblLogDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string" }, "sku": { "type": "string", "maxLength": 120 }, "flavour": { "type": "string", "maxLength": 200 }, "strength": { "type": "string", "maxLength": 20 }, "qty": { "type": "integer", "minimum": 0 }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "pricePerLabel": { "type": "number", "minimum": 0 } }, "required": [ "sku", "flavour", "strength", "qty" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_deleteLblLog_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_deleteLabelSku_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_addBottle_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "sizeMl": { "type": "number" }, "qty": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "pricePerBottle": { "type": "number", "nullable": true } }, "required": [ "id", "date", "sizeMl", "qty", "batch", "supplier", "pricePerBottle" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddBottleDto": { "type": "object", "additionalProperties": false, "properties": { "sizeMl": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 100000 }, "qty": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "pricePerBottle": { "type": "number", "minimum": 0 }, "notes": { "type": "string", "maxLength": 2000 } }, "required": [ "sizeMl", "qty" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_addBottleStock_Response": { "type": "object", "properties": { "id": { "type": "string" }, "sizeMl": { "type": "number" }, "qty": { "type": "number" }, "notes": { "type": "string" } }, "required": [ "id", "sizeMl", "qty", "notes" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockAddBottleStockDto": { "type": "object", "additionalProperties": false, "properties": { "qty": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "required": [ "qty" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_editBottleLog_Response": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "nullable": true }, "sizeMl": { "type": "number" }, "qty": { "type": "number" }, "batch": { "type": "string" }, "supplier": { "type": "string" }, "pricePerBottle": { "type": "number", "nullable": true } }, "required": [ "id", "date", "sizeMl", "qty", "batch", "supplier", "pricePerBottle" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "OperationalStockEditBottleLogDto": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string" }, "sizeMl": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 100000 }, "qty": { "type": "integer", "minimum": 0 }, "batch": { "type": "string", "maxLength": 120 }, "supplier": { "type": "string", "maxLength": 200 }, "pricePerBottle": { "type": "number", "minimum": 0 } }, "required": [ "sizeMl", "qty" ], "x-generated-from": "backend/src/stock/dto.ts" }, "IntegrationStockController_deleteBottleLog_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationStockController_deleteBottleSize_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/stock.integration.controller.ts" }, "IntegrationVpdController_list_Response": { "type": "array", "items": { "type": "object", "properties": { "inventoryRetained": { "type": "boolean" }, "releaseOperationId": { "type": "string", "nullable": true }, "id": { "type": "string" }, "kind": { "type": "string" }, "reference": { "type": "string" }, "customerName": { "type": "string" }, "companyName": { "type": "string" }, "eori": { "type": "string" }, "vatNumber": { "type": "string" }, "directorName": { "type": "string" }, "address": { "type": "string" }, "contactEmail": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "ownFreeZone": { "type": "boolean" }, "destination": { "type": "string" }, "arc": { "type": "string" }, "consignorExciseId": { "type": "string" }, "consigneeExciseId": { "type": "string" }, "movementStatus": { "type": "string" }, "receivedAt": { "type": "string", "nullable": true }, "orderDate": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "dutyPence": { "type": "number" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "inventoryRetained": { "type": "boolean" }, "releaseOperationId": { "type": "string", "nullable": true }, "inventoryLotId": { "type": "string", "nullable": true }, "taxPointAt": { "type": "string", "nullable": true }, "volumeMlExact": { "type": "string", "nullable": true }, "ratePencePerMl": { "type": "string", "nullable": true }, "accountingTreatment": { "type": "string", "nullable": true }, "quantityUnit": { "type": "string" }, "provenance": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "orderId": { "type": "string", "nullable": true }, "product": { "type": "string" }, "volumeMl": { "type": "number" }, "quantity": { "type": "number" }, "dutyPence": { "type": "number" }, "productionOrderId": { "type": "string", "nullable": true }, "productionOrderCode": { "type": "string" }, "stampOrderId": { "type": "string", "nullable": true }, "stampOrderCode": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "inventoryRetained", "releaseOperationId", "inventoryLotId", "taxPointAt", "volumeMlExact", "ratePencePerMl", "accountingTreatment", "quantityUnit", "provenance", "id", "orderId", "product", "volumeMl", "quantity", "dutyPence", "productionOrderId", "productionOrderCode", "stampOrderId", "stampOrderCode", "createdAt" ], "additionalProperties": false } } }, "required": [ "inventoryRetained", "releaseOperationId", "id", "kind", "reference", "customerName", "companyName", "eori", "vatNumber", "directorName", "address", "contactEmail", "phone", "notes", "ownFreeZone", "destination", "arc", "consignorExciseId", "consigneeExciseId", "movementStatus", "receivedAt", "orderDate", "createdBy", "createdAt", "dutyPence", "entries" ], "additionalProperties": false }, "x-generated-from": "backend/src/developer/vpd.integration.controller.ts" }, "IntegrationVpdController_productionOrders_Response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "product": { "type": "string" }, "batch": { "type": "string" }, "client": { "type": "string" }, "status": { "type": "string" }, "date": { "type": "string" }, "bottlesPlanned": { "type": "number" }, "allocationCapacity": { "type": "number" }, "releasedBottles": { "type": "number" }, "remainingBottles": { "type": "number" }, "releasedDutyPence": { "type": "number" }, "perBottleMl": { "type": "number" } }, "required": [ "id", "code", "product", "batch", "client", "status", "date", "bottlesPlanned", "allocationCapacity", "releasedBottles", "remainingBottles", "releasedDutyPence", "perBottleMl" ], "additionalProperties": false }, "x-generated-from": "backend/src/developer/vpd.integration.controller.ts" }, "IntegrationVpdController_importOrders_Response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "product": { "type": "string" }, "reference": { "type": "string" }, "bottlesPlanned": { "type": "number" }, "releasedBottles": { "type": "number" }, "remainingBottles": { "type": "number" }, "releasedDutyPence": { "type": "number" }, "perBottleMl": { "type": "number" } }, "required": [ "id", "code", "product", "reference", "bottlesPlanned", "releasedBottles", "remainingBottles", "releasedDutyPence", "perBottleMl" ], "additionalProperties": false }, "x-generated-from": "backend/src/developer/vpd.integration.controller.ts" }, "IntegrationVpdController_createOrder_Response": { "type": "object", "properties": { "inventoryRetained": { "type": "boolean" }, "releaseOperationId": { "type": "string", "nullable": true }, "id": { "type": "string" }, "kind": { "type": "string" }, "reference": { "type": "string" }, "customerName": { "type": "string" }, "companyName": { "type": "string" }, "eori": { "type": "string" }, "vatNumber": { "type": "string" }, "directorName": { "type": "string" }, "address": { "type": "string" }, "contactEmail": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "ownFreeZone": { "type": "boolean" }, "destination": { "type": "string" }, "arc": { "type": "string" }, "consignorExciseId": { "type": "string" }, "consigneeExciseId": { "type": "string" }, "movementStatus": { "type": "string" }, "receivedAt": { "type": "string", "nullable": true }, "orderDate": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "dutyPence": { "type": "number" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "inventoryRetained": { "type": "boolean" }, "releaseOperationId": { "type": "string", "nullable": true }, "inventoryLotId": { "type": "string", "nullable": true }, "taxPointAt": { "type": "string", "nullable": true }, "volumeMlExact": { "type": "string", "nullable": true }, "ratePencePerMl": { "type": "string", "nullable": true }, "accountingTreatment": { "type": "string", "nullable": true }, "quantityUnit": { "type": "string" }, "provenance": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "orderId": { "type": "string", "nullable": true }, "product": { "type": "string" }, "volumeMl": { "type": "number" }, "quantity": { "type": "number" }, "dutyPence": { "type": "number" }, "productionOrderId": { "type": "string", "nullable": true }, "productionOrderCode": { "type": "string" }, "stampOrderId": { "type": "string", "nullable": true }, "stampOrderCode": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "inventoryRetained", "releaseOperationId", "inventoryLotId", "taxPointAt", "volumeMlExact", "ratePencePerMl", "accountingTreatment", "quantityUnit", "provenance", "id", "orderId", "product", "volumeMl", "quantity", "dutyPence", "productionOrderId", "productionOrderCode", "stampOrderId", "stampOrderCode", "createdAt" ], "additionalProperties": false } } }, "required": [ "inventoryRetained", "releaseOperationId", "id", "kind", "reference", "customerName", "companyName", "eori", "vatNumber", "directorName", "address", "contactEmail", "phone", "notes", "ownFreeZone", "destination", "arc", "consignorExciseId", "consigneeExciseId", "movementStatus", "receivedAt", "orderDate", "createdBy", "createdAt", "dutyPence", "entries" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/vpd.integration.controller.ts" }, "OperationalVpdCreateVpdOrderDto": { "type": "object", "additionalProperties": false, "properties": { "kind": { "type": "string", "enum": [ "IMPORT", "UK_MANUFACTURED" ] }, "customerName": { "type": "string", "minLength": 1, "maxLength": 200 }, "date": { "type": "string", "minLength": 1, "description": "ISO date - imported date (IMPORT) or manufactured date (UK_MANUFACTURED)." }, "reference": { "type": "string", "maxLength": 120 }, "companyName": { "type": "string", "maxLength": 200 }, "eori": { "type": "string", "maxLength": 40 }, "vatNumber": { "type": "string", "maxLength": 40 }, "directorName": { "type": "string", "maxLength": 200 }, "address": { "type": "string", "maxLength": 1000 }, "contactEmail": { "type": "string", "maxLength": 200 }, "phone": { "type": "string", "maxLength": 60 }, "notes": { "type": "string", "maxLength": 2000 }, "ownFreeZone": { "type": "boolean", "description": "legacy: true = own warehouse / Free Zone. Prefer `destination`." }, "destination": { "type": "string", "enum": [ "OWN_WAREHOUSE", "CUSTOMER", "DUTY_SUSPENDED_CUSTOMER" ], "description": "OWN_WAREHOUSE (we are liable) | CUSTOMER (VPD due) | DUTY_SUSPENDED_CUSTOMER (recorded, no VPD)" }, "arc": { "type": "string", "maxLength": 40, "description": "EMCS movement (duty-suspended destination): e-AD reference, excise numbers, receipt" }, "consignorExciseId": { "type": "string", "maxLength": 40 }, "consigneeExciseId": { "type": "string", "maxLength": 40 }, "movementStatus": { "type": "string", "enum": [ "", "IN_MOVEMENT", "RECEIVED" ] }, "receivedAt": { "type": "string", "nullable": true, "description": "ISO date; '' / null clears" } }, "required": [ "kind", "customerName", "date" ], "x-generated-from": "backend/src/vpd/dto.ts", "description": "A VPD order: one customer's consignment + the due-diligence details." }, "IntegrationVpdController_updateOrder_Response": { "type": "object", "properties": { "inventoryRetained": { "type": "boolean" }, "releaseOperationId": { "type": "string", "nullable": true }, "id": { "type": "string" }, "kind": { "type": "string" }, "reference": { "type": "string" }, "customerName": { "type": "string" }, "companyName": { "type": "string" }, "eori": { "type": "string" }, "vatNumber": { "type": "string" }, "directorName": { "type": "string" }, "address": { "type": "string" }, "contactEmail": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "ownFreeZone": { "type": "boolean" }, "destination": { "type": "string" }, "arc": { "type": "string" }, "consignorExciseId": { "type": "string" }, "consigneeExciseId": { "type": "string" }, "movementStatus": { "type": "string" }, "receivedAt": { "type": "string", "nullable": true }, "orderDate": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" }, "dutyPence": { "type": "number" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "inventoryRetained": { "type": "boolean" }, "releaseOperationId": { "type": "string", "nullable": true }, "inventoryLotId": { "type": "string", "nullable": true }, "taxPointAt": { "type": "string", "nullable": true }, "volumeMlExact": { "type": "string", "nullable": true }, "ratePencePerMl": { "type": "string", "nullable": true }, "accountingTreatment": { "type": "string", "nullable": true }, "quantityUnit": { "type": "string" }, "provenance": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "orderId": { "type": "string", "nullable": true }, "product": { "type": "string" }, "volumeMl": { "type": "number" }, "quantity": { "type": "number" }, "dutyPence": { "type": "number" }, "productionOrderId": { "type": "string", "nullable": true }, "productionOrderCode": { "type": "string" }, "stampOrderId": { "type": "string", "nullable": true }, "stampOrderCode": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "inventoryRetained", "releaseOperationId", "inventoryLotId", "taxPointAt", "volumeMlExact", "ratePencePerMl", "accountingTreatment", "quantityUnit", "provenance", "id", "orderId", "product", "volumeMl", "quantity", "dutyPence", "productionOrderId", "productionOrderCode", "stampOrderId", "stampOrderCode", "createdAt" ], "additionalProperties": false } } }, "required": [ "inventoryRetained", "releaseOperationId", "id", "kind", "reference", "customerName", "companyName", "eori", "vatNumber", "directorName", "address", "contactEmail", "phone", "notes", "ownFreeZone", "destination", "arc", "consignorExciseId", "consigneeExciseId", "movementStatus", "receivedAt", "orderDate", "createdBy", "createdAt", "dutyPence", "entries" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/vpd.integration.controller.ts" }, "OperationalVpdUpdateVpdOrderDto": { "type": "object", "additionalProperties": false, "properties": { "kind": { "type": "string", "enum": [ "IMPORT", "UK_MANUFACTURED" ] }, "ownFreeZone": { "type": "boolean" }, "destination": { "type": "string", "enum": [ "OWN_WAREHOUSE", "CUSTOMER", "DUTY_SUSPENDED_CUSTOMER" ] }, "arc": { "type": "string", "maxLength": 40, "description": "EMCS movement (duty-suspended destination): e-AD reference, excise numbers, receipt" }, "consignorExciseId": { "type": "string", "maxLength": 40 }, "consigneeExciseId": { "type": "string", "maxLength": 40 }, "movementStatus": { "type": "string", "enum": [ "", "IN_MOVEMENT", "RECEIVED" ] }, "receivedAt": { "type": "string", "nullable": true, "description": "ISO date; '' / null clears" }, "customerName": { "type": "string", "minLength": 1, "maxLength": 200 }, "date": { "type": "string" }, "reference": { "type": "string", "maxLength": 120 }, "companyName": { "type": "string", "maxLength": 200 }, "eori": { "type": "string", "maxLength": 40 }, "vatNumber": { "type": "string", "maxLength": 40 }, "directorName": { "type": "string", "maxLength": 200 }, "address": { "type": "string", "maxLength": 1000 }, "contactEmail": { "type": "string", "maxLength": 200 }, "phone": { "type": "string", "maxLength": 60 }, "notes": { "type": "string", "maxLength": 2000 } }, "x-generated-from": "backend/src/vpd/dto.ts", "description": "Partial update of an order's details (any field optional)." }, "IntegrationVpdController_removeOrder_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/vpd.integration.controller.ts" }, "IntegrationVpdController_addEntry_Response": { "type": "object", "properties": { "inventoryRetained": { "type": "boolean" }, "releaseOperationId": { "type": "string", "nullable": true }, "inventoryLotId": { "type": "string", "nullable": true }, "taxPointAt": { "type": "string", "nullable": true }, "volumeMlExact": { "type": "string", "nullable": true }, "ratePencePerMl": { "type": "string", "nullable": true }, "accountingTreatment": { "type": "string", "nullable": true }, "quantityUnit": { "type": "string" }, "provenance": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "boolean" }, { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "object", "properties": { "length": { "type": "number" }, "__@unscopables@140": { "type": "object", "properties": { "length": { "type": "boolean", "nullable": true }, "toString": { "type": "boolean", "nullable": true }, "toLocaleString": { "type": "boolean", "nullable": true }, "pop": { "type": "boolean", "nullable": true }, "push": { "type": "boolean", "nullable": true }, "concat": { "type": "boolean", "nullable": true }, "join": { "type": "boolean", "nullable": true }, "reverse": { "type": "boolean", "nullable": true }, "shift": { "type": "boolean", "nullable": true }, "slice": { "type": "boolean", "nullable": true }, "sort": { "type": "boolean", "nullable": true }, "splice": { "type": "boolean", "nullable": true }, "unshift": { "type": "boolean", "nullable": true }, "indexOf": { "type": "boolean", "nullable": true }, "lastIndexOf": { "type": "boolean", "nullable": true }, "every": { "type": "boolean", "nullable": true }, "some": { "type": "boolean", "nullable": true }, "forEach": { "type": "boolean", "nullable": true }, "map": { "type": "boolean", "nullable": true }, "filter": { "type": "boolean", "nullable": true }, "reduce": { "type": "boolean", "nullable": true }, "reduceRight": { "type": "boolean", "nullable": true }, "find": { "type": "boolean", "nullable": true }, "findIndex": { "type": "boolean", "nullable": true }, "fill": { "type": "boolean", "nullable": true }, "copyWithin": { "type": "boolean", "nullable": true }, "entries": { "type": "boolean", "nullable": true }, "keys": { "type": "boolean", "nullable": true }, "values": { "type": "boolean", "nullable": true }, "includes": { "type": "boolean", "nullable": true }, "flatMap": { "type": "boolean", "nullable": true }, "flat": { "type": "boolean", "nullable": true }, "at": { "type": "boolean", "nullable": true }, "__@iterator@138": { "type": "boolean", "nullable": true }, "__@unscopables@140": { "type": "boolean", "nullable": true } }, "additionalProperties": false } }, "required": [ "length", "__@unscopables@140" ], "additionalProperties": false } ], "nullable": true }, "id": { "type": "string" }, "orderId": { "type": "string", "nullable": true }, "product": { "type": "string" }, "volumeMl": { "type": "number" }, "quantity": { "type": "number" }, "dutyPence": { "type": "number" }, "productionOrderId": { "type": "string", "nullable": true }, "productionOrderCode": { "type": "string" }, "stampOrderId": { "type": "string", "nullable": true }, "stampOrderCode": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "inventoryRetained", "releaseOperationId", "inventoryLotId", "taxPointAt", "volumeMlExact", "ratePencePerMl", "accountingTreatment", "quantityUnit", "provenance", "id", "orderId", "product", "volumeMl", "quantity", "dutyPence", "productionOrderId", "productionOrderCode", "stampOrderId", "stampOrderCode", "createdAt" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/vpd.integration.controller.ts" }, "OperationalVpdCreateVpdEntryDto": { "type": "object", "additionalProperties": false, "properties": { "product": { "type": "string", "minLength": 1, "maxLength": 200 }, "volumeMl": { "type": "number", "minimum": 0.01, "maximum": 100000 }, "quantity": { "type": "integer", "minimum": 1, "maximum": 100000000 }, "productionOrderId": { "type": "string", "maxLength": 60, "description": "when releasing part of a UK production order, its id (bottles come out\r\nof that order's duty-suspended balance)." }, "stampOrderId": { "type": "string", "maxLength": 60, "description": "when releasing part of an imported (stamp) order, its id." } }, "required": [ "product", "volumeMl", "quantity" ], "x-generated-from": "backend/src/vpd/dto.ts", "description": "A product line within an order." }, "IntegrationVpdController_removeEntry_Response": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": [ "ok" ], "additionalProperties": false, "x-generated-from": "backend/src/developer/vpd.integration.controller.ts" } } } }