| Attribute |
Scope |
Type |
|
Carrier Booking Reference
|
Private
|
String(35)
|
|
Notes:
|
The unique identifier for an object of this class, in the scope of a single enterprise / organisational unit.<br/>The associated booking number provided by the carrier. Condition: either<br/>the Carrier Booking Reference or the Carrier Booking Request Reference<br/>must be provided.<br/><br/>
|
|
|
Carrier Booking Request Reference
|
Private
|
String(100)
|
|
Notes:
|
A reference to the booking during the booking request phase. The associated booking number provided by the carrier to the booking request. Condition: either the Carrier Booking Reference or the Carrier Booking Request Reference must be provided.<br/>
|
|
|
Booking Status Code
|
Private
|
String(50)
|
|
Notes:
|
The current status of the booking, which can be one of the following values:<br/>• Received<br/>• Pending update<br/>• Update received<br/>• Confirmed<br/>• Pending amendment<br/>• Cancelled<br/>• Rejected<br/>• Declined<br/>• Completed<br/>
|
|
|
Amended Booking Status Code
|
Private
|
String(50)
|
|
Notes:
|
The current status of the booking amendment, which can be one of the<br/>following values:<br/><ul>
<li>Amendment received</li><li>Amendment confirmed</li><li>Amendment cancelled</li><li>Amendment declined</li></ul>
Condition: required if a booking amendment has been submitted.<br/>
|
|
|
Receipt Type at Origin
|
Private
|
String(3)
|
|
Notes:
|
Indicates the type of service offered at Origin. Options are defined in the Receipt / Delivery Type entity.<br/>Indicates the type of service offered at Origin. The options are:<br/><ul>
<li>CY or container yard (incl. rail ramp) where the carrier takes ownership of a fully stuffed container provided by the customer at the carrier/carrier's appointed supplier's facility (usually called terminal or depot) as defined by the Place of Receipt or POL shipment locations.</li><li>SD or store door, indicating that the carrier is taking ownership of a fully stuffed container at the customer's appointed premises as defined by the Place of Receipt shipment location.</li><li>CFS or container freight station, indicating that the carrier has received the cargo and is responsible for stuffing of the cargo within the container for export activities.</li></ul><p/>
|
|
|
Delivery Type at Destination
|
Private
|
String(3)
|
|
Notes:
|
Indicates the type of service offered at Destination. Options are defined in the Receipt / Delivery Type entity.<br/>Indicates the type of service offered at Destination. The options are:<br/><ul>
<li>CY or container yard (incl. rail ramp) where a fully stuffed container is released to the customer by the carrier at the carrier/carrier's appointed supplier's facility (usually called terminal or depot) as defined by the POD or Place of Delivery shipment locations.</li></ul>
<ul>
<li>SD or store door, indicating that the carrier delivers a fully stuffed container at the customer’s appointed premises as defined by the Place of Delivery shipment location.</li><li>CFS or container freight station, indicating that the carrier has received the cargo and is responsible for stripping the containerfor import activities.</li></ul><p/>
|
|
|
Cargo Movement Type at Origin
|
Private
|
String(3)
|
|
Notes:
|
Refers to the Cargo Movement Type at the loading of the cargo into the container. Options are defined in the Cargo Movement Type entity.<br/>Refers to the shipment term at the loading of the cargo into the container.<br/>The options are:<br/><ul>
<li>FCL (Full Container Load) indicating that the shipper or its agent or subcontractor is responsible for stuffing the cargo into the container and bears every responsibility and liability in such respect.</li></ul>
<ul>
<li>LCL (Less than Container Load) indicating that the carrier or its agent or subcontractor is responsible for stuffing the cargo into the container and bears every responsibility and liability in such respect.</li></ul><p/>
|
|
|
Cargo Movement Type at Destination
|
Private
|
String(3)
|
|
Notes:
|
Refers to the Cargo Movement Type at the unloading of the cargo out of the container. Options are defined in the Cargo Movement Type entity.<br/>Refers to the shipment term at the unloading of the cargo out of the container. The options are:<br/><ul>
<li>FCL (Full Container Load) indicating that the consignee or its agent or subcontractor is responsible for stripping the cargo from the container and bears every responsibility and liability in such respect.</li><li>LCL (Less than Container Load) indicating that the carrier or its agent or subcontractor is responsible for stripping the cargo from the container and bears every responsibility and liability in such respect.</li></ul><p/>
|
|
|
Freight Payment Term Code
|
Private
|
String(3)
|
|
Notes:
|
An indicator of whether freight and ancillary fees for the main transport are prepaid (PRE) or collect (COL). When prepaid the charges are the responsibility of the shipper or the Invoice payer on behalf of the shipper (if provided). When collect, the charges are the responsibility of the consignee or the Invoice payer on behalf of the consignee (if provided).<br/>
|
|
|
Service Contract Reference
|
Private
|
String(30)
|
|
Notes:
|
Reference number for agreement between shipper and carrier through which the shipper commits to provide a certain minimum quantity of cargo over a fixed period, and the carrier commits to a certain rate or rate schedule.<br/>
|
|
|
Is Export Declaration Required
|
Private
|
Boolean
|
|
Notes:
|
Information provided by the shipper to indicate whether an export declaration is required for this shipment/commodity/destination. If this property is omitted, it may be interpreted differently by different API providers and by the same API provider in different contexts.<br/>
|
|
|
Is Partial Load Allowed
|
Private
|
Boolean
|
|
Notes:
|
Indicates whether the shipper agrees to load part of the shipment in case not all of the cargo is delivered within cut-off. Note: The carrier is not liable in case unable to follow the customer's instructions due to operational constraints. If this property is omitted, it may be interpreted differently by different API providers and by the same API provider in different contexts.<br/>
|
|
|
Export Declaration Reference
|
Private
|
String(35)
|
|
Notes:
|
Reference number assigned to an Export declaration typically submitted by the exporter (or the freight forwarder on behalf of the exporter) that provides detailed information about the goods being exported. It serves as a record for the exporting country’s government and is used for statistical, regulatory, and compliance purposes. The export declaration must typically be submitted to the relevant customs authorities before the goods leave the exporting country.<br/>
|
|
|
Contract Quotation Reference
|
Private
|
String(35)
|
|
Notes:
|
Information provided by the shipper to identify whether pricing for the shipment has been agreed via a contract or a quotation reference. Mandatory if service contract (owner) is not provided<br/>
|
|
|
Incoterms
|
Private
|
String(3)
|
|
Notes:
|
Transport obligations, costs and risks as agreed between buyer and seller.<br/>
|
|
|
Expected Departure Date
|
Private
|
Date
|
|
Notes:
|
The date when the shipment is expected to be loaded on board a vessel as provided by the shipper or its agent. <font color="#1f1c2b">If vessel/voyage or expected date of arrival is not provided, this is mandatory.</font><br/>
|
|
|
Expected Arrival at Place of Delivery Start Date
|
Private
|
Date
|
|
Notes:
|
<font color="#1f1c2b">The dates (provided as a range) for when the shipment is expected to arrive at Place of Delivery – start of the range. </font><br/><font color="#1f1c2b">Condition: Mandatory if vessel/voyage or expected departure date or pick-up date at place of receipt is not provided.</font><br/>
|
|
|
Expected Arrival at Place of Delivery End Date
|
Private
|
Date
|
|
Notes:
|
<font color="#1f1c2b">The dates (provided as a range) for when the shipment is expected to arrive at Place of Delivery – end of the range.</font><br/><font color="#1f1c2b">Condition: Mandatory if vessel/voyage or expected departure date or pick-up date at place of receipt is not provided.</font><br/>
|
|
|
Transport Document Type Code
|
Private
|
String(3)
|
|
Notes:
|
Specifies the type of the associated Transport Document (Bill of Lading or Sea Waybill)<br/>
|
|
|
Transport Document Reference
|
Private
|
String(20)
|
|
Notes:
|
The unique identifier of the transport document that the booking concerns.<br/>
|
|
|
Booking Channel Reference
|
Private
|
String(20)
|
|
Notes:
|
Identification number provided by the platform/channel used for booking request/confirmation”, ex: Inttra booking reference, or Infor Nexus, other.<br/><font color="#1f1c2b">Conditional on booking channel being used.</font><br/>
|
|
|
Is Equipment Substitution Allowed
|
Private
|
Boolean
|
|
Notes:
|
Indicates if an alternate equipment type can be provided by the carrier.<br/>
|
|
|
Declared Value
|
Private
|
Float
|
|
Notes:
|
The value of the cargo that the shipper declares in order to avoid the carrier's limitation of liability and "Ad Valorem" freight, i.e., freight which is calculated based on the value of the goods declared by the shipper.<br/>
|
|
|
Declared Value Currency Code
|
Private
|
String(3)
|
|
Notes:
|
The currency used for the declared value, using the 3-character code defined by ISO 4217.<br/><font color="#1f1c2b">Condition: required if the declared value is provided.</font><br/>
|
|
|
Booking Cancellation Status Code
|
Private
|
Booking Cancellation Status Code
|
|
Notes:
|
The status of the latest booking cancellation. If no cancellation has been requested - then this property is empty.<br/>
|
|
|
Carrier Clauses
|
Private
|
String(2000)
|
|
Notes:
|
Additional clauses for a specific shipment added by the carrier to the Bill of Lading, subject to local rules / guidelines or certain mandatory information required to be shared with the customer.<br/>
|
|
