{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Core Concepts","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":"core-concepts","__idx":0},"children":["Core Concepts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Transportial is built on the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OTM5"]}," (Open Trip Model 5) standard — an open data model for logistics. This page explains the key entities and how they relate."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"entity-hierarchy","__idx":1},"children":["Entity Hierarchy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The core transport flow is built around four entities:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Platform\n  └── Business (your company, customers, carriers)\n        └── TransportOrder (a request to move goods)\n              └── Consignment (a line-item grouping of goods)\n                    └── Trip (the execution plan)\n                          └── Action (atomic tasks: load, move, unload)\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"platform","__idx":2},"children":["Platform"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Platform"]}," is your workspace — the top-level container for all data. When you register, a platform is created for your organization. Platforms have configurable settings for UI, billing, pricing, translations, and alerts."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every entity belongs to a platform. Users and businesses are scoped to their platform."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"business","__idx":3},"children":["Business"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business"]}," represents a company or organization. You'll create businesses for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your own company"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your customers (shippers)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your carriers and subcontractors"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Receivers and other parties"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Businesses have contact details, locations, tax identifiers (VAT, EORI, CoC), and can be organized hierarchically with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partOf"]}," relationships."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transport-order","__idx":4},"children":["Transport Order"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TransportOrder"]}," is the starting point of any transport operation — a request to move goods between locations. It tracks the full lifecycle from initial request through planning, execution, and invoicing."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"statuses","__idx":5},"children":["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":["concept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Draft, not yet submitted"]}]},{"$$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, awaiting acceptance"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accepted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirmed by the carrier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["calculated_trip"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Route has been calculated"]}]},{"$$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 consignments are planned"]}]},{"$$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":["All consignments have trips assigned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["actual"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currently in execution"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["realized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Completed successfully"]}]},{"$$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 before completion"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["declined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rejected by the carrier"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-fields","__idx":6},"children":["Key Fields"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["name"]}," — Human-readable identifier"]},{"$$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":["consignments"]}," — The line items (goods to be moved)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["expectedRevenue / expectedCost"]}," — Financial estimates"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["administration"]}," — Linked invoicing and billing info"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"consignment","__idx":7},"children":["Consignment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Consignment"]}," is a logical grouping of goods within a transport order. A single transport order can have multiple consignments — for example, one pickup going to multiple destinations."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"statuses-1","__idx":8},"children":["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":["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":["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":["cancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cancelled"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Consignments also support partial statuses: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partially_planned"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partially_in_transit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partially_completed"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-fields-1","__idx":9},"children":["Key Fields"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["goods"]}," — List of cargo items (pallets, packages, containers, etc.)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["trip"]}," — The execution plan assigned to this consignment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["actions"]}," — Events that have occurred (loading, unloading, etc.)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"goods","__idx":10},"children":["Goods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Goods"]}," represent the physical cargo. They use polymorphism — the two main types are:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Items"]}," — General cargo with quantity, weight, dimensions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TransportEquipment"]}," — Containers, trailers, and other transport equipment"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"trip","__idx":11},"children":["Trip"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trip"]}," is the execution plan for moving consignments. It defines the route, assigns a vehicle and chauffeur, and contains an ordered sequence of actions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Trips support multi-modal transport:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Road"]}," — Route calculation via GraphHopper"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Maritime"]}," — Route calculation via SeaRoute"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rail"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Air"]}," — Supported in the data model"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-fields-2","__idx":12},"children":["Key Fields"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["vehicle"]}," — The assigned vehicle"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["chauffeur"]}," — The assigned driver(s)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["actions"]}," — Ordered list of tasks to execute"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["route"]}," — Calculated route geometry"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"action","__idx":13},"children":["Action"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Action"]}," is an atomic task within a trip. Actions are polymorphic — each type represents a different operation:"]},{"$$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":"Type"},"children":["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":["load"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Load goods onto the vehicle"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unload"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unload goods at destination"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["move"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Drive between locations"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stop"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Scheduled stop"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["break"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Driver rest break"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["wait"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Waiting time (at dock, border, etc.)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["handOver"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transfer goods to another party"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customs clearance"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachChauffeur"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Assign a driver mid-trip"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attachTransportEquipment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attach trailer or container"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Actions have constraints (time windows, location requirements) and track their lifecycle through events."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"events","__idx":14},"children":["Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Events"]}," record what happens during transport execution. They are also polymorphic:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ArrivalEvent / DepartureEvent"]}," — Vehicle arrives or departs a location"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LocationUpdateEvent"]}," — GPS position update"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GateInEvent / GateOutEvent"]}," — Enters or exits a facility"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SensorUpdateEvent"]}," — Temperature, humidity, or other sensor data"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["StartMovingEvent / StopMovingEvent"]}," — Motion detection"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CapacityChangeEvent"]}," — Loading/unloading changes cargo capacity"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supporting-entities","__idx":15},"children":["Supporting Entities"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"location","__idx":16},"children":["Location"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Geographic points or areas. Locations have addresses, coordinates, and can be linked to businesses (warehouses, offices, etc.)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"vehicle","__idx":17},"children":["Vehicle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Vehicles in your fleet. Tracked for planning, GPS monitoring, and compliance. Linked to chauffeurs through activity scheduling."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"chauffeur","__idx":18},"children":["Chauffeur"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Drivers with schedules, activity tracking, and availability management. Chauffeurs are linked to users and can be assigned to trips."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"invoice--quote","__idx":19},"children":["Invoice & Quote"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Financial documents generated from transport orders. Invoices track charges per consignment line. Quotes provide pricing before acceptance."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication--permissions","__idx":20},"children":["Authentication & Permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API uses JWT bearer tokens. Each user session carries a set of permissions that control access to specific operations. Common permissions include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create:transportOrder"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get:transportOrders"]}," — Transport order management"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create:business"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get:businesses"]}," — Business management"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browse:app-store"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["install:app"]}," — App store access"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["create:chauffeur:activity"]}," — Driver scheduling"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/guides/quickstart"},"children":["Quickstart"]}," for authentication details."]}]},"headings":[{"value":"Core Concepts","id":"core-concepts","depth":1},{"value":"Entity Hierarchy","id":"entity-hierarchy","depth":2},{"value":"Platform","id":"platform","depth":2},{"value":"Business","id":"business","depth":2},{"value":"Transport Order","id":"transport-order","depth":2},{"value":"Statuses","id":"statuses","depth":3},{"value":"Key Fields","id":"key-fields","depth":3},{"value":"Consignment","id":"consignment","depth":2},{"value":"Statuses","id":"statuses-1","depth":3},{"value":"Key Fields","id":"key-fields-1","depth":3},{"value":"Goods","id":"goods","depth":2},{"value":"Trip","id":"trip","depth":2},{"value":"Key Fields","id":"key-fields-2","depth":3},{"value":"Action","id":"action","depth":2},{"value":"Events","id":"events","depth":2},{"value":"Supporting Entities","id":"supporting-entities","depth":2},{"value":"Location","id":"location","depth":3},{"value":"Vehicle","id":"vehicle","depth":3},{"value":"Chauffeur","id":"chauffeur","depth":3},{"value":"Invoice & Quote","id":"invoice--quote","depth":3},{"value":"Authentication & Permissions","id":"authentication--permissions","depth":2}],"frontmatter":{"seo":{"title":"Core Concepts"}},"lastModified":"2026-03-22T20:40:34.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/concepts","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}