{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Businesses & Contacts","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":"businesses--contacts","__idx":0},"children":["Businesses & Contacts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Businesses represent companies and organizations in your transport network — your own company, customers, carriers, subcontractors, and receivers. This guide covers creating, managing, and organizing business relationships."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-a-business","__idx":1},"children":["Creating a Business"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/business \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Acme Logistics B.V.\",\n    \"relationType\": \"carrier\",\n    \"coc\": \"12345678\",\n    \"vat\": \"NL123456789B01\",\n    \"website\": \"https://acme-logistics.com\",\n    \"locations\": [\n      {\n        \"name\": \"Headquarters\",\n        \"address\": {\n          \"street\": \"Transportweg 1\",\n          \"city\": \"Rotterdam\",\n          \"postalCode\": \"3011 AA\",\n          \"country\": \"NL\"\n        }\n      }\n    ],\n    \"contactDetails\": [\n      { \"type\": \"email\", \"value\": \"ops@acme-logistics.com\" },\n      { \"type\": \"phone\", \"value\": \"+31 10 123 4567\" }\n    ]\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  \"business\": {\n    \"id\": \"business-uuid\",\n    \"name\": \"Acme Logistics B.V.\",\n    \"relationType\": \"carrier\",\n    \"coc\": \"12345678\",\n    \"vat\": \"NL123456789B01\",\n    \"createdAt\": \"2026-03-22T10:00:00Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"relation-types","__idx":2},"children":["Relation Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Businesses can have different relationships to your platform:"]},{"$$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":"Relation Type"},"children":["Relation Type"]},{"$$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":["carrier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transport carrier or logistics service provider"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipper"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer who ships goods"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["receiver"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient of goods"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subcontractor"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subcontracted carrier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["supplier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Supplier of goods or services"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"updating-a-business","__idx":3},"children":["Updating a Business"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT https://api.otms.transportial.com/api/business \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"id\": \"business-uuid\",\n    \"name\": \"Acme Logistics International B.V.\",\n    \"eori\": \"NL123456789\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-a-business","__idx":4},"children":["Get a Business"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/business/{id}\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-businesses","__idx":5},"children":["List Businesses"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Paginated list\ncurl -X GET \"https://api.otms.transportial.com/api/businesses/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# Search with filters\ncurl -X POST \"https://api.otms.transportial.com/api/businesses/0/20\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"relationType\": \"carrier\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"business-hierarchy","__idx":6},"children":["Business Hierarchy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Businesses can be organized hierarchically using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partOf"]}," relationship. This is useful for companies with divisions or subsidiaries:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/business \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Acme Netherlands Division\",\n    \"partOf\": { \"id\": \"parent-business-uuid\" }\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"contact-details","__idx":7},"children":["Contact Details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Businesses support multiple contact detail types:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"contactDetails\": [\n    { \"type\": \"email\", \"value\": \"info@company.com\" },\n    { \"type\": \"phone\", \"value\": \"+31 10 123 4567\" },\n    { \"type\": \"fax\", \"value\": \"+31 10 123 4568\" },\n    { \"type\": \"mobile\", \"value\": \"+31 6 12345678\" }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tax-identifiers","__idx":8},"children":["Tax Identifiers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Businesses can have multiple tax and registration identifiers:"]},{"$$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":["vat"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["VAT number (e.g., NL123456789B01)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eori"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EORI number for customs"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["coc"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Chamber of Commerce number"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"business-locations","__idx":9},"children":["Business Locations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Link locations (warehouses, offices, depots) to a business:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT https://api.otms.transportial.com/api/business \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"id\": \"business-uuid\",\n    \"locations\": [\n      { \"id\": \"existing-location-uuid\" },\n      {\n        \"name\": \"New depot\",\n        \"address\": {\n          \"street\": \"Industrieweg 5\",\n          \"city\": \"Eindhoven\",\n          \"postalCode\": \"5600 AB\",\n          \"country\": \"NL\"\n        }\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"businesses-in-transport-orders","__idx":10},"children":["Businesses in Transport Orders"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Businesses are referenced throughout transport operations:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customer"]}," — the business requesting the transport"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Carrier"]}," — the business executing the transport"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sender / Receiver"]}," — physical parties at load and unload locations"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Invoice subject / target"]}," — parties on financial documents"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/transportOrder \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Order #1042\",\n    \"customer\": { \"id\": \"customer-business-uuid\" },\n    \"consignments\": [\n      {\n        \"originalPhysicalSender\": { \"id\": \"sender-business-uuid\" },\n        \"originalPhysicalAddressee\": { \"id\": \"receiver-business-uuid\" }\n      }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":11},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create transport orders for your businesses with the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/quickstart"},"children":["Quickstart guide"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Link locations to businesses in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/examples/managing-locations"},"children":["Managing Locations"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["See the full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["API Reference"]}," for all business endpoints"]}]}]},"headings":[{"value":"Businesses & Contacts","id":"businesses--contacts","depth":1},{"value":"Creating a Business","id":"creating-a-business","depth":2},{"value":"Relation Types","id":"relation-types","depth":2},{"value":"Updating a Business","id":"updating-a-business","depth":2},{"value":"Get a Business","id":"get-a-business","depth":2},{"value":"List Businesses","id":"list-businesses","depth":2},{"value":"Business Hierarchy","id":"business-hierarchy","depth":2},{"value":"Contact Details","id":"contact-details","depth":2},{"value":"Tax Identifiers","id":"tax-identifiers","depth":2},{"value":"Business Locations","id":"business-locations","depth":2},{"value":"Businesses in Transport Orders","id":"businesses-in-transport-orders","depth":2},{"value":"Next Steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Businesses & Contacts"}},"lastModified":"2026-03-22T21:04:26.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/businesses-and-contacts","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}