{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/shippers/visibility/ocean/sidebars.yaml"},"props":{"codeGuideFiles":[],"dynamicMarkdocComponents":[],"metadata":{"type":"markdown"},"seo":{"title":"Ocean Unified Arrangements [Beta] - project44 Developer Portal","description":"Draft API documentation and user guide for the Ocean Unified Arrangements beta feature."},"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"ocean-unified-arrangements-beta"},"children":["Ocean Unified Arrangements [Beta]"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Beta: available on request."]}," Ocean Unified Arrangements is a beta feature; documentation and behavior are subject to change before general availability. Contact your project44 account team to enable it for your tenant."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview"},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Ocean Unified Arrangements feature lets you create and update ocean shipments using a structured ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["plan"]}," that separates your intent from carrier-discovered data and realized execution. Every shipment you create through this API includes two components:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scope"]}," declares what kind of shipment you're tracking: for example, a full container load (FCL) or a roll-on/roll-off (RoRo) shipment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Arrangements"]}," declare which parties are involved and supply the identifiers the platform needs to activate tracking."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This model applies to all ocean shipment types: FCL, less-than-container load (LCL), and RoRo. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.scope"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.arrangements"]}," fields extend the existing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan"]}," object in the unified shipment schema alongside top-level fields such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifiers"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["events"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page is for developers and logistics professionals who integrate with the project44 API to track ocean shipments. Together, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.scope"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.arrangements"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Declare the type of shipment and what tracking behavior to activate"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Identify the parties involved, such as the ocean carrier or freight forwarder"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Give the API the information it needs to validate your request upfront and return actionable error messages"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-begin"},"children":["Before you begin"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before using the Ocean Unified Arrangements feature, make sure you have the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An active project44 API client ID and secret, used to generate bearer tokens for authentication"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The correct permissions enabled on your tenant for the features you intend to use. Freight-forwarder-managed shipments require an additional permission; contact your project44 account team if you're unsure"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Familiarity with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v4/shipments/tracking"]}," endpoint and the unified shipment schema"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access to the appropriate regional endpoint for your environment:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["North America:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://na12.api.project44.com/api/v4/shipments/tracking"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Europe:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://eu12.api.project44.com/api/v4/shipments/tracking"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sandbox:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://na12.api.sandbox.p-44.com/api/v4/shipments/tracking"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"the-plan"},"children":["The plan"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every ocean shipment you create includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan"]}," object at the top level of the unified shipment structure. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan"]}," object contains two fields that you configure:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scope"]},": an array of tags that declares what kind of shipment this is"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["arrangements"]},": an array of objects that identifies the parties involved and provides the references needed to track the shipment"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following shows how these fields fit within the broader shipment structure:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"3b6bff66-c74b-475c-a222-ce6a92413650\",\n  \"identifiers\": [\n    { \"type\": \"BILL_OF_LADING\", \"value\": \"BOL-KITDT6B6\" },\n    { \"type\": \"CARRIER_NAME\", \"value\": \"NTH INC\" }\n  ],\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"billOfLadingNumber\": \"BOL-MAEU-2026-001\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scope"]}," field is an array of tags. The first tag is the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["primary scope tag"]}," and determines the shipment type. You can add modifier tags after the primary tag to enable additional capabilities."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope tags:"]}]},{"$$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":"Tag"},"children":["Tag"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Shipment type"},"children":["Shipment type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full Container Load (FCL)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Less-than-Container Load (LCL)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_ROLL_ON_ROLL_OFF"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Roll-on/roll-off (RoRo) wheeled cargo"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope tags:"]}]},{"$$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":"Tag"},"children":["Tag"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Applies to"},"children":["Applies to"]},{"$$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":["FREIGHT_FORWARDER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["FCL, LCL, RoRo"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Marks the shipment as freight-forwarder-managed. Requires a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," arrangement and an additional product permission."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_SINGLE_CONTAINER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["FCL only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Restricts tracking to a single container and suppresses sibling container discovery. Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["containerNumber"]}," on every ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"arrangements"},"children":["Arrangements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["arrangements"]}," field is an array of objects. Each arrangement declares one party involved in the shipment. The following arrangement types are supported:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]},": the ocean shipping line"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]},": the freight forwarder managing the shipment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SHIPPER"]},": the cargo owner sending the goods"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONSIGNEE"]},": the cargo owner receiving the goods"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BILL_TO"]},": the party responsible for freight charges"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOTIFY_PARTY"]},": a party to be notified of shipment events"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SHIPPER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONSIGNEE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BILL_TO"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOTIFY_PARTY"]}," are optional on any shipment and can carry contact details (company name, names, phone, email) and a full address. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#arrangement-types"},"children":["Arrangement types"]}," for the field-level reference."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"arrangement-types"},"children":["Arrangement types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Arrangements declare the parties involved in a shipment. Each arrangement has a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}," object specific to that type."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every arrangement, regardless of type, also supports two top-level identifier fields used to match the arrangement on subsequent updates:"]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Platform-generated UUID assigned when the arrangement is first created. Returned in the response. Provide this on subsequent requests to update the same arrangement."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer-provided string. Tenant-scoped and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["immutable after creation"]},": it cannot be changed, cleared, or added once the arrangement has been stored. Use this as a stable handle when you want to match arrangements by your own identifier rather than the platform-generated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#arrangement-behavior-on-post-and-put"},"children":["Arrangement behavior on POST and PUT"]}," for how ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," are used during matching."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ocean_carrier"},"children":["OCEAN_CARRIER"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Represents an ocean shipping line. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement is required for most ocean shipment types unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," is in scope. Multiple ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangements can appear in a single plan, each with a different role."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"fields"},"children":["Fields"]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["scac"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Standard carrier alpha code identifying the ocean carrier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["roles"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier roles. Accepted values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTRACTUAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OPERATING"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COLOADER"]},". Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"CONTRACTUAL\"]"]}," when omitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billOfLadingNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Master bill of lading number issued by the carrier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Booking number for the shipment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["houseBillOfLadingNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["House bill of lading number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["containerNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_SINGLE_CONTAINER"]}," is in scope. All ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangements must use the same container number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Extent of carrier service. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#service-types"},"children":["Service types"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of cargo booking. Inferred from the primary scope tag when omitted. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#booking-types"},"children":["Booking types"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"service-types"},"children":["Service types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType"]}," field declares where the carrier's responsibility begins and ends, that is, which legs of the journey (inland, port, ocean) the carrier's contract covers. When present, the value is used for demurrage and detention (D&D) calculations and to optimize milestone generation; it does not affect validation rules."]},{"$$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":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Origin"},"children":["Origin"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Destination"},"children":["Destination"]},{"$$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":["DOOR_TO_DOOR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Door (shipper's premises)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Door (consignee's premises)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full door-to-door service. Carrier handles all legs including inland transport at both ends."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOOR_TO_RAIL_RAMP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Door (shipper's premises)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rail ramp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier picks up from shipper's door and delivers to a destination rail ramp."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOOR_TO_CONTAINER_YARD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Door (shipper's premises)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container yard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier picks up from shipper's door and delivers to a destination container yard."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RAIL_RAMP_TO_DOOR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rail ramp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Door (consignee's premises)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier picks up from an origin rail ramp and delivers to consignee's door."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RAIL_RAMP_TO_RAIL_RAMP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rail ramp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rail ramp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier handles rail and ocean legs between ramps."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RAIL_RAMP_TO_CONTAINER_YARD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rail ramp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container yard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier picks up from an origin rail ramp and delivers to a destination container yard."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_YARD_TO_DOOR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container yard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Door (consignee's premises)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier picks up from an origin container yard and delivers to consignee's door."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_YARD_TO_RAIL_RAMP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container yard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rail ramp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier picks up from an origin container yard and delivers to a destination rail ramp."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_YARD_TO_CONTAINER_YARD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container yard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container yard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Carrier handles transport between yards including the ocean leg."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CFS_TO_CFS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container Freight Station (CFS)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container Freight Station (CFS)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Typically used for LCL shipments where cargo is consolidated and deconsolidated at freight stations."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CFS_TO_CONTAINER_YARD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container Freight Station (CFS)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container yard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consolidation scenarios where cargo is consolidated at origin CFS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_YARD_TO_CFS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container yard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container Freight Station (CFS)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deconsolidation scenarios where cargo is deconsolidated at destination CFS."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"booking-types"},"children":["Booking types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType"]}," field declares the type of ocean cargo booking the customer has with the carrier. This determines how the system treats containers, tracking, and consolidation behavior for the shipment."]},{"$$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":"Value"},"children":["Value"]},{"$$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":["FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The customer has booked an entire container. Used for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}," shipments and for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}," consolidation shipments (where the forwarder controls the entire container)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LESS_THAN_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The customer has booked space within a shared container. Multiple shippers share a single container, and the carrier or NVOCC manages consolidation. Used for standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}," shipments."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROLL_ON_ROLL_OFF"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The customer has booked wheeled cargo space on a RoRo vessel. Used for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_ROLL_ON_ROLL_OFF"]}," shipments."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType"]}," is omitted, the system derives it from the primary scope tag:"]},{"$$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":"Primary scope tag"},"children":["Primary scope tag"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default bookingType"},"children":["Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FULL_CONTAINER_LOAD"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LESS_THAN_CONTAINER_LOAD"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_ROLL_ON_ROLL_OFF"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ROLL_ON_ROLL_OFF"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["consolidation"]}," shipments, the caller must explicitly set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType: \"FULL_CONTAINER_LOAD\""]}," on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"freight_forwarder"},"children":["FREIGHT_FORWARDER"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifies the freight forwarder managing the shipment end-to-end. Required when the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," modifier is in scope; rejected when it isn't."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"fields-1"},"children":["Fields"]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["scac"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Standard carrier alpha code identifying the freight forwarder."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Forwarder-issued reference for the shipment. Tenant-scoped identifier."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"cargo-owner-arrangements"},"children":["Cargo owner arrangements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SHIPPER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONSIGNEE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BILL_TO"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOTIFY_PARTY"]}," identify the commercial parties associated with the shipment: who is shipping the goods, who is receiving them, who is paying, and who should be notified. All four are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["optional"]}," on any shipment regardless of scope, and they do not affect validation rules for carrier or forwarder arrangements."]},{"$$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":"Arrangement type"},"children":["Arrangement type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Role"},"children":["Role"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$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":["The party sending the goods (origin party / exporter)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONSIGNEE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The party receiving the goods (destination party / importer)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BILL_TO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The party responsible for paying freight charges."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOTIFY_PARTY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A party to be notified of shipment milestones."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All four types share the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}," structure: a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contact"]}," object and an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address"]}," object."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"fields-2"},"children":["Fields"]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["contact.companyName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the company or organization."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contact.givenName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact person's first name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contact.familyName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact person's last name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contact.phoneNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Landline phone number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contact.mobilePhoneNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mobile phone number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contact.email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact email address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.addressLines"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Street address lines."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.postalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal / ZIP code."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.city"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["City name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.state"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["State or province code."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address.country"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO 3166-1 alpha-2 country code (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB"]},")."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#full-container-load-fcl"},"children":["FCL example with a consignee arrangement"]}," for a concrete usage."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"shipment-type-configurations"},"children":["Shipment type configurations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each primary scope tag has specific validation requirements. The following sections describe what each configuration requires and how to set it up. For end-to-end walkthroughs that pair each common business case with its legacy and unified-arrangements payloads, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#business-scenarios"},"children":["Business scenarios"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"full-container-load-fcl"},"children":["Full Container Load (FCL)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["FCL shipments use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}," primary scope tag."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Requirements:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTRACTUAL"]}," role is required unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," is in scope."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each entry in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}," must include exactly one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_ID"]}," identifier."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: standard FCL shipment"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MSCU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"MSCUAB123456\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: FCL with freight forwarder"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," is in scope, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement becomes optional: the forwarder can enrich carrier details later through their connection."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"KHNN\",\n            \"referenceNumber\": \"FREF-KHNN-2026-001\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["→ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["202 Accepted"]},": Forwarder-only FCL shipment. The ocean carrier can be enriched by the forwarder later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: FCL shipment with a consignee arrangement"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MSCU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"MSCUAB123456\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      },\n      {\n        \"type\": \"CONSIGNEE\",\n        \"details\": {\n          \"contact\": {\n            \"companyName\": \"Riverstone Imports Ltd\",\n            \"email\": \"logistics@riverstone-example.com\",\n            \"phoneNumber\": \"+1-312-555-0199\"\n          },\n          \"address\": {\n            \"addressLines\": [\"420 Harbor Blvd\"],\n            \"city\": \"Chicago\",\n            \"country\": \"US\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: FCL shipment with related container shipments"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}," to associate individual container shipments with the parent shipment at creation time. Each entry must include exactly one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_ID"]}," identifier; additional identifiers of other types (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOMER_REFERENCE"]},") are permitted."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MSCU\",\n            \"bookingNumber\": \"BN-MSCU-2026-001\",\n            \"serviceType\": \"CONTAINER_YARD_TO_CONTAINER_YARD\"\n          }\n        }\n      }\n    ]\n  },\n  \"relatedShipments\": [\n    {\n      \"identifiers\": [{ \"type\": \"CONTAINER_ID\", \"value\": \"MSCU4546646\" }]\n    },\n    {\n      \"identifiers\": [{ \"type\": \"CONTAINER_ID\", \"value\": \"MSCU7832104\" }]\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"single-container-fcl"},"children":["Single-container FCL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_SINGLE_CONTAINER"]}," modifier to restrict tracking to a single container within an FCL shipment. This suppresses the discovery of sibling containers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Requirements:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_SINGLE_CONTAINER"]}," can only be used with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["containerNumber"]}," is required on every ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Container numbers must be consistent across all arrangements."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\", \"OCEAN_SINGLE_CONTAINER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"OOLU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"OOLUSG987654\",\n            \"containerNumber\": \"OOLU4567890\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"less-than-container-load-lcl"},"children":["Less-than-Container Load (LCL)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["LCL shipments use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}," primary scope tag."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Standard LCL requirements:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTRACTUAL"]}," role is required unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," is in scope."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COLOADER"]}," role is supported. If a carrier's role is uncertain, the API can auto-resolve it from master data."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: standard LCL"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"HLCU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"bookingNumber\": \"HLCU-BK-20260415-001\",\n            \"bookingType\": \"LESS_THAN_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: standard LCL with a freight-forwarder arrangement"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Adding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," to a standard LCL shipment makes the forwarder the required party; the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement becomes optional and can be enriched by the forwarder later. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType"]}," stays ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LESS_THAN_CONTAINER_LOAD"]},": that is what distinguishes this from an LCL consolidation, which uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType: FULL_CONTAINER_LOAD"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"KHNN\",\n            \"referenceNumber\": \"FREF-KHNN-2026-LCL-001\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"HLCU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"bookingNumber\": \"HLCU-BK-20260415-001\",\n            \"bookingType\": \"LESS_THAN_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LCL consolidation variant:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For freight-forwarder-managed LCL consolidations, where the forwarder books a full container and consolidates multiple LCL shipments inside it, use:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"scope: [\"OCEAN_LESS_THAN_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"]\nbookingType: FULL_CONTAINER_LOAD\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The consolidation case is the one exception to the otherwise-optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," modifier: it is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["always required"]}," for consolidation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Additional requirements for the consolidation variant:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," arrangement is always required."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement is provided, it must include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["containerNumber"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType: FULL_CONTAINER_LOAD"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This variant requires the freight-forwarder permission on your tenant."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: LCL consolidation"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"EXFU\",\n            \"referenceNumber\": \"EXFU-CONSOL-2026-0881\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"EGLV\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"containerNumber\": \"EGLV3398812\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"roll-on/roll-off-roro"},"children":["Roll-on/Roll-off (RoRo)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["RoRo shipments use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_ROLL_ON_ROLL_OFF"]}," primary scope tag."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Requirements:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTRACTUAL"]}," role is required unless ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," is in scope."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Each entry in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}," must include exactly one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VEHICLE_IDENTIFICATION_NUMBER"]}," (VIN) identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," modifier is supported."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: standard RoRo shipment"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_ROLL_ON_ROLL_OFF\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"WALM\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"bookingNumber\": \"WALM-RORO-2026-00447\",\n            \"bookingType\": \"ROLL_ON_ROLL_OFF\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: RoRo with freight forwarder"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_ROLL_ON_ROLL_OFF\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"KUBE\",\n            \"referenceNumber\": \"FREF-KUBE-2026-003\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["→ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["202 Accepted"]},": Forwarder-only RoRo shipment. The ocean carrier can be enriched by the forwarder later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example: RoRo shipment with related vehicle shipments"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}," to associate individual vehicle shipments with the parent shipment at creation time. Each entry must include exactly one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VEHICLE_IDENTIFICATION_NUMBER"]}," identifier; additional identifiers of other types (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOMER_REFERENCE"]},") are permitted."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_ROLL_ON_ROLL_OFF\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"WALM\",\n            \"bookingNumber\": \"WALM-RORO-2026-00447\"\n          }\n        }\n      }\n    ]\n  },\n  \"relatedShipments\": [\n    {\n      \"identifiers\": [\n        { \"type\": \"VEHICLE_IDENTIFICATION_NUMBER\", \"value\": \"1HGCM82633A004352\" }\n      ]\n    },\n    {\n      \"identifiers\": [\n        { \"type\": \"VEHICLE_IDENTIFICATION_NUMBER\", \"value\": \"WVWZZZ3CZWE123456\" }\n      ]\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"business-scenarios"},"children":["Business scenarios"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ocean tracking spans a wide range of move types and party rosters: full container loads booked directly with a carrier, less-than-container loads moved through a coloader, freight-forwarder-managed consolidations across multiple suppliers and consignees, and roll-on/roll-off shipments. Previously, every scenario used the same payload shape on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v4/shipments/tracking"]},": a flat identifier list, from which the platform derived shipment type, party roles, and validation rules. The model had three limitations: ambiguous payloads defaulted silently to baseline behavior; validation errors surfaced during tracking rather than at creation; and configurations such as multi-carrier roles, coloaders, and explicit consolidation could not be expressed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.scope"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.arrangements"]}," make these signals explicit. Each of the following scenarios pairs the legacy flat-identifier payload with its scope-driven equivalent to support a one-by-one migration of an existing integration."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Not yet supported:"]}," Customs broker and dray-provider arrangement types are not yet available in this API. The following scenarios list these parties in their \"Typical parties\" rosters for completeness, but they cannot be modeled in the arrangements payload today."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-1-fcl-booked-directly-with-the-ocean-carrier"},"children":["Scenario 1: FCL booked directly with the ocean carrier"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," A shipper has a direct contract with an ocean carrier for a full container load. The carrier handles the international leg and, depending on the service type, any inland legs the contract covers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Shipper, Ocean Carrier. Customs brokers and dray providers at either end are tracked separately."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," none"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Service type variants:"]}," This single scenario covers every door / yard / rail-ramp combination of the carrier's contract. Pick the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType"]}," value from the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#service-types"},"children":["Service types"]}," reference that matches your carrier's contract."]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"MAEU\" },\n    { \"type\": \"BILL_OF_LADING\", \"value\": \"BOL-MAEU-2026-001\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"BOL-MAEU-2026-001\",\n            \"serviceType\": \"CONTAINER_YARD_TO_CONTAINER_YARD\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, FCL was derived from the combination of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CARRIER_SCAC"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BILL_OF_LADING"]},", and the identifier-based payload was not validated at create time. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType"]}," had no first-class slot, so D&D logic relied on tenant defaults or carrier inference."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," Intent is explicit (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]},"), carrier role is named (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTRACTUAL"]},"), and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serviceType"]}," carries the move-type contract for D&D and milestone planning. Validation runs at create time."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-2-fcl-booked-through-a-freight-forwarder"},"children":["Scenario 2: FCL booked through a freight forwarder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," A freight forwarder manages the FCL shipment end-to-end on behalf of the shipper. The shipper's tenant tracks via the forwarder's reference; the underlying ocean carrier can be populated later by the customer or enriched by the forwarder through its own connection."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Shipper, Freight Forwarder, Ocean Carrier (often added by the forwarder later)."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," (+ optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]},")"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example 1: forwarder only."]}," When only the forwarder's house bill of lading is known at creation, the underlying ocean carrier is enriched later through the forwarder's connection. Returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["202 Accepted"]},"."]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"FFW_SCAC\", \"value\": \"KHNN\" },\n    { \"type\": \"HOUSE_BILL_OF_LADING\", \"value\": \"FREF-KHNN-2026-001\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"KHNN\",\n            \"referenceNumber\": \"FREF-KHNN-2026-001\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example 2: forwarder and ocean carrier known upfront."]}," When both the forwarder reference and the carrier's bill of lading or booking are available at creation, supply both arrangements together so tracking activates immediately on both sides."]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"FFW_SCAC\", \"value\": \"KHNN\" },\n    { \"type\": \"HOUSE_BILL_OF_LADING\", \"value\": \"FREF-KHNN-2026-001\" },\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"MAEU\" },\n    { \"type\": \"BILL_OF_LADING\", \"value\": \"BOL-MAEU-2026-001\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"KHNN\",\n            \"referenceNumber\": \"FREF-KHNN-2026-001\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"BOL-MAEU-2026-001\",\n            \"serviceType\": \"CONTAINER_YARD_TO_CONTAINER_YARD\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, the presence of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FFW_SCAC"]}," flipped the shipment into forwarder mode, but the ocean carrier still had to be supplied up front or guessed from the house bill of lading. When both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FFW_SCAC"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CARRIER_SCAC"]}," were present, the platform could not reliably match each identifier to the right SCAC; the same booking number sometimes ended up tracked against both the freight-forwarder and the ocean-carrier SCACs."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," in scope explicitly waives the requirement to provide an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement at create time; the forwarder can enrich it later. When both arrangements are supplied, each identifier is scoped to its arrangement: the forwarder's reference sits inside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," entry and the carrier's bill of lading or booking number sits inside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," entry, removing the cross-SCAC ambiguity."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-3-single-container-fcl"},"children":["Scenario 3: Single-container FCL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," The customer has the carrier's SCAC and the container number at creation time, but not the booking number or master bill of lading. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_SINGLE_CONTAINER"]}," enables tracking anchored on the container alone."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Same as Scenario 1."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_SINGLE_CONTAINER"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["containerNumber"]}]}]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"OOLU\" },\n    { \"type\": \"CONTAINER_ID\", \"value\": \"OOLU4567890\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\", \"OCEAN_SINGLE_CONTAINER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"OOLU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"containerNumber\": \"OOLU4567890\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, this case was supported by passing just ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CARRIER_SCAC"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_ID"]}," in the flat identifier list, but the single-container intent was derived from the identifier shape rather than declared. Once the carrier connection discovered a booking or bill of lading for the container, the shipment became hard to distinguish from another shipment that had supplied a bill of lading at creation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_SINGLE_CONTAINER"]}," modifier explicitly anchors tracking on the container number alone, no booking or bill of lading required. Validation enforces that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["containerNumber"]}," is present on the carrier arrangement. Any bill of lading or booking number discovered later by the carrier connection stays separate from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.arrangements"]},", so the plan remains exactly as declared at creation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-4-fcl-with-related-container-shipments"},"children":["Scenario 4: FCL with related container shipments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," The customer wants to declare related containers explicitly at creation time rather than wait for the project44 system to discover them from the carrier. This is useful when per-container metadata (attributes, custom references, or linked orders) needs to be attached upfront so it is available the moment tracking begins. Declared containers are additive: the system continues to discover and attach further containers later reported by the carrier or the forwarder. Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#scenario-5-fcl-with-discovery-policy"},"children":["Scenario 5"]}," if tracking should be restricted to a fixed set."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Shipper, Ocean Carrier, plus per-container metadata at the customer's discretion. For forwarder-managed FCL with related containers, also include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," arrangement and add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.scope"]}," (same pattern as Scenario 2), the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}," shape is identical."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments[]"]}," (+ optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]},")"]}]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"MSCU\" },\n    { \"type\": \"BOOKING_NUMBER\", \"value\": \"BN-MSCU-2026-001\" }\n  ],\n  \"relatedShipments\": [\n    {\n      \"identifiers\": [{ \"type\": \"CONTAINER_ID\", \"value\": \"MSCU4546646\" }],\n      \"attributes\": [{ \"name\": \"Hazardous flag\", \"value\": \"No\" }]\n    }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MSCU\",\n            \"bookingNumber\": \"BN-MSCU-2026-001\",\n            \"serviceType\": \"CONTAINER_YARD_TO_CONTAINER_YARD\"\n          }\n        }\n      }\n    ]\n  },\n  \"relatedShipments\": [\n    {\n      \"identifiers\": [{ \"type\": \"CONTAINER_ID\", \"value\": \"MSCU4546646\" }],\n      \"attributes\": [{ \"name\": \"Hazardous flag\", \"value\": \"No\" }]\n    }\n  ]\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}," was supported but the parent-child relationship was derived implicitly. There was no explicit signal that the parent represented an FCL booking, and no validation that each child carried exactly one container identifier."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," The parent's FCL intent is explicit, and each related shipment must include exactly one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_ID"]}," identifier, enforced at create time."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-5-fcl-with-discovery-policy"},"children":["Scenario 5: FCL with discovery policy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," The booking covers many containers but the customer only wants to track a known subset, for example, a partner is tracking the rest, or only specific containers are commercially relevant. Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#scenario-4-fcl-with-related-container-shipments"},"children":["Scenario 4"]}," if you want to declare known containers preemptively without restricting carrier-side discovery to that set."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Same as Scenario 4. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discoveryPolicy"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}," solve overlapping but distinct problems and can be combined: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["attaches"]}," children you already know about, while ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discoveryPolicy.limitTo"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["restricts"]}," the set the platform tracks via carrier-side discovery."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," none"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.discoveryPolicy.limitTo"]}]}]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"MAEU\" },\n    { \"type\": \"BOOKING_NUMBER\", \"value\": \"BKG-MAEU-2026-001\" },\n    { \"type\": \"CONTAINER_ID\", \"value\": \"MAEU4546646\" },\n    { \"type\": \"CONTAINER_ID\", \"value\": \"MAEU7832104\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"bookingNumber\": \"BKG-MAEU-2026-001\"\n          }\n        }\n      }\n    ],\n    \"discoveryPolicy\": {\n      \"limitTo\": {\n        \"containerNumbers\": [\"MAEU4546646\", \"MAEU7832104\"]\n      }\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, this restriction was supported by listing the container IDs alongside the carrier SCAC and booking number in the flat identifier list; the presence of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_ID"]}," entries told the platform which containers to track. The restriction intent was derived from the identifier shape rather than declared as a policy, and a shipment with a single-container filter sometimes got confused with another container shipment managed under a different booking."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.discoveryPolicy.limitTo.containerNumbers"]}," declares the restriction explicitly on the plan, separate from arrangement identifiers. A shipment with a discovery policy is now clearly distinguishable from another shipment that tracks the same containers under a different booking, and containers outside the list are ignored even if the carrier reports them."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-6-multi-carrier-fcl-nvocc-contractual--operating"},"children":["Scenario 6: Multi-carrier FCL (NVOCC contractual + operating)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," An NVOCC books capacity with an underlying operating carrier and resells it to the shipper. Both carriers play a role: the NVOCC is the contractual party (issues the master bill of lading, owns the customer relationship), and the operating carrier physically moves the container. The platform represents both as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangements distinguished by the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["roles"]}," field, the NVOCC carries the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTRACTUAL"]}," role, the underlying carrier carries ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OPERATING"]},". The operating carrier can be declared upfront, or the NVOCC connection can discover it and append a second ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement with role ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OPERATING"]}," after creation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Shipper, NVOCC (contractual carrier), Operating carrier, typically reached via different booking numbers."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_FULL_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," none"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTRACTUAL"]},") + optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OPERATING"]},")"]}]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"SDBJ\" },\n    { \"type\": \"BILL_OF_LADING\", \"value\": \"BOL-SDBJ-2026-001\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"SDBJ\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"BOL-SDBJ-2026-001\",\n            \"serviceType\": \"CONTAINER_YARD_TO_CONTAINER_YARD\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"roles\": [\"OPERATING\"],\n            \"bookingNumber\": \"BN-MAEU-2026-001\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, the legacy payload exposed only one carrier; it was not even possible to declare the operating carrier's identifiers separately."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," The operating carrier's identifiers can now be declared in a second ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement with role ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OPERATING"]},", separate from the contractual carrier. Events from both carriers flow into the shipment with correct attribution."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-7-roll-on/roll-off-roro"},"children":["Scenario 7: Roll-on/Roll-off (RoRo)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," Wheeled cargo (vehicles, trailers, machinery) shipped on a RoRo vessel. Individual units are identified by Vehicle Identification Number (VIN) rather than container ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Shipper, Ocean Carrier."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_ROLL_ON_ROLL_OFF"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," none"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," (+ optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments[]"]},")"]}]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"WALM\" },\n    { \"type\": \"BOOKING_NUMBER\", \"value\": \"WALM-RORO-2026-00447\" }\n  ],\n  \"relatedShipments\": [\n    {\n      \"identifiers\": [\n        { \"type\": \"VEHICLE_IDENTIFICATION_NUMBER\", \"value\": \"1HGCM82633A004352\" }\n      ]\n    }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_ROLL_ON_ROLL_OFF\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"WALM\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"bookingNumber\": \"WALM-RORO-2026-00447\",\n            \"bookingType\": \"ROLL_ON_ROLL_OFF\"\n          }\n        }\n      }\n    ]\n  },\n  \"relatedShipments\": [\n    {\n      \"identifiers\": [\n        { \"type\": \"VEHICLE_IDENTIFICATION_NUMBER\", \"value\": \"1HGCM82633A004352\" }\n      ]\n    }\n  ]\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, RoRo bookings used the same flat-identifier shape as FCL. The creation payload itself could not distinguish a RoRo shipment from an FCL one. The shipment type was assigned only after tracking data arrived: VIN identifiers in the events marked the shipment as RoRo; otherwise it stayed as a regular ocean (FCL) shipment."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_ROLL_ON_ROLL_OFF"]}," declares RoRo intent at creation time, so the shipment type is known from the start instead of being attached later from tracking data. Related shipments validate that each entry carries a VIN."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-8-standard-lcl-booked-with-the-ocean-carrier"},"children":["Scenario 8: Standard LCL booked with the ocean carrier"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," The shipper has booked LCL space directly with an ocean carrier or NVOCC. Multiple shippers share a single container and the carrier handles consolidation. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType: LESS_THAN_CONTAINER_LOAD"]}," is what distinguishes this scenario from an LCL consolidation, where the same scope tag appears with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType: FULL_CONTAINER_LOAD"]}," (see Scenarios 10–12)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Shipper, Ocean Carrier or NVOCC."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," none"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}]}]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"HLCU\" },\n    { \"type\": \"BOOKING_NUMBER\", \"value\": \"HLCU-BK-20260415-001\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"HLCU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"bookingNumber\": \"HLCU-BK-20260415-001\",\n            \"bookingType\": \"LESS_THAN_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, the platform supported LCL only for a known list of SCACs; LCL vs FCL was derived from the SCAC value because the LCL-supporting set was small. This approach did not scale as more carriers and NVOCCs added LCL support."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," LCL intent is declared upfront via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.scope"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType"]},". The system tracks the shipment as LCL regardless of which SCAC is used, removing the dependency on a curated allowlist."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-9-lcl-with-a-coloader"},"children":["Scenario 9: LCL with a coloader"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," A contractual NVOCC books capacity with an underlying coloader (another NVOCC) that physically operates the container. Visibility into both is required."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Shipper, Contractual NVOCC, Coloader NVOCC."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," none"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," Two ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangements (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTRACTUAL"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COLOADER"]},")"]}]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"KHNN\" },\n    { \"type\": \"HOUSE_BILL_OF_LADING\", \"value\": \"HBOL-KHNN-2026-001\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"KHNN\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"houseBillOfLadingNumber\": \"HBOL-KHNN-2026-001\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"NAQA\",\n            \"roles\": [\"COLOADER\"],\n            \"bookingNumber\": \"BN-NAQA-2026-001\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, the legacy payload exposed only one carrier; it was not even possible to declare the coloader's identifiers separately."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," The coloader's identifiers can now be declared in a second ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement with role ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COLOADER"]},", separate from the contractual carrier. Events from both NVOCCs flow into the shipment with correct attribution."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-10-buyers-consolidation"},"children":["Scenario 10: Buyer's consolidation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," A freight forwarder consolidates cargo from multiple suppliers at an origin CFS into one full container, ships it as an FCL, and delivers it to a destination CFS, yard, or consignee's door. On this platform, each shipment models a single supplier's cargo unit, so consolidating cargo from N suppliers into one container creates N separate shipments, all sharing the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," FCL booking but having different forwarder references (one per supplier cargo unit). The freight forwarder is the consolidating party, responsible for combining the cargo units into the container."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Multiple Suppliers, Origin FFW (consolidator), Ocean Carrier, optional destination dray and customs broker, Consignee."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType: FULL_CONTAINER_LOAD"]},")"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Service type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CFS_TO_CONTAINER_YARD"]},"."]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"FFW_SCAC\", \"value\": \"EXFU\" },\n    { \"type\": \"HOUSE_BILL_OF_LADING\", \"value\": \"EXFU-CONSOL-2026-0881\" },\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"EGLV\" },\n    { \"type\": \"BOOKING_NUMBER\", \"value\": \"BKG-EGLV-2026-0881\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"EXFU\",\n            \"referenceNumber\": \"EXFU-CONSOL-2026-0881\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"EGLV\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"containerNumber\": \"EGLV3398812\",\n            \"billOfLadingNumber\": \"BOL-EGLV-2026-001\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\",\n            \"serviceType\": \"CFS_TO_CONTAINER_YARD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, consolidation was not supported on the platform. The shipment was tracked as a standard FCL, and the LCL nature of the consolidated cargo (multiple cargo units sharing the container) could not be expressed. The container was tracked separately as a discovered container, and its movement events did not flow back onto the cargo-level shipments."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," The shipment is treated as LCL, and the consolidated container's movement events are attached directly to it. Cargo-level tracking and container-level tracking are blended onto the same shipment record instead of living on two separate ones."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-11-shippers-consolidation"},"children":["Scenario 11: Shipper's consolidation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," A single shipper packs cargo destined for multiple consignees into one full container at origin. The container ships as an FCL, and a freight forwarder deconsolidates at a destination CFS to dispatch the cargo to each consignee. On this platform, each shipment models a single consignee-bound cargo unit, so cargo for N consignees creates N separate shipments, all sharing the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," FCL booking but having different forwarder references (one per consignee cargo unit). The freight forwarder's only responsibility is deconsolidation at the destination."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Shipper (packs the container at origin), Ocean Carrier, Destination FFW (deconsolidator), multiple Consignees."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType: FULL_CONTAINER_LOAD"]},")"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Service type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINER_YARD_TO_CFS"]},"."]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"FFW_SCAC\", \"value\": \"EXFU\" },\n    { \"type\": \"HOUSE_BILL_OF_LADING\", \"value\": \"EXFU-SHCONSOL-2026-0312\" },\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"MAEU\" },\n    { \"type\": \"BOOKING_NUMBER\", \"value\": \"BKG-MAEU-2026-SC-09\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"EXFU\",\n            \"referenceNumber\": \"EXFU-SHCONSOL-2026-0312\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"containerNumber\": \"MSKU7720091\",\n            \"billOfLadingNumber\": \"BOL-MAEU-2026-SC-09\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\",\n            \"serviceType\": \"CONTAINER_YARD_TO_CFS\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, consolidation was not supported on the platform. The shipment was tracked as a standard FCL, and the LCL nature of the consolidated cargo (multiple cargo units sharing the container) could not be expressed. The container was tracked separately as a discovered container, and its movement events did not flow back onto the cargo-level shipments."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," The shipment is treated as LCL, and the consolidated container's movement events are attached directly to it. Cargo-level tracking and container-level tracking are blended onto the same shipment record instead of living on two separate ones."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-12-consol-deconsol"},"children":["Scenario 12: Consol-deconsol"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Business case:"]}," A freight forwarder consolidates cargo from multiple suppliers at an origin CFS into one full container, ships it as an FCL, and deconsolidates at a destination CFS to dispatch the cargo to multiple consignees. On this platform, each shipment models a single cargo unit, so the consolidation creates one shipment per cargo unit, all sharing the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," FCL booking but having different forwarder references (one per cargo unit). The platform supports only one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," arrangement per shipment, so the same forwarder must handle both consolidation at origin and deconsolidation at destination."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typical parties:"]}," Multiple Suppliers, Freight Forwarder (handles both consolidation at origin and deconsolidation at destination), Ocean Carrier, multiple Consignees."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Primary scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_LESS_THAN_CONTAINER_LOAD"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modifier scope:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key arrangements:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bookingType: FULL_CONTAINER_LOAD"]},")"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Service type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CFS_TO_CFS"]},"."]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Before this API"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["With unified arrangements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"FFW_SCAC\", \"value\": \"EXFU\" },\n    { \"type\": \"HOUSE_BILL_OF_LADING\", \"value\": \"EXFU-CD-2026-0512\" },\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"ONEY\" },\n    { \"type\": \"BOOKING_NUMBER\", \"value\": \"BKG-ONEY-2026-CD-12\" }\n  ]\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"EXFU\",\n            \"referenceNumber\": \"EXFU-CONSOL-2026-0512\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"ONEY\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"containerNumber\": \"ONEU8845210\",\n            \"billOfLadingNumber\": \"BOL-ONEY-2026-CD-12\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\",\n            \"serviceType\": \"CFS_TO_CFS\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Previously, consolidation was not supported on the platform. The shipment was tracked as a standard FCL, and the LCL nature of the consolidated cargo (multiple cargo units sharing the container) could not be expressed. The container was tracked separately as a discovered container, and its movement events did not flow back onto the cargo-level shipments."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What changed:"]}," The shipment is treated as LCL, and the consolidated container's movement events are attached directly to it. Cargo-level tracking and container-level tracking are blended onto the same shipment record instead of living on two separate ones."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"linking-cargo-shipments-via-shared-arrangements"},"children":["Linking cargo shipments via shared arrangements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When multiple cargo units share the same underlying container (as in Scenarios 10–12), each cargo unit is created as its own shipment on the platform. To link these shipments via the shared container, give each shipment's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement the same top-level ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]},". The platform treats arrangements that share a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," as the same underlying entity, so the shared arrangement can be used to navigate or summarize the list of cargo units traveling inside that container. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," arrangements, on the other hand, carry distinct ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," values per cargo unit, so each cargo unit retains its own forwarder-level identifier."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example shows two cargo shipments that share the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangement (linked via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId: \"CARRIER-EGLV-CON-001\""]},") but each carry their own ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," arrangement with distinct ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," values."]},{"$$mdtype":"Tag","name":"table","attributes":{"width":"100%","style":{"height":"1px","tableLayout":"fixed"}},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Cargo shipment 1"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%"},"children":["Cargo shipment 2"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{"style":{"height":"1px"}},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"referenceId\": \"FFW-EXFU-CARGO-A-001\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"EXFU\",\n            \"referenceNumber\": \"EXFU-CARGO-A-2026-0881\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"referenceId\": \"CARRIER-EGLV-CON-001\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"EGLV\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"containerNumber\": \"EGLV3398812\",\n            \"billOfLadingNumber\": \"BOL-EGLV-2026-001\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\",\n            \"serviceType\": \"CFS_TO_CONTAINER_YARD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"style":{"verticalAlign":"top","height":"100%"}},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"plan\": {\n    \"scope\": [\"OCEAN_LESS_THAN_CONTAINER_LOAD\", \"FREIGHT_FORWARDER\"],\n    \"arrangements\": [\n      {\n        \"type\": \"FREIGHT_FORWARDER\",\n        \"referenceId\": \"FFW-EXFU-CARGO-B-001\",\n        \"details\": {\n          \"freightForwarder\": {\n            \"scac\": \"EXFU\",\n            \"referenceNumber\": \"EXFU-CARGO-B-2026-0881\"\n          }\n        }\n      },\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"referenceId\": \"CARRIER-EGLV-CON-001\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"EGLV\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"containerNumber\": \"EGLV3398812\",\n            \"billOfLadingNumber\": \"BOL-EGLV-2026-001\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\",\n            \"serviceType\": \"CFS_TO_CONTAINER_YARD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Because the two ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OCEAN_CARRIER"]}," arrangements share the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]},", the platform resolves them to one underlying entity. Tracking still happens independently on each cargo shipment; the shared arrangement just provides a navigable link between them, useful for summarizing the cargo units traveling in the container. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FREIGHT_FORWARDER"]}," arrangements stay distinct because each carries a different ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]},", so each cargo unit retains its own forwarder-level identifier. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#arrangement-behavior-on-post-and-put"},"children":["Arrangement behavior on POST and PUT"]}," for the full matching rules around ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints"},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following endpoints are available for ocean shipment tracking."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"post-/shipments/tracking"},"children":["POST /shipments/tracking"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a new shipment or appends data to an existing one. This operation is additive: it never removes existing arrangements. If you provide a shipment ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," that already exists, the operation merges the new data with the existing record."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Full path:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v4/shipments/tracking"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-headers"},"children":["Request headers"]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer token. Format: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer <your-api-key>"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters"},"children":["Request body parameters"]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["project44-assigned shipment UUID. Provide this to append data to an existing shipment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifiers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logistics identifiers associated with the shipment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.scope"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the shipment type. The first element is the primary scope tag. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#scope"},"children":["Scope"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.arrangements"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of objects"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares participating parties and their tracking identifiers. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#arrangement-types"},"children":["Arrangement types"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of objects"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Child shipments linked to this parent. Maximum 250 items. Each related shipment must not include its own arrangements."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attributes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User-defined custom attributes to associate with the shipment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entitledAccessGroups"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Access groups entitled to visibility of this shipment."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-fields"},"children":["Response fields"]},{"$$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":"Name"},"children":["Name"]},{"$$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":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID of the created or updated shipment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifiers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Logistics identifiers associated with the shipment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shipment plan, including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scope"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["arrangements"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["routeInfo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Stops and route segments for the shipment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relatedShipments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Child shipments linked to this parent."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipmentShareLink"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Publicly accessible link to the shipment details page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["attributes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom attributes associated with the shipment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdDateTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (date-time)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp when the shipment was created. Read-only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModifiedDateTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (date-time)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp when the shipment was last modified. Read-only."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example"},"children":["Request example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"identifiers\": [\n    { \"type\": \"BILL_OF_LADING\", \"value\": \"BOL-MAEU-2026-001\" },\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"MAEU\" }\n  ],\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"BOL-MAEU-2026-001\",\n            \"bookingNumber\": \"BKG-98765\",\n            \"serviceType\": \"CONTAINER_YARD_TO_CONTAINER_YARD\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example"},"children":["Response example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"3b6bff66-c74b-475c-a222-ce6a92413650\",\n  \"identifiers\": [\n    { \"type\": \"BILL_OF_LADING\", \"value\": \"BOL-MAEU-2026-001\" },\n    { \"type\": \"CARRIER_SCAC\", \"value\": \"MAEU\" }\n  ],\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\"],\n    \"arrangements\": [\n      {\n        \"id\": \"arr-11223344-5566-7788-99aa-bbccddeeff00\",\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"BOL-MAEU-2026-001\",\n            \"bookingNumber\": \"BKG-98765\",\n            \"serviceType\": \"CONTAINER_YARD_TO_CONTAINER_YARD\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  },\n  \"shipmentShareLink\": \"https://movement.project44.com/share/abc123xyz\",\n  \"createdDateTime\": \"2026-04-23T09:15:00Z\",\n  \"lastModifiedDateTime\": \"2026-04-23T09:15:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"error-codes"},"children":["Error codes"]},{"$$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":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Validation failed. The response body includes a machine-readable error code and an actionable message."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed. Your bearer token is missing or invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your account doesn't have the required permission for this operation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shipment ID you provided doesn't exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An unexpected server error occurred. If this persists, contact project44 support."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"put-/shipments/tracking"},"children":["PUT /shipments/tracking"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates an existing shipment. Unlike ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", the request payload defines the complete arrangement set for the shipment: arrangements absent from the request are unlinked, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}," on matched arrangements are fully replaced rather than merged. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#arrangement-behavior-on-post-and-put"},"children":["Arrangement behavior on POST and PUT"]}," for the precise rules."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Full path:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v4/shipments/tracking"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-headers-1"},"children":["Request headers"]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer token. Format: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer <your-api-key>"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters-1"},"children":["Request body parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," request body uses the same schema as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},". You must provide ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," to identify the shipment you're replacing."]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$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":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["project44-assigned shipment UUID of the shipment to replace."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.scope"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full scope declaration for the shipment. Replaces the existing scope."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.arrangements"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of objects"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full list of arrangements. Any arrangement not included here is unlinked."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#arrangement-behavior-on-post-and-put"},"children":["Arrangement behavior on POST and PUT"]}," for the full matching and update rules."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-1"},"children":["Request example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"3b6bff66-c74b-475c-a222-ce6a92413650\",\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\", \"OCEAN_SINGLE_CONTAINER\"],\n    \"arrangements\": [\n      {\n        \"id\": \"arr-11223344-5566-7788-99aa-bbccddeeff00\",\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"BOL-MAEU-2026-001\",\n            \"containerNumber\": \"MSKU1234567\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-1"},"children":["Response example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"3b6bff66-c74b-475c-a222-ce6a92413650\",\n  \"identifiers\": [{ \"type\": \"BILL_OF_LADING\", \"value\": \"BOL-MAEU-2026-001\" }],\n  \"plan\": {\n    \"scope\": [\"OCEAN_FULL_CONTAINER_LOAD\", \"OCEAN_SINGLE_CONTAINER\"],\n    \"arrangements\": [\n      {\n        \"id\": \"arr-11223344-5566-7788-99aa-bbccddeeff00\",\n        \"type\": \"OCEAN_CARRIER\",\n        \"details\": {\n          \"oceanCarrier\": {\n            \"scac\": \"MAEU\",\n            \"roles\": [\"CONTRACTUAL\"],\n            \"billOfLadingNumber\": \"BOL-MAEU-2026-001\",\n            \"containerNumber\": \"MSKU1234567\",\n            \"bookingType\": \"FULL_CONTAINER_LOAD\"\n          }\n        }\n      }\n    ]\n  },\n  \"lastModifiedDateTime\": \"2026-04-24T14:30:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"error-codes-1"},"children":["Error codes"]},{"$$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":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Validation failed. The response body includes a machine-readable error code and an actionable message."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed. Your bearer token is missing or invalid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your account doesn't have the required permission for this operation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The shipment ID you provided doesn't exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An unexpected server error occurred. If this persists, contact project44 support."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"arrangement-behavior-on-post-and-put"},"children":["Arrangement behavior on POST and PUT"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both methods match each request arrangement against stored arrangements by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," (see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#arrangement-types"},"children":["Arrangement types"]}," for how these are populated). The methods differ in what they write to a matched arrangement, and whether arrangements omitted from the payload are affected."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Arrangements are shared across shipments."]}," An arrangement is a tenant-scoped entity that can be linked to many shipments at the same time. The same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]},") always refers to the same underlying arrangement, regardless of which shipment is being updated. Updating an arrangement via any one shipment mutates the underlying entity, so the new state is visible on every other shipment the arrangement is linked to."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"post-append-and-link-with-a-partial-merge"},"children":["POST: append-and-link with a partial merge"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A matched arrangement is updated by ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["partial merge"]},": only the fields present in the request are written. Fields absent from the request are left unchanged."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An arrangement with no match is created and linked to the shipment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Arrangements omitted from the payload are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["left untouched"]},". POST never unlinks."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"put-snapshot-replace-of-the-shipments-arrangement-set"},"children":["PUT: snapshot-replace of the shipment's arrangement set"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The shape of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.arrangements"]}," in the request determines behavior:"]},{"$$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":"plan.arrangements in the request"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["plan.arrangements"]}," in the request"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Behavior"},"children":["Behavior"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field absent or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No-op. Arrangements and their links are untouched."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["empty list ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Every arrangement linked to this shipment is unlinked. The arrangements themselves are not deleted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["non-empty list ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[...]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Snapshot-replace (see the rules that follow)."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a non-empty list:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A matched arrangement has its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["fully replaced"]}," by the request's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}," (subject to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#immutability-rules-post-and-put"},"children":["immutability rules"]},"). Other top-level fields (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]},") cannot change."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An arrangement with no match is created and linked."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Stored arrangements linked to the shipment but ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["absent from the request"]}," are unlinked. The arrangement entities are not deleted."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After a successful PUT, a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," on the shipment returns exactly the arrangements supplied in the request, in the same order."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"immutability-rules-post-and-put"},"children":["Immutability rules (POST and PUT)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following are rejected with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["400 Bad Request"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changing a stored arrangement's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," to a different non-null value."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Setting a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," on a stored arrangement whose ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," (it can only be set at creation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Clearing a stored arrangement's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Two arrangements in the same payload sharing the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Supplying both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," where they resolve to different stored arrangements (identity conflict)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Supplying an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," that does not exist."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"idempotency"},"children":["Idempotency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both methods are idempotent at the operation level when each arrangement carries a stable identifier. Retries that produce no state change emit no operations. Arrangements supplied with neither ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," nor ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," are treated as new on every call: include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["referenceId"]}," for retry-safe writes."]}]},"headings":[{"value":"Ocean Unified Arrangements [Beta]","id":"ocean-unified-arrangements-beta","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Before you begin","id":"before-you-begin","depth":2},{"value":"The plan","id":"the-plan","depth":2},{"value":"Scope","id":"scope","depth":3},{"value":"Arrangements","id":"arrangements","depth":3},{"value":"Arrangement types","id":"arrangement-types","depth":2},{"value":"OCEAN_CARRIER","id":"ocean_carrier","depth":3},{"value":"Fields","id":"fields","depth":4},{"value":"Service types","id":"service-types","depth":4},{"value":"Booking types","id":"booking-types","depth":4},{"value":"FREIGHT_FORWARDER","id":"freight_forwarder","depth":3},{"value":"Fields","id":"fields-1","depth":4},{"value":"Cargo owner arrangements","id":"cargo-owner-arrangements","depth":3},{"value":"Fields","id":"fields-2","depth":4},{"value":"Shipment type configurations","id":"shipment-type-configurations","depth":2},{"value":"Full Container Load (FCL)","id":"full-container-load-fcl","depth":3},{"value":"Single-container FCL","id":"single-container-fcl","depth":3},{"value":"Less-than-Container Load (LCL)","id":"less-than-container-load-lcl","depth":3},{"value":"Roll-on/Roll-off (RoRo)","id":"roll-on/roll-off-roro","depth":3},{"value":"Business scenarios","id":"business-scenarios","depth":2},{"value":"Scenario 1: FCL booked directly with the ocean carrier","id":"scenario-1-fcl-booked-directly-with-the-ocean-carrier","depth":3},{"value":"Scenario 2: FCL booked through a freight forwarder","id":"scenario-2-fcl-booked-through-a-freight-forwarder","depth":3},{"value":"Scenario 3: Single-container FCL","id":"scenario-3-single-container-fcl","depth":3},{"value":"Scenario 4: FCL with related container shipments","id":"scenario-4-fcl-with-related-container-shipments","depth":3},{"value":"Scenario 5: FCL with discovery policy","id":"scenario-5-fcl-with-discovery-policy","depth":3},{"value":"Scenario 6: Multi-carrier FCL (NVOCC contractual + operating)","id":"scenario-6-multi-carrier-fcl-nvocc-contractual--operating","depth":3},{"value":"Scenario 7: Roll-on/Roll-off (RoRo)","id":"scenario-7-roll-on/roll-off-roro","depth":3},{"value":"Scenario 8: Standard LCL booked with the ocean carrier","id":"scenario-8-standard-lcl-booked-with-the-ocean-carrier","depth":3},{"value":"Scenario 9: LCL with a coloader","id":"scenario-9-lcl-with-a-coloader","depth":3},{"value":"Scenario 10: Buyer's consolidation","id":"scenario-10-buyers-consolidation","depth":3},{"value":"Scenario 11: Shipper's consolidation","id":"scenario-11-shippers-consolidation","depth":3},{"value":"Scenario 12: Consol-deconsol","id":"scenario-12-consol-deconsol","depth":3},{"value":"Linking cargo shipments via shared arrangements","id":"linking-cargo-shipments-via-shared-arrangements","depth":3},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"POST /shipments/tracking","id":"post-/shipments/tracking","depth":3},{"value":"Request headers","id":"request-headers","depth":4},{"value":"Request body parameters","id":"request-body-parameters","depth":4},{"value":"Response fields","id":"response-fields","depth":4},{"value":"Request example","id":"request-example","depth":4},{"value":"Response example","id":"response-example","depth":4},{"value":"Error codes","id":"error-codes","depth":4},{"value":"PUT /shipments/tracking","id":"put-/shipments/tracking","depth":3},{"value":"Request headers","id":"request-headers-1","depth":4},{"value":"Request body parameters","id":"request-body-parameters-1","depth":4},{"value":"Request example","id":"request-example-1","depth":4},{"value":"Response example","id":"response-example-1","depth":4},{"value":"Error codes","id":"error-codes-1","depth":4},{"value":"Arrangement behavior on POST and PUT","id":"arrangement-behavior-on-post-and-put","depth":3},{"value":"POST: append-and-link with a partial merge","id":"post-append-and-link-with-a-partial-merge","depth":4},{"value":"PUT: snapshot-replace of the shipment's arrangement set","id":"put-snapshot-replace-of-the-shipments-arrangement-set","depth":4},{"value":"Immutability rules (POST and PUT)","id":"immutability-rules-post-and-put","depth":4},{"value":"Idempotency","id":"idempotency","depth":4}],"frontmatter":{"seo":{"title":"Ocean Unified Arrangements [Beta] - project44 Developer Portal","description":"Draft API documentation and user guide for the Ocean Unified Arrangements beta feature."}},"lastModified":"2026-06-10T09:31:19.000Z"},"slug":"/guides/shippers/visibility/ocean/ocean-unified-arrangements","userData":{"isAuthenticated":false,"teams":["anonymous"]}}