{ "info": { "_postman_id": "95b0daea-f4d6-4ec9-97d6-12237c624285", "name": "CartonCloud Public API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Starter collection for the CartonCloud public API. Import this JSON into Postman or Bruno. OpenAPI on https://api-docs.cartoncloud.com is the contract; this collection can lag." }, "item": [ { "name": "Auth", "item": [ { "name": "User Info", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/uaa/userinfo", "host": [ "{{gatewayHost}}" ], "path": [ "uaa", "userinfo" ] } }, "response": [] } ] }, { "name": "Customers", "item": [ { "name": "List - Customers", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/customers", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "customers" ] } }, "response": [] }, { "name": "Get - Customer", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/customers/{{customerUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "customers", "{{customerUuid}}" ] } }, "response": [] }, { "name": "Create Customer", "request": { "method": "POST", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}" } ], "body": { "mode": "raw", "raw": "{\n \"scope\": \"CUSTOMER\",\n \"references\": {\n \"code\": \"TEST_CODE\"\n },\n \"warehouses\": [\n {\n \"id\": \"bbe1b844-f016-11ec-a36a-0296022725e2\"\n }\n ],\n \"name\": \"Test name\",\n \"email\": \"user@example.com\",\n \"telephone\": \"0400 000 000\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/customers", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "customers" ] } }, "response": [] } ] }, { "name": "Consignments", "item": [ { "name": "Add - Consignments", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"id\": \"885649de-4036-434c-957d-da29c7195656\",\r\n \"references\": {\r\n \"customer\": \"INV-12-06-2026\",\r\n \"numericId\": \"20334\"\r\n },\r\n \"properties\": {\r\n \"serviceType\": \"Standard\",\r\n \"collect.collectonly\": false,\r\n \"cdcfGeneralBoolean\": true,\r\n \"ConCustField\": 0\r\n },\r\n \"measures\": {\r\n \"distance\": {\r\n \"value\": 0,\r\n \"unit\": \"km\"\r\n },\r\n \"hours\": 0\r\n },\r\n \"type\": \"CONSIGNMENT\",\r\n \"status\": \"IN_WAREHOUSE\",\r\n \"customer\": {\r\n \"id\": \"c3b1a598-c085-11e8-85b4-02a6cf3a00de\",\r\n \"references\": {\r\n \"code\": \"ABC001\"\r\n },\r\n \"name\": \"Company Pty Ltd\",\r\n \"enabled\": true\r\n },\r\n \"warehouse\": {\r\n \"id\": \"93d11a9a-cb7d-11e8-8b31-0260b3a835bc\",\r\n \"name\": \"Default\",\r\n \"enabled\": true\r\n },\r\n \"version\": 52,\r\n \"createDate\": \"2026-07-21\",\r\n \"lastModified\": \"2026-08-10 10:38:40\",\r\n \"source\": \"Repeating Job\",\r\n \"lifecycleState\": {\r\n \"actions\": {\r\n \"ITEM_EDIT\": {\r\n \"allowed\": true\r\n },\r\n \"CASH_ON_DELIVERY_AVAILABLE\": {\r\n \"allowed\": true\r\n },\r\n \"REQUIRE_POD_PHOTOS\": {\r\n \"allowed\": true\r\n }\r\n }\r\n },\r\n \"details\": {\r\n \"manifest\": {\r\n \"id\": \"1f6f94e2-67f8-42ed-b3e5-6f9dea4878d5\"\r\n },\r\n \"type\": \"DELIVERY\",\r\n \"invoiceValue\": {\r\n \"amount\": 1,\r\n \"currency\": \"SLL\"\r\n },\r\n \"authorityToLeave\": false,\r\n \"deliveryRun\": {\r\n \"id\": \"7b348be1-e186-11e8-8b31-0260b3a835bc\",\r\n \"name\": \"COLLECT (DEFAULT)\",\r\n \"warehouse\": {\r\n \"id\": \"93d11a9a-cb7d-11e8-8b31-0260b3a835bc\",\r\n \"name\": \"Default\",\r\n \"enabled\": true\r\n }\r\n },\r\n \"collect\": {\r\n \"address\": {\r\n \"id\": \"c6235681-1856-42dc-aa26-80d913937ed5\",\r\n \"references\": {\r\n \"code\": \"\",\r\n \"numericId\": \"116\"\r\n },\r\n \"properties\": {\r\n \"collectAddressField\": false,\r\n \"collectonly\": true,\r\n \"boo\": false,\r\n \"dateCf1\": \"2022-10-01\",\r\n \"onforwarderAddressField\": \"Onforwarder address field mapped through\"\r\n },\r\n \"companyName\": \"Company Pty Ltd\",\r\n \"contactName\": \"Johnny User\",\r\n \"address1\": \"1 Example Street\",\r\n \"suburb\": \"Example Suburb\",\r\n \"state\": {\r\n \"name\": \"Queensland\",\r\n \"code\": \"QLD\"\r\n },\r\n \"postcode\": \"2000\",\r\n \"country\": {\r\n \"name\": \"Australia\",\r\n \"iso2Code\": \"AU\",\r\n \"iso3Code\": \"AUS\"\r\n },\r\n \"enabled\": true,\r\n \"approved\": true,\r\n \"draft\": false,\r\n \"starred\": false,\r\n \"phone\": \"0400 000 000\",\r\n \"email\": \"user@example.com\"\r\n }\r\n },\r\n \"deliver\": {\r\n \"address\": {\r\n \"id\": \"f7f5be7e-be97-4771-9b39-897c393b35ed\",\r\n \"references\": {\r\n \"code\": \"\",\r\n \"numericId\": \"1008\"\r\n },\r\n \"properties\": {\r\n \"collectAddressField\": false,\r\n \"collectonly\": true,\r\n \"boo\": false\r\n },\r\n \"companyName\": \"Company Pty Ltd\",\r\n \"contactName\": \"Johnny User\",\r\n \"address1\": \"1 Example Street\",\r\n \"suburb\": \"Example Suburb\",\r\n \"state\": {\r\n \"name\": \"Queensland\",\r\n \"code\": \"QLD\"\r\n },\r\n \"postcode\": \"2000\",\r\n \"country\": {\r\n \"name\": \"Australia\",\r\n \"iso2Code\": \"AU\",\r\n \"iso3Code\": \"AUS\"\r\n },\r\n \"enabled\": true,\r\n \"approved\": true,\r\n \"draft\": false,\r\n \"starred\": false,\r\n \"phone\": \"0400 000 000\",\r\n \"email\": \"user@example.com\"\r\n },\r\n \"instructions\": \"\"\r\n }\r\n },\r\n \"items\": [\r\n {\r\n \"id\": \"e9a01b38-60d0-49ce-9ec8-06e79854a67c\",\r\n \"properties\": {\r\n \"length\": 0.123,\r\n \"height\": 0.123,\r\n \"width\": 0.123,\r\n \"ciBoolean\": true,\r\n \"description\": \"Test\"\r\n },\r\n \"measures\": {\r\n \"cubic\": 0.002,\r\n \"weight\": 0,\r\n \"pallets\": 1,\r\n \"quantity\": 12\r\n },\r\n \"type\": \"TRANSPORT_ITEM\",\r\n \"details\": {\r\n \"product\": {\r\n \"id\": \"014191c5-c25d-4a91-9d06-9d426121c98f\",\r\n \"references\": {\r\n \"code\": \"1\"\r\n },\r\n \"name\": \"Test\"\r\n },\r\n \"job\": {\r\n \"id\": \"885649de-4036-434c-957d-da29c7195656\"\r\n },\r\n \"cubicMultiplierField\": \"pallets\",\r\n \"status\": \"VERIFIED\"\r\n },\r\n \"items\": [\r\n {\r\n \"id\": \"4ecc1c80-83d1-448f-9f6d-a48e82512134\",\r\n \"references\": {\r\n \"label\": \"CTNCLD0000020332001\",\r\n \"barcode\": \"CTNCLD0000020332001\"\r\n },\r\n \"type\": \"TRANSPORT_SUB_ITEM\"\r\n },\r\n {\r\n \"id\": \"7943db16-4381-433a-9d8b-85c4bde3c94b\",\r\n \"references\": {\r\n \"label\": \"CTNCLD0000020332002\",\r\n \"barcode\": \"CTNCLD0000020332002\"\r\n },\r\n \"type\": \"TRANSPORT_SUB_ITEM\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"areChargesEditable\": true,\r\n \"isGroup\": false,\r\n \"errorCount\": 0,\r\n \"hasChildren\": false,\r\n \"carrier\": \"d6205047-4c76-11ea-81f9-02f571197e1c\"\r\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/consignments", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "consignments" ] } }, "response": [] }, { "name": "Get - Consignment", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "1", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/consignments/{{consignmentUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "consignments", "{{consignmentUuid}}" ] } }, "response": [] }, { "name": "Get - Consignment Copy", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "1", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/consignments/{{consignmentUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "consignments", "{{consignmentUuid}}" ] } }, "response": [] }, { "name": "Search - Consignments", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" }, { "key": "Prefer", "value": "return=minimal", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"condition\": {\r\n \"type\": \"OrCondition\",\r\n \"conditions\": [\r\n {\r\n \"type\": \"AndCondition\",\r\n \"conditions\": [\r\n {\r\n \"type\": \"TextComparisonCondition\",\r\n \"field\": {\r\n \"type\": \"ValueField\",\r\n \"value\": \"reference\"\r\n },\r\n \"value\": {\r\n \"type\": \"ValueField\",\r\n \"value\": \"INV-0111\"\r\n },\r\n \"method\": \"EQUAL_TO\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/consignments/search", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "consignments", "search" ] } }, "response": [] } ] }, { "name": "Definitions", "item": [ { "name": "Activity", "item": [ { "name": "Get - Inbound Activity Definition (Purchase Order)", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/definitions/activity/inbound?customerId={{customerUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "definitions", "activity", "inbound" ], "query": [ { "key": "inactiveCustomFields", "value": "true", "disabled": true }, { "key": "customerId", "value": "{{customerUuid}}" } ] } }, "response": [] }, { "name": "Get - Outbound Activity Definition (Sale Order)", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/definitions/activity/outbound?customerId={{customerUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "definitions", "activity", "outbound" ], "query": [ { "key": "inactiveCustomFields", "value": "true", "disabled": true }, { "key": "customerId", "value": "{{customerUuid}}" } ] } }, "response": [] }, { "name": "Get - Consignment Activity Definition", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/definitions/activity/transport?customerId={{customerUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "definitions", "activity", "transport" ], "query": [ { "key": "inactiveCustomFields", "value": "true", "disabled": true }, { "key": "customerId", "value": "{{customerUuid}}" } ] } }, "response": [] } ] } ] }, { "name": "Documents", "item": [ { "name": "Add - Document", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"type\": \"OUTBOUND_ORDER_INVOICE\",\r\n \"owner\": {\r\n \"type\": \"OUTBOUND\",\r\n \"id\": \"{{outboundOrderUuid}}\"\r\n },\r\n \"content\": {\r\n \"name\": \"Document.png\",\r\n \"data\": \"\"\r\n }\r\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/documents", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "documents" ] } }, "response": [] }, { "name": "Add - Document PDF", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"type\": \"OUTBOUND_ORDER_INVOICE\",\r\n \"owner\": {\r\n \"type\": \"OUTBOUND\",\r\n \"id\": \"{{outboundOrderUuid}}\"\r\n },\r\n \"content\": {\r\n \"name\": \"\",\r\n \"data\": \"\"\r\n }\r\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/documents", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "documents" ] } }, "response": [] } ] }, { "name": "Inbound Orders (Purchase Orders)", "item": [ { "name": "Add - Inbound Order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"type\": \"INBOUND\",\r\n \"status\": \"DRAFT\",\r\n \"references\": {\r\n \"customer\": \"REF-12345\"\r\n },\r\n \"customer\": {\r\n \"name\": \"Alderson's\"\r\n },\r\n \"warehouse\": {\r\n \"name\": \"Default\"\r\n },\r\n \"details\": {\r\n \"urgent\": true,\r\n \"instructions\": \"work hard\",\r\n \"arrivalDate\": \"2019-12-15\"\r\n },\r\n \"properties\": {\r\n \"transfer\": \"hello\"\r\n },\r\n \"items\": [\r\n {\r\n \"properties\": {\r\n \"expiryDate\": \"2020-10-25\",\r\n \"batchNumber\": \"AAAA\"\r\n },\r\n \"details\": {\r\n \"product\": {\r\n \"references\": {\r\n \"code\": \"JANE_TEST\"\r\n }\r\n },\r\n \"unitOfMeasure\": {\r\n \"type\": \"CTN\"\r\n }\r\n },\r\n \"measures\": {\r\n \t\"quantity\": 2\r\n }\r\n },\r\n {\r\n \"properties\": {\r\n \"expiryDate\": \"2020-01-22\",\r\n \"batchNumber\": \"BBBB\"\r\n },\r\n \"details\": {\r\n \"product\": {\r\n \"references\": {\r\n \"code\": \"STLWB/DW\"\r\n }\r\n },\r\n \"unitOfMeasure\": {\r\n \"type\": \"CTN\"\r\n } \r\n },\r\n \"measures\": {\r\n \t\"quantity\": 2\r\n }\r\n }\r\n ]\r\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/inbound-orders", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "inbound-orders" ] } }, "response": [] }, { "name": "Get - Inbound Order", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/inbound-orders/{{inboundOrderUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "inbound-orders", "{{inboundOrderUuid}}" ] } }, "response": [] }, { "name": "Delete - Inbound Order", "request": { "method": "DELETE", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/inbound-orders/{{inboundOrderUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "inbound-orders", "{{inboundOrderUuid}}" ] } }, "response": [] }, { "name": "Search - Inbound Order", "request": { "method": "GET", "header": [] }, "response": [] } ] }, { "name": "Outbound Orders (Sale Orders)", "item": [ { "name": "Documents", "item": [ { "name": "List - Outbound Order Invoices", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" }, { "key": "Prefer", "value": "return=minimal", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/outbound-orders/{{outboundOrderUuid}}/documents", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "outbound-orders", "{{outboundOrderUuid}}", "documents" ] } }, "response": [] }, { "name": "Get - Outbound Order Invoice", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/outbound-orders/{{outboundOrderUuid}}/documents/{{documentUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "outbound-orders", "{{outboundOrderUuid}}", "documents", "{{documentUuid}}" ] } }, "response": [] }, { "name": "Get - Download Outbound Order Invoice", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/outbound-orders/{{outboundOrderUuid}}/documents/{{documentUuid}}/download", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "outbound-orders", "{{outboundOrderUuid}}", "documents", "{{documentUuid}}", "download" ] } }, "response": [] }, { "name": "Add - Outbound Order Invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"type\": \"OUTBOUND_ORDER_INVOICE\",\r\n \"content\": {\r\n \"name\": \"Sample-Invoice.pdf\",\r\n \"data\": \"\"\r\n }\r\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/outbound-orders/{{outboundOrderUuid}}/documents", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "outbound-orders", "{{outboundOrderUuid}}", "documents" ] } }, "response": [] } ] }, { "name": "Add - Outbound Order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Version", "value": "{{apiVersion}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"type\": \"OUTBOUND\",\r\n \"references\": {\r\n \"customer\": \"EXAMPLE-REF\"\r\n },\r\n \"customer\": {\r\n \"id\": \"871ca13a-7f67-432d-bbc6-131fefae7e3a\"\r\n },\r\n \"warehouse\": {\r\n \"id\": \"568cd392-50b1-11f0-a32e-066c91bd21c5\"\r\n },\r\n \"details\": {\r\n \"allowSplitting\": false,\r\n \"collect\": {},\r\n \"deliver\": {\r\n \"method\": {\r\n \"type\": \"SHIPPING\",\r\n \"requestedService\": \"Free Shipping\"\r\n },\r\n \"address\": {\r\n \"contactName\": \"Johnny User\",\r\n \"address1\": \"1 Example Street\",\r\n \"city\": \"Example City\",\r\n \"postcode\": \"2000\",\r\n \"phone\": \"0400 000 000\",\r\n \"email\": \"user@example.com\",\r\n \"country\": {\r\n \"iso2Code\": \"NZ\"\r\n }\r\n },\r\n \"instructions\": \"\"\r\n },\r\n \"instructions\": \"\",\r\n \"urgent\": false\r\n },\r\n \"properties\": {},\r\n \"items\": [\r\n {\r\n \"details\": {\r\n \"product\": {\r\n \"references\": {\r\n \"code\": \"CB-C-DC-12\"\r\n }\r\n }\r\n },\r\n \"measures\": {\r\n \"quantity\": 1\r\n },\r\n \"externalMeta\": {\r\n \"fulfillmentOrder\": {\r\n \"lineItemId\": \"gid:\\/\\/shopify\\/Example\\/0\"\r\n }\r\n }\r\n }\r\n ],\r\n \"externalMeta\": {\r\n \"order\": {\r\n \"id\": \"gid:\\/\\/shopify\\/Example\\/0\"\r\n },\r\n \"fulfillmentOrder\": {\r\n \"id\": \"gid:\\/\\/shopify\\/Example\\/0\"\r\n },\r\n \"createShopifyFulfillments\": true\r\n }\r\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/outbound-orders", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "outbound-orders" ] } }, "response": [] }, { "name": "Get - Outbound Order", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/outbound-orders/{{outboundOrderUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "outbound-orders", "{{outboundOrderUuid}}" ] } }, "response": [] }, { "name": "Delete - Outbound Order", "request": { "method": "DELETE", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"details\": {\n \"urgent\": false,\n \"instructions\": \"\",\n \"collect\": {\n \"address\": {\n \"companyName\": \"Company Pty Ltd\",\n \"address1\": \"1 Example Street\",\n \"suburb\": \"Example Suburb\",\n \"city\": \"Example City\",\n \"state\": {\n \"name\": \"New South Wales\",\n \"code\": \"NSW\"\n },\n \"postcode\": \"2000\",\n \"country\": {\n \"name\": \"Australia\",\n \"iso2Code\": \"AU\",\n \"iso3Code\": \"AUS\"\n },\n \"location\": {\n \"lat\": \"-33.8688\",\n \"lon\": \"151.2093\"\n },\n \"enabled\": true,\n \"approved\": true,\n \"draft\": false,\n \"starred\": true,\n \"phone\": \"0400 000 000\",\n \"references\": {\n \"numericId\": \"1\"\n },\n \"id\": \"9f7c7089-2808-11e8-b886-0600d96f6c3e\"\n },\n \"requiredDate\": \"2021-07-01\"\n },\n \"deliver\": {\n \"address\": {\n \"companyName\": \"Company Pty Ltd\",\n \"address1\": \"1 Example Street\",\n \"suburb\": \"Example Suburb\",\n \"state\": {\n \"name\": \"New South Wales\",\n \"code\": \"NSW\"\n },\n \"postcode\": \"2000\",\n \"country\": {\n \"name\": \"Australia\",\n \"iso2Code\": \"AU\",\n \"iso3Code\": \"AUS\"\n },\n \"location\": {\n \"lat\": \"-33.8688\",\n \"lon\": \"151.2093\"\n },\n \"enabled\": true,\n \"approved\": true,\n \"draft\": false,\n \"starred\": false,\n \"phone\": \"0400 000 000\",\n \"references\": {\n \"code\": \"440\",\n \"numericId\": \"14508\"\n },\n \"id\": \"4dcd2d92-dcfa-4c6a-b076-fa693e12a899\"\n },\n \"requiredDate\": \"2021-07-02\",\n \"instructions\": \"\"\n }\n },\n \"items\": [\n {\n \"details\": {\n \"product\": {\n \"customer\": {\n \"enabled\": true,\n \"name\": \"Company Pty Ltd\",\n \"references\": {\n \"code\": \"EXAMPLE\"\n },\n \"id\": \"8f1e0a7e-c084-11e8-85b4-02a6cf3a00de\"\n },\n \"name\": \"TEST BEEF\",\n \"references\": {\n \"code\": \"12345555678\"\n },\n \"id\": \"a8aa52ee-360d-442a-9422-ec3fd2a23c44\"\n },\n \"unitOfMeasure\": {\n \"type\": \"UNIT\",\n \"name\": \"UNITS\"\n }\n },\n \"type\": \"ITEM\",\n \"measures\": {\n \"quantity\": 10\n },\n \"workflow\": {\n \"ENTER_CUSTOM_FIELD\": {\n \"field\": \"serialNumber\",\n \"regexMatch\": \"[193812938, 19832913]\",\n \"ui: {\n \"id\": \"1\"\n }\n },\n \"DIRECT_PICK\": {\n \"ui: {\n \"id\": \"1\"\n }\n }\n },\n },\n {\n \"details\": {\n \"product\": {\n \"customer\": {\n \"enabled\": true,\n \"name\": \"Company Pty Ltd\",\n \"references\": {\n \"code\": \"EXAMPLE\"\n },\n \"id\": \"8f1e0a7e-c084-11e8-85b4-02a6cf3a00de\"\n },\n \"name\": \"TEST BEEF\",\n \"references\": {\n \"code\": \"12345555678\"\n },\n \"id\": \"a8aa52ee-360d-442a-9422-ec3fd2a23c44\"\n },\n \"unitOfMeasure\": {\n \"type\": \"UNIT\",\n \"name\": \"UNITS\"\n }\n },\n \"type\": \"ITEM\",\n \"measures\": {\n \"quantity\": 10\n },\n \"properties\": {\n \"expiryDate\": \"2021-08-04\"\n },\n \"workflow\": {\n \"DIRECT_PICK\"\n }\n },\n {\n \"details\": {\n \"product\": {\n \"customer\": {\n \"enabled\": true,\n \"name\": \"Company Pty Ltd\",\n \"references\": {\n \"code\": \"EXAMPLE\"\n },\n \"id\": \"8f1e0a7e-c084-11e8-85b4-02a6cf3a00de\"\n },\n \"name\": \"TEST BEEF\",\n \"references\": {\n \"code\": \"12345555678\"\n },\n \"id\": \"a8aa52ee-360d-442a-9422-ec3fd2a23c44\"\n },\n \"unitOfMeasure\": {\n \"type\": \"UNIT\",\n \"name\": \"UNITS\"\n }\n },\n \"type\": \"ITEM\",\n \"measures\": {\n \"quantity\": 5\n },\n \"properties\": {\n \"expiryDate\": \"2021-08-04\"\n }\n }\n ],\n \"type\": \"OUTBOUND\",\n \"status\": \"PACKING_IN_PROGRESS\",\n \"customer\": {\n \"enabled\": true,\n \"name\": \"Company Pty Ltd\",\n \"references\": {\n \"code\": \"EXAMPLE\"\n },\n \"id\": \"8f1e0a7e-c084-11e8-85b4-02a6cf3a00de\"\n },\n \"warehouse\": {\n \"enabled\": true,\n \"name\": \"Sydney\",\n \"id\": \"3cf281c4-cb7d-11e8-8b31-0260b3a835bc\"\n },\n \"version\": 7,\n \"references\": {\n \"customer\": \"TEsting 123123\",\n \"numericId\": \"13673\"\n },\n \"id\": \"5843e0a9-cdfe-41a0-a6da-d1ed03dd7f25\"\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/outbound-orders/{{outboundOrderUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "outbound-orders", "{{outboundOrderUuid}}" ] } }, "response": [] }, { "name": "Search - Ourbound Orders", "request": { "method": "POST", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" }, { "key": "Prefer", "value": "return=minimal", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n \"condition\": {\r\n \"type\": \"OrCondition\",\r\n \"conditions\": [\r\n {\r\n \"type\": \"AndCondition\",\r\n \"conditions\": [\r\n {\r\n \"type\": \"TextComparisonCondition\",\r\n \"field\": {\r\n \"type\": \"ValueField\",\r\n \"value\": \"reference\"\r\n },\r\n \"value\": {\r\n \"type\": \"ValueField\",\r\n \"value\": \"REF\"\r\n },\r\n \"method\": \"STARTS_WITH\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/outbound-orders/search", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "outbound-orders", "search" ] } }, "response": [] } ] }, { "name": "Reports", "item": [ { "name": "POST - Add Report Run", "request": { "method": "POST", "header": [ { "key": "Accept-Version", "value": "1", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"type\": \"STOCK_ON_HAND\",\r\n \"parameters\": {\r\n \"pageSize\": 200000,\r\n \"warehouse\": {\r\n \"name\": \"Default\"\r\n },\r\n \"customer\": {\r\n \"name\": \"Alderson's\"\r\n },\r\n \"aggregateBy\": [\r\n \"expiryDate\",\r\n \"location\"\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/report-runs", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "report-runs" ] } }, "response": [] }, { "name": "GET - View Report Run Data", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "1", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/report-runs/{{reportRunUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "report-runs", "{{reportRunUuid}}" ] } }, "response": [] } ] }, { "name": "Transport Products", "item": [ { "name": "List - Products", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/products", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "products" ] } }, "response": [] }, { "name": "Get - Product", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "type": "text", "value": "{{apiVersion}}" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/products/{{transportProductUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "products", "{{transportProductUuid}}" ] } }, "response": [] }, { "name": "Add - Product", "request": { "method": "POST", "header": [ { "key": "Accept-Version", "type": "text", "value": "{{apiVersion}}" }, { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"scope\": \"TRANSPORT\",\n \"references\": {\n \"code\": \"FPLT\"\n },\n \"name\": \"Frozen Pallet\",\n \"details\": {\n \"uiOptions\": {\n \"consignmentItems\": {\n \"cubicCalculator\": {\n \"multiplierField\": \"PALLETS\"\n }\n }\n }\n },\n \"properties\": {\n \"width\": 1.2,\n \"height\": 1.2,\n \"length\": 1.2,\n \"customField\": \"XYZ\"\n }\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/products", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "products" ] } }, "response": [] }, { "name": "Edit - Product", "request": { "method": "PUT", "header": [ { "key": "Accept-Version", "type": "text", "value": "{{apiVersion}}" }, { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"scope\": \"TRANSPORT\",\n \"references\": {\n \"code\": \"FPLT\"\n },\n \"name\": \"Frozen Pallet\",\n \"details\": {\n \"uiOptions\": {\n \"consignmentItems\": {\n \"cubicCalculator\": {\n \"multiplierField\": \"PALLETS\"\n }\n }\n }\n },\n \"properties\": {\n \"width\": 1.2,\n \"height\": 1.2,\n \"length\": 1.2,\n \"customField\": \"ZYX\"\n }\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/products/{{transportProductUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "products", "{{transportProductUuid}}" ] } }, "response": [] }, { "name": "Product Search (coming soon)", "request": { "method": "POST", "header": [ { "key": "Accept-Version", "type": "text", "value": "{{apiVersion}}" }, { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"condition\": {\n \"type\": \"OrCondition\",\n \"conditions\": [\n {\n \"type\": \"AndCondition\",\n \"conditions\": [\n {\n \"type\": \"TextComparisonCondition\",\n \"field\": {\n \"type\": \"ValueField\",\n \"value\": \"references.code\"\n },\n \"value\": {\n \"type\": \"ValueField\",\n \"value\": \"FPLT\"\n },\n \"method\": \"STARTS_WITH\"\n }\n ]\n }\n ]\n }\n}" }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/products/search?SCOPE=TRANSPORT", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "products", "search" ], "query": [ { "key": "SCOPE", "value": "TRANSPORT" } ] } }, "response": [] }, { "name": "New Request", "request": { "method": "GET", "header": [] }, "response": [] } ] }, { "name": "Warehouse Products", "item": [ { "name": "Get - Warehouse product", "request": { "method": "GET", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/warehouse-products/{{warehouseProductUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "warehouse-products", "{{warehouseProductUuid}}" ] } }, "response": [] }, { "name": "Add - Warehouse product", "request": { "method": "POST", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"scope\": \"WAREHOUSE\",\r\n \"references\": {\r\n \"code\": \"ABC-123\"\r\n },\r\n \"customer\": {\r\n \"id\": \"{{customerUuid}}\"\r\n },\r\n \"type\": \"Chilled\",\r\n \"name\": \"Ice Cream\",\r\n \"details\": {\r\n \"variableWeight\": true,\r\n \"storage\": {\r\n \"chargeMethod\": \"PER_PALLET_QTY\"\r\n },\r\n \"inbound\": {\r\n \"initialStatus\": \"OK\"\r\n },\r\n \"stockSelection\": {\r\n \"method\": \"FEFO\",\r\n \"secondaryMethod\": \"MINIMISE_STORAGE\",\r\n \"strict\": false,\r\n \"expiryThresholdDays\": 10\r\n }\r\n },\r\n \"itemPropertyRequirements\": {\r\n \"expiry\": \"REQUIRED\",\r\n \"batchNumber\": \"REQUIRED_ON_OUTGOING\",\r\n \"optionalCf\": \"OPTIONAL\",\r\n \"requiredCf\": \"REQUIRED_ON_INCOMING\"\r\n },\r\n \"defaultUnitOfMeasure\": \"Carton\",\r\n \"unitOfMeasures\": {\r\n \"UNIT\": {\r\n \"baseQty\": 10,\r\n \"weight\": 1.249,\r\n \"volume\": 0.007\r\n },\r\n \"Carton\": {\r\n \"baseQty\": 1\r\n },\r\n \"PLT\": {\r\n \"baseQty\": 100\r\n }\r\n },\r\n \"notifications\": [\r\n {\r\n \"type\": \"STOCK_EXPIRY\",\r\n \"thresholdDays\": 15\r\n },\r\n {\r\n \"type\": \"STOCK_LOW\",\r\n \"thresholdCount\": 18\r\n }\r\n]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/warehouse-products", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "warehouse-products" ] } }, "response": [] }, { "name": "Edit - Warehouse product", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"description\": \"\",\r\n \"type\": \"General\",\r\n \"scope\": \"WAREHOUSE\",\r\n \"defaultUnitOfMeasure\": \"CTN\",\r\n \"customer\": {\r\n \"name\": \"Barooze Pty Ltd\"\r\n },\r\n \"details\": {\r\n \"variableWeight\": false,\r\n \"storage\": {\r\n \"chargeMethod\": \"PER_LOCATION\"\r\n },\r\n \"inbound\": {\r\n \"initialStatus\": \"OK\"\r\n },\r\n \"stockSelection\": {\r\n \"method\": \"FIFO\",\r\n \"secondaryMethod\": \"MINIMISE_STORAGE\",\r\n \"strict\": \"0\",\r\n \"expiryThresholdDays\": \"0\"\r\n }\r\n },\r\n \"itemPropertyRequirements\": {\r\n \"expiry\": \"OPTIONAL\",\r\n \"batchNumber\": \"REQUIRED\"\r\n },\r\n \"unitOfMeasures\": {\r\n \"CTN\": {\r\n \"baseQty\": \"1.000\",\r\n \"weight\": \"0.000\",\r\n \"volume\": \"0.000\"\r\n },\r\n \"PLT\": {\r\n \"baseQty\": \"52.000\"\r\n }\r\n },\r\n \"name\": \"Barooze Chocolate Porter\",\r\n \"references\": {\r\n \"code\": \"BCPORT\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/warehouse-products/{{warehouseProductUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "warehouse-products", "{{warehouseProductUuid}}" ] } }, "response": [] }, { "name": "Edit - Warehouse product", "request": { "method": "PATCH", "header": [ { "key": "Accept-Version", "value": "{{apiVersion}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"op\": \"remove\",\r\n \"path\": \"/itemPropertyRequirements/expiry\"\r\n },\r\n {\r\n \"op\": \"replace\",\r\n \"path\": \"/unitOfMeasures/UNIT/baseQty\",\r\n \"value\": 56\r\n }\r\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{gatewayHost}}/tenants/{{tenantUuid}}/warehouse-products/{{warehouseProductUuid}}", "host": [ "{{gatewayHost}}" ], "path": [ "tenants", "{{tenantUuid}}", "warehouse-products", "{{warehouseProductUuid}}" ] } }, "response": [] } ] } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "client_authentication", "value": "header", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" }, { "key": "accessTokenUrl", "value": "{{gatewayHost}}/uaa/oauth/token", "type": "string" }, { "key": "authUrl", "value": "{{gatewayHost}}/uaa/oauth/authorize", "type": "string" }, { "key": "redirect_uri", "value": "http://example.com", "type": "string" }, { "key": "useBrowser", "value": false, "type": "boolean" }, { "key": "clientSecret", "value": "{{authClientSecret}}", "type": "string" }, { "key": "clientId", "value": "{{authClientId}}", "type": "string" }, { "key": "tokenType", "value": "bearer", "type": "string" }, { "key": "tokenName", "value": "{{envName}} {{$timestamp}}", "type": "string" }, { "key": "headerPrefix", "value": "Bearer", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "gatewayHost", "value": "https://api.cartoncloud.com" }, { "key": "tenantUuid", "value": "123-123-123" }, { "key": "authClientId", "value": "123-123-123" }, { "key": "authClientSecret", "value": "" }, { "key": "apiVersion", "value": "1" }, { "key": "warehouseProductUuid", "value": "123-123-123", "disabled": true }, { "key": "transportProductUuid", "value": "123-123-123", "disabled": true }, { "key": "reportRunUuid", "value": "123-123-123", "disabled": true }, { "key": "outboundOrderUuid", "value": "123-123-123", "disabled": true }, { "key": "inboundOrderUuid", "value": "123-123-123", "disabled": true }, { "key": "consignmentUuid", "value": "123-123-123", "disabled": true }, { "key": "customerUuid", "value": "123-123-123", "type": "string", "disabled": true }, { "key": "warehouseUuid", "value": "123-123-123", "type": "string", "disabled": true }, { "key": "warehouseProductUuid", "value": "123-123-123", "type": "string", "disabled": true } ] }