{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Consignments & Goods","description":"The operational transportation management API. Full access to planning, tracking, invoicing, and integrations — built on the OTM5 open data standard.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"consignments--goods","__idx":0},"children":["Consignments & Goods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Consignments are line-item groupings of goods within a transport order. They represent what needs to be moved. This guide covers creating, managing, splitting, and combining consignments."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-a-consignment","__idx":1},"children":["Creating a Consignment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Consignments are typically created as part of a transport order, but can also be created independently:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/consignment \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"status\": \"requested\",\n    \"goods\": [\n      {\n        \"type\": \"items\",\n        \"description\": \"Electronics\",\n        \"quantity\": 120,\n        \"weight\": { \"value\": 2400, \"unit\": \"kg\" }\n      }\n    ],\n    \"originalPhysicalSender\": { \"id\": \"sender-business-uuid\" },\n    \"originalPhysicalAddressee\": { \"id\": \"receiver-business-uuid\" }\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"consignment\": {\n    \"id\": \"consignment-uuid\",\n    \"status\": \"requested\",\n    \"goods\": [\n      {\n        \"id\": \"goods-uuid\",\n        \"type\": \"items\",\n        \"description\": \"Electronics\",\n        \"quantity\": 120,\n        \"weight\": { \"value\": 2400, \"unit\": \"kg\" }\n      }\n    ],\n    \"createdAt\": \"2026-03-22T10:00:00Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"consignment-statuses","__idx":2},"children":["Consignment Statuses"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["draft"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Being composed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requested"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submitted"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["confirmed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accepted and ready for planning"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["planned"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Trip assigned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partially_planned"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some goods assigned to trips"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["in_transit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currently moving"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partially_in_transit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some goods in transit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivered"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partially_completed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Some goods delivered"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cancelled"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"goods-types","__idx":3},"children":["Goods Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Goods are polymorphic — the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," field determines the structure:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"items","__idx":4},"children":["Items"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["General cargo with quantity, weight, and dimensions:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"items\",\n  \"description\": \"Consumer electronics\",\n  \"quantity\": 50,\n  \"weight\": { \"value\": 1200, \"unit\": \"kg\" },\n  \"dimensions\": {\n    \"length\": { \"value\": 120, \"unit\": \"cm\" },\n    \"width\": { \"value\": 80, \"unit\": \"cm\" },\n    \"height\": { \"value\": 100, \"unit\": \"cm\" }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"transport-equipment","__idx":5},"children":["Transport Equipment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Containers, trailers, and other transport equipment:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"transportEquipment\",\n  \"equipmentType\": \"container\",\n  \"containerNumber\": \"MSKU1234567\",\n  \"containerSize\": \"40ft\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-a-consignment","__idx":6},"children":["Get a Consignment"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Standard view\ncurl -X GET \"https://api.otms.transportial.com/api/consignment/{id}\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# Extended view (full relation data)\ncurl -X GET \"https://api.otms.transportial.com/api/consignment:extended/{id}\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-consignments","__idx":7},"children":["List Consignments"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/consignments/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"search-consignments","__idx":8},"children":["Search Consignments"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.otms.transportial.com/api/consignments/0/20\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"status\": \"requested\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"splitting-consignments","__idx":9},"children":["Splitting Consignments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Split a consignment into multiple parts — useful when goods need to go to different destinations or be transported on separate trips:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/consignments/split \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"consignmentId\": \"consignment-uuid\",\n    \"splits\": [\n      {\n        \"goods\": [\n          {\n            \"id\": \"goods-uuid\",\n            \"quantity\": 60\n          }\n        ]\n      },\n      {\n        \"goods\": [\n          {\n            \"id\": \"goods-uuid\",\n            \"quantity\": 60\n          }\n        ]\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"combining-consignments","__idx":10},"children":["Combining Consignments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Merge multiple consignments into one — useful when consolidating shipments:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/consignments/combine \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"consignmentIds\": [\n      \"consignment-uuid-1\",\n      \"consignment-uuid-2\"\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"consignment-parties","__idx":11},"children":["Consignment Parties"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each consignment can specify the parties involved:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originalPhysicalSender"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business physically sending the goods"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originalPhysicalAddressee"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business physically receiving the goods"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originalLegalSender"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Legal sender (may differ from physical)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originalLegalAddressee"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Legal receiver (may differ from physical)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"financial-fields","__idx":12},"children":["Financial Fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Consignments carry pricing data:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"expectedCost\": { \"value\": 450.00, \"currency\": \"EUR\" },\n  \"expectedRevenue\": { \"value\": 650.00, \"currency\": \"EUR\" },\n  \"pricingElements\": [\n    {\n      \"name\": \"Base rate\",\n      \"value\": 400.00\n    },\n    {\n      \"name\": \"Fuel surcharge\",\n      \"value\": 50.00\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"attach-documents","__idx":13},"children":["Attach Documents"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add CMR, photos, or other documents to a consignment:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT \"https://api.otms.transportial.com/api/consignment/{id}/documents\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"documents\": [\n      { \"id\": \"document-uuid\" }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"goods-crud","__idx":14},"children":["Goods CRUD"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage goods independently:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Create goods\ncurl -X POST https://api.otms.transportial.com/api/goods \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"type\": \"items\",\n    \"description\": \"Palletized food products\",\n    \"quantity\": 33,\n    \"weight\": { \"value\": 800, \"unit\": \"kg\" }\n  }'\n\n# Get goods\ncurl -X GET \"https://api.otms.transportial.com/api/goods/{id}\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# List goods\ncurl -X GET \"https://api.otms.transportial.com/api/goodss/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":15},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create transport orders with consignments in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/quickstart"},"children":["Quickstart guide"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Plan trips for your consignments in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/trips-and-planning"},"children":["Trips & Planning"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["See the full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["API Reference"]}," for all consignment and goods endpoints"]}]}]},"headings":[{"value":"Consignments & Goods","id":"consignments--goods","depth":1},{"value":"Creating a Consignment","id":"creating-a-consignment","depth":2},{"value":"Consignment Statuses","id":"consignment-statuses","depth":2},{"value":"Goods Types","id":"goods-types","depth":2},{"value":"Items","id":"items","depth":3},{"value":"Transport Equipment","id":"transport-equipment","depth":3},{"value":"Get a Consignment","id":"get-a-consignment","depth":2},{"value":"List Consignments","id":"list-consignments","depth":2},{"value":"Search Consignments","id":"search-consignments","depth":2},{"value":"Splitting Consignments","id":"splitting-consignments","depth":2},{"value":"Combining Consignments","id":"combining-consignments","depth":2},{"value":"Consignment Parties","id":"consignment-parties","depth":2},{"value":"Financial Fields","id":"financial-fields","depth":2},{"value":"Attach Documents","id":"attach-documents","depth":2},{"value":"Goods CRUD","id":"goods-crud","depth":2},{"value":"Next Steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Consignments & Goods"}},"lastModified":"2026-03-22T21:04:26.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/consignments-and-goods","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}