{ "info": { "name": "VapeTax — scoped operations and isolated warehouse pilot v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Catalogue plus explicitly enabled isolated simulation/sandbox inventory/release pilot. LIVE releases are disabled. All example IDs, stamp codes, evidence and timestamps are fictional placeholders. Replace them with verified isolated fixtures; examples cannot establish inventory or authority. Keep apiKey and ownerAccessToken private and empty in exported collections. Persist release payload and idempotencyKey before sending, retry identical values after timeout, recover by externalDespatchId and poll status. Local release, VPD accounting and SICPA delivery are separate outcomes. Never equate SIMULATED, QUEUED or sandbox confirmation to live confirmation." }, "variable": [ { "key": "baseUrl", "value": "http://localhost:4000" }, { "key": "apiKey", "value": "" }, { "key": "ownerAccessToken", "value": "" }, { "key": "integrationId", "value": "" }, { "key": "keyId", "value": "" }, { "key": "idempotencyKey", "value": "catalogue-batch-001" }, { "key": "warehouseId", "value": "" }, { "key": "productId", "value": "" }, { "key": "manifestId", "value": "" }, { "key": "releaseId", "value": "" }, { "key": "releaseIdempotencyKey", "value": "fictional-despatch-001-v1" }, { "key": "id", "value": "" }, { "key": "sourceWarehouseId", "value": "" }, { "key": "destinationWarehouseId", "value": "" }, { "key": "transferIdempotencyKey", "value": "EXAMPLE-TRANSFER-001-v1" }, { "key": "allocationIdempotencyKey", "value": "EXAMPLE-ALLOCATION-001-v1" } ], "item": [ { "name": "Product API", "item": [ { "name": "Capabilities", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/capabilities", "description": "Any valid integration key. Check environment and limits." }, "response": [] }, { "name": "List catalogue — first page", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/products", "description": "products:read. Follow nextCursor using ?cursor=; page size is 100." }, "response": [] }, { "name": "Import products — retry same body and key", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{idempotencyKey}}" } ], "url": "{{baseUrl}}/integrations/v1/products/import", "description": "products:write. 201 first acceptance; 200 replay with same import ID. Change the example external product IDs for a genuinely new batch, never just to bypass an uncertain previous request.", "body": { "mode": "raw", "raw": "{\n \"products\": [\n {\n \"externalProductId\": \"EXAMPLE-BLUE-10ML\",\n \"name\": \"Blueberry 10ml\",\n \"sku\": \"BLUE-10ML\",\n \"brand\": \"Example\",\n \"volumeMl\": 10,\n \"barcodes\": [\n {\n \"code\": \"BLUE10-ITEM\",\n \"level\": \"ITEM\",\n \"unitsPerPack\": 1\n },\n {\n \"code\": \"BLUE10-PACK5\",\n \"level\": \"PACK\",\n \"unitsPerPack\": 5,\n \"containsCode\": \"BLUE10-ITEM\",\n \"containsQty\": 5\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Owner management — browser JWT only", "item": [ { "name": "Developer overview", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/developer", "description": "UK owner only; read allowed while API is disabled." }, "response": [] }, { "name": "Create integration", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/developer/integrations", "description": "Creates an integration; retain returned id.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Warehouse catalogue\",\n \"system\": \"OrderWise\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create scoped key — shown once", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/developer/integrations/{{integrationId}}/keys", "description": "Returned key is a secret. Store only in private secret configuration. Max two active keys.", "body": { "mode": "raw", "raw": "{\n \"scopes\": [\n \"products:read\",\n \"products:write\"\n ],\n \"expiresInDays\": 30\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Revoke key", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/developer/keys/{{keyId}}", "description": "Stops this key accepting new requests immediately." }, "response": [] }, { "name": "Disable integration", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/developer/integrations/{{integrationId}}/disable", "description": "Stops all keys for this integration; keeps catalogue/history." }, "response": [] } ] }, { "name": "Warehouse pilot API", "item": [ { "name": "List verified warehouses", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/warehouses", "description": "" }, "response": [] }, { "name": "Stage fictional manifest — replace fixtures first", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/inventory-manifests", "body": { "mode": "raw", "raw": "{\n \"externalInventoryReference\": \"fictional-opening-001\",\n \"version\": 1,\n \"warehouseId\": \"{{warehouseId}}\",\n \"productId\": \"{{productId}}\",\n \"volumeMl\": \"10.000\",\n \"inventoryAt\": \"2026-10-14T10:00:00+01:00\",\n \"ownershipEvidence\": \"FICTIONAL — replace with reviewed ownership evidence\",\n \"activationEvidence\": \"FICTIONAL — replace with independently verified activation evidence\",\n \"source\": {\n \"type\": \"EXTERNAL_IMPORT\",\n \"reference\": \"fictional-import-batch-001\",\n \"actualQuantity\": 1,\n \"evidenceReference\": \"FICTIONAL — replace with source quantity and import evidence\"\n },\n \"lots\": [\n {\n \"reference\": \"suspended-opening\",\n \"treatment\": \"NEW_RELEASE\",\n \"stampCodes\": [\n \"UKVDSDRY/FAKEEXAMPLE01\"\n ]\n }\n ],\n \"aggregates\": []\n}", "options": { "raw": { "language": "json" } } }, "description": "" }, "response": [] }, { "name": "Read manifest approval status", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/inventory-manifests/{{manifestId}}", "description": "" }, "response": [] }, { "name": "Preview release and VPD", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/release-validations", "body": { "mode": "raw", "raw": "{\n \"externalDespatchId\": \"fictional-despatch-001\",\n \"externalOrderId\": \"fictional-sales-order-001\",\n \"warehouseId\": \"{{warehouseId}}\",\n \"releasedAt\": \"2026-10-14T10:00:00+01:00\",\n \"releaseType\": \"UK_RELEASE_FOR_CONSUMPTION\",\n \"customer\": {\n \"reference\": \"fictional-customer\",\n \"name\": \"Fictional sandbox customer\"\n },\n \"operator\": {\n \"reference\": \"fictional-operator\"\n },\n \"stampCodes\": [\n \"UKVDSDRY/FAKEEXAMPLE01\"\n ],\n \"aggregationCodes\": []\n}", "options": { "raw": { "language": "json" } } }, "description": "" }, "response": [] }, { "name": "Accept local release and VPD", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{releaseIdempotencyKey}}" } ], "url": "{{baseUrl}}/integrations/v1/releases", "body": { "mode": "raw", "raw": "{\n \"externalDespatchId\": \"fictional-despatch-001\",\n \"externalOrderId\": \"fictional-sales-order-001\",\n \"warehouseId\": \"{{warehouseId}}\",\n \"releasedAt\": \"2026-10-14T10:00:00+01:00\",\n \"releaseType\": \"UK_RELEASE_FOR_CONSUMPTION\",\n \"customer\": {\n \"reference\": \"fictional-customer\",\n \"name\": \"Fictional sandbox customer\"\n },\n \"operator\": {\n \"reference\": \"fictional-operator\"\n },\n \"stampCodes\": [\n \"UKVDSDRY/FAKEEXAMPLE01\"\n ],\n \"aggregationCodes\": []\n}", "options": { "raw": { "language": "json" } } }, "description": "Requires approved holding. HTTP202 is local acceptance, not SICPA confirmation. Replay returns200. Persist the exact payload/key first." }, "response": [] }, { "name": "Poll independent release status", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/releases/{{releaseId}}", "description": "" }, "response": [] }, { "name": "Recover lost response by despatch ID", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/releases?externalDespatchId=fictional-despatch-001", "description": "" }, "response": [] } ] }, { "name": "Owner inventory review", "item": [ { "name": "Register reviewed pilot premises", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/developer/warehouses", "body": { "mode": "raw", "raw": "{\n \"reference\": \"fictional-premises\",\n \"name\": \"Fictional pilot warehouse\",\n \"locationUrn\": \"urn:lote:id:loc:WAA1aREPLACE\",\n \"machineUrn\": \"urn:lote:id:loc:WAA1aREPLACE\",\n \"verificationEvidence\": \"FICTIONAL — replace with verified premises/machine evidence\"\n}", "options": { "raw": { "language": "json" } } }, "description": "" }, "response": [] }, { "name": "List manifests", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/developer/inventory-manifests", "description": "" }, "response": [] }, { "name": "Review complete manifest", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/developer/inventory-manifests/{{manifestId}}", "description": "" }, "response": [] }, { "name": "Approve reviewed inventory", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/developer/inventory-manifests/{{manifestId}}/approve", "body": { "mode": "raw", "raw": "{\n \"reason\": \"REPLACE with actual inventory and source reconciliation findings\"\n}", "options": { "raw": { "language": "json" } } }, "description": "" }, "response": [] }, { "name": "Reject manifest", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/developer/inventory-manifests/{{manifestId}}/reject", "body": { "mode": "raw", "raw": "{\n \"reason\": \"REPLACE with actual failed checks and required corrections\"\n}", "options": { "raw": { "language": "json" } } }, "description": "" }, "response": [] }, { "name": "Read approved balances", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/developer/inventory-lots", "description": "" }, "response": [] }, { "name": "List account release history", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/developer/releases", "description": "" }, "response": [] }, { "name": "Download retained release evidence", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/developer/releases/{{releaseId}}/evidence", "description": "" }, "response": [] } ] }, { "name": "Contacts operations", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "Create — Contacts", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update — Contacts", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/contacts/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove — Contacts", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/contacts/{{id}}", "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." }, "response": [] }, { "name": "Contacts — Contacts", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/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." }, "response": [] }, { "name": "Contact — Contacts", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/contacts/{{id}}", "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." }, "response": [] } ] }, { "name": "Warehouse operations", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "Units — Inventory", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/inventory/units", "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." }, "response": [] }, { "name": "Lots — Inventory", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/inventory/lots", "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." }, "response": [] }, { "name": "Scans — Inventory", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/inventory/scans", "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." }, "response": [] }, { "name": "Aggregations — Inventory", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/inventory/aggregations", "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." }, "response": [] }, { "name": "Transfer — Inventory", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "idempotency-key", "value": "{{transferIdempotencyKey}}" } ], "url": "{{baseUrl}}/integrations/v1/inventory/transfers", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{\n \"externalTransferId\": \"EXAMPLE-TRANSFER-001\",\n \"fromWarehouseId\": \"{{sourceWarehouseId}}\",\n \"toWarehouseId\": \"{{destinationWarehouseId}}\",\n \"movementType\": \"DUTY_SUSPENDED_TRANSFER\",\n \"occurredAt\": \"2026-10-15T10:00:00+01:00\",\n \"custodyEvidence\": \"FICTIONAL — replace with verified custody and departure/arrival evidence\",\n \"authorityEvidence\": \"FICTIONAL — replace with actual authorised movement evidence\",\n \"stampCodes\": [\n \"UKVDSDRY/FAKEEXAMPLE01\"\n ],\n \"aggregationCodes\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Transfers — Inventory", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/inventory/transfers", "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." }, "response": [] }, { "name": "Transfer Detail — Inventory", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/inventory/transfers/{{id}}", "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." }, "response": [] }, { "name": "Reserve — Orders", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "idempotency-key", "value": "{{allocationIdempotencyKey}}" } ], "url": "{{baseUrl}}/integrations/v1/order-allocations", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{\n \"externalAllocationId\": \"EXAMPLE-ALLOCATION-001\",\n \"externalOrderId\": \"EXAMPLE-ORDER-001\",\n \"warehouseId\": \"{{warehouseId}}\",\n \"stampCodes\": [\n \"UKVDSDRY/FAKEEXAMPLE01\"\n ],\n \"aggregationCodes\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Allocations — Orders", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/order-allocations", "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." }, "response": [] }, { "name": "Allocation — Orders", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/order-allocations/{{id}}", "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." }, "response": [] }, { "name": "Cancel — Orders", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/order-allocations/{{id}}/cancel", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{\n \"reason\": \"Example order amended; release the unreleased reservation only.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Owner management", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "Cancel — OWNER", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ownerAccessToken}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/developer/order-allocations/{{id}}/cancel", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Products operations", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "Catalogue — Products", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue", "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." }, "response": [] }, { "name": "Product — Products", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue/{{id}}", "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." }, "response": [] }, { "name": "Lookup — Products", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue/lookup", "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." }, "response": [] }, { "name": "Create — Products", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Liquid 10ml\",\n \"sku\": \"EXAMPLE-10\",\n \"volumeMl\": 10,\n \"recipe\": {\n \"pgMl\": 4,\n \"vgMl\": 6\n },\n \"barcodes\": [\n {\n \"code\": \"EXAMPLE-ITEM\",\n \"level\": \"ITEM\"\n },\n {\n \"code\": \"EXAMPLE-PACK5\",\n \"level\": \"PACK\",\n \"containsCode\": \"EXAMPLE-ITEM\",\n \"containsQty\": 5\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Barcode — Products", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue/barcodes/{{barcodeId}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove Barcode — Products", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue/barcodes/{{barcodeId}}", "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." }, "response": [] }, { "name": "Link Aggregate — Products", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue/aggregates/{{aggregateId}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update — Products", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove — Products", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue/{{id}}", "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." }, "response": [] }, { "name": "Add Barcode — Products", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/catalogue/{{id}}/barcodes", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Production operations", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "Production Orders — Production", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders", "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." }, "response": [] }, { "name": "Production — Production", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}", "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." }, "response": [] }, { "name": "Create — Production", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{\n \"client\": \"Example Customer\",\n \"product\": \"Example Liquid 10ml\",\n \"productId\": \"{{productId}}\",\n \"sku\": \"EXAMPLE-10\",\n \"batch\": \"EXAMPLE-BATCH-001\",\n \"expiryDate\": \"2027-10-15\",\n \"planned\": {\n \"bottlesPlanned\": 100,\n \"pgPlanned\": 400,\n \"vgPlanned\": 600\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Import Many — Production", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/import", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update — Production", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Start — Production", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}/start", "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." }, "response": [] }, { "name": "Complete — Production", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}/complete", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Save Actuals — Production", "request": { "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}/actuals", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove — Production", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}", "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." }, "response": [] }, { "name": "Upload Invoice — Production", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}/invoice", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Download Invoice — Production", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}/invoice", "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." }, "response": [] }, { "name": "Delete Invoice — Production", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/production-orders/{{id}}/invoice", "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." }, "response": [] } ] }, { "name": "Purchases operations", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "Purchase Orders — Purchases", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders", "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." }, "response": [] }, { "name": "Purchase — Purchases", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders/{{id}}", "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." }, "response": [] }, { "name": "Create — Purchases", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update — Purchases", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Set Status — Purchases", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders/{{id}}/status", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove — Purchases", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders/{{id}}", "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." }, "response": [] }, { "name": "Upload Invoice — Purchases", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders/{{id}}/invoice", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Download Invoice — Purchases", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders/{{id}}/invoice", "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." }, "response": [] }, { "name": "Delete Invoice — Purchases", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/purchase-orders/{{id}}/invoice", "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." }, "response": [] } ] }, { "name": "Stock operations", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "Stock — Stock", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/{{resource}}", "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." }, "response": [] }, { "name": "Add Pgvg — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/pgvg", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{\n \"type\": \"PG\",\n \"qtyMl\": 1000,\n \"batch\": \"EXAMPLE-INGREDIENT-001\",\n \"expiryDate\": \"2027-10-15\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Edit Pgvg Log — Stock", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/pgvg/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Pgvg Log — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/pgvg/{{id}}", "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." }, "response": [] }, { "name": "Add Nicotine — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/nicotine", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Edit Nic Log — Stock", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/nicotine/log/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Nic Log — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/nicotine/log/{{id}}", "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." }, "response": [] }, { "name": "Delete Nicotine Stock — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/nicotine/{{id}}", "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." }, "response": [] }, { "name": "Convert Nicotine — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/nicotine/convert", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add Sweetener Powder — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/sweetener/powder", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add Sweetener Liquid — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/sweetener/liquid", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Convert Sweetener — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/sweetener/convert", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Sweetener Log — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/sweetener/log/{{id}}", "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." }, "response": [] }, { "name": "Add Cbd — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/cbd", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Convert Cbd — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/cbd/convert", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Cbd Log — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/cbd/log/{{id}}", "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." }, "response": [] }, { "name": "Delete Cbd Stock — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/cbd/{{id}}", "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." }, "response": [] }, { "name": "Create Flavouring — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/flavourings", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add Flavouring Stock — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/flavourings/{{id}}/add", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Flavouring — Stock", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/flavourings/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Edit Flav Log — Stock", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/flavourings/log/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Flav Log — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/flavourings/log/{{id}}", "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." }, "response": [] }, { "name": "Delete Flavouring — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/flavourings/{{id}}", "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." }, "response": [] }, { "name": "Add Label — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/labels", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add Label Stock — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/labels/{{id}}/add", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Edit Lbl Log — Stock", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/labels/log/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Lbl Log — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/labels/log/{{id}}", "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." }, "response": [] }, { "name": "Delete Label Sku — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/labels/{{id}}", "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." }, "response": [] }, { "name": "Add Bottle — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/bottles", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add Bottle Stock — Stock", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/bottles/{{id}}/add", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Edit Bottle Log — Stock", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/bottles/log/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Bottle Log — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/bottles/log/{{id}}", "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." }, "response": [] }, { "name": "Delete Bottle Size — Stock", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stock/bottles/{{id}}", "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." }, "response": [] } ] }, { "name": "Stamps operations", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "Stamp Orders — Stamps", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamp-orders", "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." }, "response": [] }, { "name": "Manufacturers — Stamps", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/manufacturers", "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." }, "response": [] }, { "name": "Verify Scans — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/scans/verify", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Activate Stamps — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/activate", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Activate And Pack — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/activate-pack", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Destroy Stamps — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/destroy", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Ship Stamps — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/ship", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Receive Stamps — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/receive", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create Aggregate — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/aggregates", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create Master Aggregate — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/aggregates/master", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Aggregates — Stamps", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/aggregates", "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." }, "response": [] }, { "name": "List Aggregate Stamps — Stamps", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/aggregates/{{id}}/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." }, "response": [] }, { "name": "Break Aggregate — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/aggregates/{{id}}/break", "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." }, "response": [] }, { "name": "Create Manufacturer — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/manufacturers", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Manufacturer — Stamps", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/manufacturers/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Manufacturer — Stamps", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/manufacturers/{{id}}", "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." }, "response": [] }, { "name": "Import Agg Codes — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/agg-codes/import", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Agg Code Summary — Stamps", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/agg-codes", "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." }, "response": [] }, { "name": "Case Labels — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/case-labels", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Save Scan Photos — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/scan-photos", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Scan Photos — Stamps", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/scan-photos", "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." }, "response": [] }, { "name": "Get Scan Photo — Stamps", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/scan-photos/{{id}}/file", "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." }, "response": [] }, { "name": "Create Order — Stamps", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Order — Stamps", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Order — Stamps", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/stamps/{{id}}", "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." }, "response": [] } ] }, { "name": "Vpd operations", "description": "Generated operational routes. Select requests deliberately; do not run mutations as a bulk collection. Replace every placeholder using isolated fixtures and read the API guide first.", "item": [ { "name": "List — Vpd", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/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." }, "response": [] }, { "name": "Production Orders — Vpd", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/vpd/production-orders", "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." }, "response": [] }, { "name": "Import Orders — Vpd", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/vpd/import-orders", "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." }, "response": [] }, { "name": "Create Order — Vpd", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/vpd/orders", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Order — Vpd", "request": { "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/vpd/orders/{{id}}", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove Order — Vpd", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/vpd/orders/{{id}}", "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." }, "response": [] }, { "name": "Add Entry — Vpd", "request": { "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/vpd/orders/{{id}}/entries", "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. Replace fictional values with authorised isolated fixtures; see the matching OpenAPI request schema for every accepted field.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove Entry — Vpd", "request": { "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "url": "{{baseUrl}}/integrations/v1/vpd/entries/{{id}}", "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." }, "response": [] } ] } ] }