Receive standalone booking files from the booking platform.
| Name | Description |
|---|---|
| Root | A document / file that is associated with the bookings. |
| Booking | The booking linked to the document. |
| Container | Information identifying a single container linked to the document being sent. |
| CustomProperties | An object an input converter can utilize to pass any custom data back into a flow that can potentially be utilized by an output converter. |
| Name | Data Type | Description | Required |
|---|---|---|---|
document_identifier | String | The 'primary key' uniquely identifying the document in the issuer's booking system. | |
file_name | String | The file name of the document. | |
document_classification | String | A shared code identifying the type of document sent with the booking response. Allowed values: booking_confirmation, bill_of_lading, invoice, proof_of_delivery, email, shipping_manifest. | |
document_code | String | The booking system's native code for identifying the type of document being sent. This will typically be a code that might indicate a 'bill of lading' or an 'invoice' or any other documents the carrier deems relevant to the transaction. | YES |
document_description | String | A free-text description of the document. Typically, this will be a full description of the document_code value. | |
media_type | String | The identifier indicating the data format of the document. Also known as mime type. | YES |
body | String | The base4 encoded binary contents of the document. | YES |
creation_date | DateTime | ||
booking | Booking | ||
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
tms_system_identifier | String | The 'primary key' uniquely identifying the shipment in the TMS system that initiated the booking request the carrier is confirming. This value should be exactly the same as the tms_system_identifier that was sent to the carrier platform in the booking request. This is the primary method the TMS will utilize to determine which booking object the confirmation is targeting. | |
master_bill_of_lading | String | The master bill of lading number the carrier has assigned the booking to. | |
carrier_booking_number | String | The booking number the carrier has issued to identify this booking. | |
consignee_reference_number | String | The reference number the consignee uses to identify this movement of cargo. | |
contract_number | String | The contract number the booking should reference for freight rates. | |
forwarder_reference | String | The reference number the forwarder uses to identify this movement of cargo. Typically, this would be the house bill of lading. | |
buyer_reference | String | The reference number the buyer uses to identify this movement of cargo. Typically, this would be a purchase order number. | |
booking_system_identifier | String | The unique identifier the booking system provides for this booking. | |
shipper_reference | String | The reference number the shipper uses to identify this movement of cargo. | |
origin_booking_agent_reference | String | The reference number the booking agent uses to identify this movement of cargo. | |
containers | Array<Container> | Any specific container record referenced by the document. If container records are received then the documents referenced in this file are assumed to only be for the containers referenced here. If no containers are received, then the documents are assumed to be related to the entire booking. | |
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
tms_system_identifier | String | The primary key uniquely identifying this container in the source TMS. This may be a line number, a product code, a unique id number or a UUID value. If used, it should be capable of tying this record back to the TMS's container record and should correlate to the tms_system_identifier that was submitted for this container on the booking request. | |
container_number | String | The physical container number uniquely identifying the container. Typically an ISO 6346 standard number. |
| Name | Data Type | Description | Required |
|---|