API Information

Integration Types & Schemas

Carrier Operations - Booking Response

Receive a Booking Response from the carrier.

Objects

Name	Description
Root	A response from the carrier confirming processing of a booking request.
OuterPack	The outermost packaging of the cargo.
InnerPack	The packaging layer below the outer pack.
HazardousGoods	Hazardous material declaration for a single goods detail.
ShipmentLeg	A single transportation segment in a shipment's larger journey from origin to destination.
Container	A request for container(s) on a booking.
Party	Represents a named party on a job.
PartyIdentifier	A code and context that can be used to uniquely identify a party.
Contact	A point of contact at a particular party.
PhoneNumber	A phone number and type object.
EmailAddress	An email address and type object.
Address	A location representing a street address.
Port	A unique port location.
UnLocode	A location representing a UN location code.
AirPort	A location representing an airport.
Weight
Volume
Dimensions
Temperature
Value
Document	A document / file that is associated with the booking response.
Charge	A monetary charge amount that will be billed at some point in the future.
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.
Root_split_booking	Information regarding booking splits.
Root_export_license	Export license data.
HazardousGoods_radioactivity	The hazardous goods radioactivity level.
Container_gas_level
Charge_charge_amount	The amount associated with the charge as will be billed by the creditor.

Root top

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.	YES
`transaction_date`	DateTime	The date and time this acknowledgement data was constructed.
`booking_status`	String	An indicator designating the type of booking confirmation issued by the carrier. pending = A general status indicating the booking request was received and is being processed. accepted = booking data has been accepted by the carrier. conditionally_accepted = booking data has been accepted by the carrier with additional conditions. cancelled = previously accepted booking has been cancelled by the carrier. Cancellations may happen at the request of the booking party or may be the result of the carrier executing a booking split. replaced = booking data has been replaced by a new booking. This will typically occur on split bookings. Allowed values: pending, accepted, conditionally_accepted, cancelled, replaced, confirmed.
`booking_status_description`	String	A free-text field providing additional descriptive text regarding the acknowledgement status.
`booking_status_reason_code`	String	A platform specific code identifying a specific cause for the status provided. This code is usually only provided when a rejected or cancelled status is issued.
`booking_status_reason_description`	String	Free-text description providing details for the acknowledgement status.
`split_booking`	Root_split_booking	Information regarding booking splits.
`transport_mode`	String	The primary means of transport of the goods on their journey. Allowed values: sea, air, road, rail, sea_air, air_sea, inland_waterway, rail_sea, rail_air.
`movement_type`	String	The type of shipment service requested on the booking, defining the location types where the carrier will receive the goods and where the carrier will relinquish the goods. Allowed values: port_to_port, door_to_door, door_to_port, port_to_door.
`containerization_type`	String	The container load type required on the booking. Allowed values: fcl, lcl, ftl, ltl.
`booking_direction`	String	The directionality of the booking when the booking represents a single portion of a larger shipment. For instance, a trucking order may utilize this to determine if the booking represents an export pickup or an import delivery. Allowed values: import, export, domestic, foreign_to_foreign.
`freight_payment_terms`	String	The freight terms of payment indicating the party responsible for freight charges. Allowed values: collect, prepaid, third_party.
`carrier_comments`	String	Additional information provided by the carrier regarding the booking.
`carrier_terms_and_conditions`	String	Terms and conditions provided by the carrier for the booking.
`carrier_amendment_reason`	String	A free-text description of reason for the carrier issuing a changed booking confirmation.
`environmental_pollutant`	Boolean	True if the cargo is considered an environmental pollutant.
`hazardous`	Boolean	True if the cargo is considered hazardous or dangerous goods.
`out_of_gauge_freight`	Boolean	True if the cargo is considered out of gauge (OOG) and does not fit into standard shipping containers.
`temperature_controlled`	Boolean	True if the cargo must be transported using specific temperature settings.
`stackable`	Boolean	True if the goods packaging allows for it to be stacked.
`customs_value`	Value	The total goods value for customs declaration purposes.
`carriage_value`	Value	The total goods selling price or replacement cost.
`volume`	Volume	The total volume of goods booked.
`gross_weight`	Weight	The total gross weight of the goods booked.
`chargeable_weight`	Weight	The total chargeable weight of the goods booked.
`carrier_service_level`	String	The carrier's service level for this booking. It is more often used in air freight bookings and is typically a value like "Standard", "Express", "Premium", "Priority" or "Economy".
`earliest_empty_pickup`	DateTime	The earliest date empty containers can be picked up from the empty pickup location. For containerized bookings that have varying dates, dates should be recorded directly on the container object.
`latest_empty_pickup`	DateTime	The latest date empty containers can be picked up from the empty pickup location. For target systems that do not utilize date ranges for this date, the earliest_empty_pickup should be utilized. For containerized bookings that have varying dates, dates should be recorded directly on the container object.
`earliest_empty_drop_off`	DateTime	The earliest date empty containers can be delivered to the pickup location. For containerized bookings that have varying dates, dates should be recorded directly on the container object.
`latest_empty_drop_off`	DateTime	The latest date empty containers can be delivered to the pickup location. For target systems that do not utilize date ranges for this date, the earliest_empty_drop_off should be utilized. For containerized bookings that have varying dates, dates should be recorded directly on the container object.
`earliest_full_pickup_date`	DateTime	The earliest date the full containers / goods should be picked up from the pickup location. This may also be known as the Cargo Ready Date. For containerized bookings that have varying dates, dates should be recorded directly on the container object.
`latest_full_pickup_date`	DateTime	The latest date the full containers / goods should be picked up from the pickup location. For target systems that do not utilize date ranges for this date, the earliest_full_pickup_date should be utilized. For containerized bookings that have varying dates, dates should be recorded directly on the container object.
`earliest_full_drop_off`	DateTime	The earliest date the full container can be dropped off at the full_drop_off location. This may also be known as the Cutoff or Cutoff Physical date.
`latest_full_drop_off`	DateTime	The latest date the full container can be dropped off at the full_drop_off location. This may also be known as the Cutoff or Cutoff Physical date. For target systems that do not utilize date ranges for this date, the earliest_full_drop_off should be utilized.
`earliest_full_delivery_date`	DateTime	The earliest date the container should be delivered to the delivery location. For containerized bookings that have varying dates, dates should be recorded directly on the container object.
`latest_full_delivery_date`	DateTime	The latest date the container should be delivered to the delivery location. For containerized bookings that have varying dates, dates should be recorded directly on the container object.
`shipping_instructions_cutoff_date`	DateTime	The cutoff date for when the shipping instructions should be sent to the carrier.
`vgm_cutoff_date`	DateTime	The cutoff date for when the Verified Gross Mass (VGM) information must be sent to the carrier.
`empty_pickup`	Party	The default location the empty container should be picked up from and delivered to the pickup location. When multiple pickup locations are required, the empty_pickup property on the container should be utilized to specify any alternate empty_pickup locations.
`pickup`	Party	The default original pickup location of the cargo. Also known as the Ship From location. When multiple pickup locations are required, the pickup property on the container should be utilized to specify any alternate pickup locations.
`place_of_receipt`	Port	The location the carrier will receive the cargo from the shipper.
`port_of_loading`	Port	The location the cargo will be loaded onto the primary conveyance / vessel.
`transshipment_port`	Port	The port the cargo should be trans-shipped at.
`port_of_discharge`	Port	The location the cargo will be offloaded from the primary conveyance / vessel.
`place_of_delivery`	Port	The location the carrier will hand over the cargo to the consignee.
`delivery`	Party	The default location the cargo will ultimately be delivered to. Typically this would represent the consignee's physical location. When multiple delivery locations are required, the delivery property on the container should be utilized to specify any alternate delivery locations.
`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.
`export_license`	Root_export_license	Export license data.
`carrier`	Party	The carrier the booking should be or has been placed with.
`consignee`	Party	The party that is the receiver of the shipment / goods. This should represent the party that will be the named consignee on the Bill of Lading - often this will be the receiving/destination forwarder.
`shipper`	Party	The party that is responsible for sending the goods and handling all documentation. Also known as the consignor or exporter. This should represent the that party that will be the named shipper on the Bill of Lading - often this will be the sending/origin forwarder.
`contract_party`	Party	The party that is associated with the carrier contract the booking should utilize.
`freight_payer`	Party	The party that is responsible for repayment of all freight charges issued by the carrier.
`forwarder`	Party	The forwarder that associated with the booking.
`notify_party`	Party	The party that will be listed as the primary notification party to be contacted when the shipment arrives at its destination. This is often the party that will be responsible for arranging customs clearance at the destination.
`second_notify_party`	Party	An additional party to notify when the shipment arrives at its destination.
`third_notify_party`	Party	An additional party to notify when the shipment arrives at its destination.
`booking_party`	Party	The party that is that responsible for the booking.
`carrier_booking_office`	Party	The specific carrier booking office that the booking is being handled by.
`import_customs_broker`	Party	The customs broker filing import declarations.
`export_customs_broker`	Party	The customs broker filing export declarations.
`shipment_legs`	Array<ShipmentLeg>	All the routing information for the booking. Legs should be ordered such that they describe the progression of the cargo from the booking origin to destination.
`outer_packs`	Array<OuterPack>	Information about the cargo transported on the booking.
`containers`	Array<Container>	All the containers requested on the booking.
`documents`	Array<Document>	Any booking documents / files associated with the entire booking.
`charges`	Array<Charge>	Any charges, freight or otherwise, associated with the booking.
`custom_properties`	CustomProperties

OuterPack top

Name	Data Type	Description
`tms_system_identifier`	String	The primary key uniquely identifying this outer pack 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 pack record.
`line_number`	Integer	A counter identifying the line number associated with this cargo line.
`number_of_packages`	Integer	The number of packages associated with this pack.
`package_type_code`	String	A packaging code describing the cargo. When possible, the 2 character UN/ECE Trade Facilitation Recommendation No. 21 package code should be utilized to enhance interoperability.
`package_type_description`	String	A free text description of the goods packaging.
`volume`	Volume
`gross_weight`	Weight
`net_weight`	Weight
`country_of_origin`	String	The ISO-3166-2 two digit code representing the country of origin of the goods represented in this pack.
`hs_code`	String	The Harmonized System Schedule code. It is recommended that the 6 character WCO classification code is provided.
`description_of_goods`	String	A description of the cargo contained in this packaging.
`package_dimensions`	Dimensions
`sku_number`	String	The buyer's SKU number for the goods inside the packaging. If there are multiple SKU numbers that need to be tracked per package, then inner packs should be utilized for each sku.
`buyer_reference`	String	The reference number the buyer associates with this packaging. Typically, this would be a purchase order number.
`vehicle_identification_number`	String
`nmfc_freight_class`	String	The National Motor Freight Classification Code for used to rate commodities based on their stowability, liability, ease of handling, and density.
`container_identifier`	String	Identifies the container the pack detail belongs inside of. This property should exactly match to the container's container_identifier property. In cases where package data is inside multiple containers, multiple pack records should be sent - one record for each container.
`hazardous_goods`	Array<HazardousGoods>	Any hazardous goods information applicable to the specific packages respresented by this pack data.
`inner_packs`	Array<InnerPack>	Inner packaging inside this outer pack.
`custom_properties`	CustomProperties

InnerPack top

Name	Data Type	Description
`tms_system_identifier`	String	The primary key uniquely identifying this inner pack 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 item record.
`number_of_packages`	Integer	The number of outermost item packages associated with this inner pack.
`package_type_code`	String	A packaging code describing the item. When possible, the 2 character UN/ECE Trade Facilitation Recommendation No. 21 package code should be utilized to enhance interoperability.
`package_type_description`	String	A free text description of the goods packaging.
`package_dimensions`	Dimensions
`volume`	Volume
`gross_weight`	Weight
`country_of_origin`	String	The ISO-3166-2 two digit code representing the country of origin of this item.
`hs_code`	String	The Harmonized System Schedule code. It is recommended that the 6 character WCO classification code is provided.
`description_of_goods`	String	A description of the item.
`sku_number`	String	The buyer's SKU number for this item.
`buyer_reference`	String	The reference number the buyer associates with this item. Typically, this would be a purchase order number.
`custom_properties`	CustomProperties

HazardousGoods top

Name	Data Type	Description
`imo_class_code`	String	The IMO (International Maritime Organization) classification code for the dangerous goods.
`packing_group_code`	String	The UN packing code describing the protective packaging for the dangerous goods. great_danger = IATA/IMDG/ADR/RID Group I medium_danger = IATA/IMDG/ADR/RID Group II minor_danger = IATA/IMDG/ADR/RID Group III Allowed values: great_danger, medium_danger, minor_danger.
`undg_number`	String	The UN Dangerous Goods Number designating the type of dangerous good being shipped.
`flashpoint_temperature`	Temperature
`ems_number`	String	The Emergency Response Procedure code denoting procedures for handling fire or spillage of the dangerous goods.
`trem_card_number`	String	The transport emergency card giving advice for emergency actions while transporting this hazardous good.
`proper_shipping_name`	String	The standard shipping name to describe the hazard properties and the composition of dangerous goods.
`technical_name`	String	The recognized chemical name of the substance as used by science.
`transport_in_limited_quantities`	Boolean	If true, the dangerous goods are being shipped in a "limited quantity" and granted relief from certain hazmat shipping requirements.
`empty_uncleaned_receptacle`	Boolean	Indication of whether the item is an uncleaned empty receptacle used with a hazardous material.
`marine_pollutant_status`	String	The marine pollutant status of the goods. Allowed values: marine_pollutant, not_marine_pollutant, severe_marine_pollutant.
`inhalant_hazard`	Boolean	Indication of whether the hazardous material is an inhalation hazard.
`aggregation_state`	String	The collected material state of the dangerous good. Allowed values: solid, liquid, gas.
`weight`	Weight	The weight of the goods without any packaging.
`volume`	Volume	The volume of the hazardous goods.
`radioactivity`	HazardousGoods_radioactivity	The hazardous goods radioactivity level.
`acid_concentration`	Decimal	A decimal percentage representing the acid concentration. This should never be a whole value. 100% = 1.000
`general_hazmat_information`	String	Used to provide additional information about the hazardous goods.
`radioactive_instructions`	String	Used to provide additional information regarding radioactive goods.
`regulatory_information`	String	Used to provide additional information to any regulatory authority.
`hazmat_placard_information`	String	Used to indicate the hazmat placard.
`emergency_response_contact`	Contact
`custom_properties`	CustomProperties

ShipmentLeg top

Name	Data Type	Description	Required
`tms_system_identifier`	String	The primary key uniquely identifying this shipment leg in the source TMS. This may be a sequence number, a routing label, a unique id number or a UUID value. If used, it should be capable of tying this record back to the TMS's leg / route record.
`transport_mode`	String	The means of transport of the cargo for this leg. Allowed values: sea, air, road, rail, sea_air, air_sea, inland_waterway, rail_sea, rail_air, rail_road.	YES
`leg_type`	String	Identifies the stage of transport the leg belongs to. Allowed values: pre_carriage, main, on_carriage.	YES
`vessel_name`	String	The name of the vessel that the shipment leg should be booked onto.
`imo_number`	String	The vessel's International Maritime Organization unique seven digit number.
`voyage_number`	String	The voyage, conveyance, flight or train number to utilize for this shipment leg.
`carrier`	Party	The carrier undertaking the transport for this shipment leg.
`origin`	Port	The origin port on this shipment leg.	YES
`destination`	Port	The destination port on this shipment leg.	YES
`carrier_cutoff_date`	DateTime	The latest date cargo can be delivered to the carrier at the origin point of the shipment leg.
`earliest_departure_date`	DateTime	The earliest date of departure that should be booked for this shipment leg.
`latest_departure_date`	DateTime	The latest date of departure that should be booked for this shipment leg.
`estimated_arrival_date`	DateTime	The estimated date of arrival that should be booked for this shipment leg.
`custom_properties`	CustomProperties

Container top

Name	Data Type	Description
`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_identifier`	String	This is the property that will be utilized to link a container record to an outer pack's container_identifier when no actual container_number is present. It represents a logical key for the container and should be a unique value across the booking.
`container_number`	String	The physical container number uniquely identifying the container. Typically an ISO 6346 standard number.
`type_code`	String	The ISO 6346 container type code or standard Unit Load Device (ULD) type code that is requested for the booking.
`type_description`	String	A free-form description of the container requested.
`quantity_requested`	Integer	The number of containers requested of this type.
`container_supplier`	String	An indicator of which party in the booking will be responsible for providing the container. Allowed values: shipper, carrier.
`empty_container`	Boolean	If true, the container when shipped will be empty.
`gross_weight`	Weight	The gross weight of the cargo in the container.
`volume`	Volume	The total volume of the cargo in the container.
`container_release_number`	String	A reference number identifying the container release order issued by the carrier.
`humidity`	Boolean
`humidity_percentage`	Decimal	A decimal percentage representing the humidity / percentage of moisture in the air setting requested for this container. This should never be a whole value. 100% = 1.000
`vent_setting`	String	Allowed values: open, closed.
`air_flow`	Volume	The total volume air flow per hour requested for this container.
`gas_level`	Array<Container_gas_level>	The gas levels present in the container as requested by the container.
`dimensions`	Dimensions
`non_active_reefer`	Boolean	Used to indicate a reefer container type is requested to be booked without the refrigeration unit enabled.
`equipment_controlled_atmosphere`	Boolean
`temperature`	Temperature	The requested temperature setting for the cargo while transporting the cargo.
`temperature_variance`	Decimal
`number_of_temperature_probes`	Integer
`number_of_usd_probes`	Integer
`super_freezer_service`	Boolean
`genset_required`	Boolean
`in_transit_cold_sterilization`	Boolean
`comments`	String	Any additional general comments regarding general container handling or instructions.
`temperature_control_instructions`	String	Additional instructions regarding any temperature control requirements of the container.
`empty_pickup`	Party	The location the empty container should be picked up and delivered to the pickup location. When distinct empty pickup locations are required for different containers the empty pickup must be provided at the container level.
`pickup`	Party	The location where the cargo that will be in this container should be picked up. When distinct pickup locations are required for different containers the pickup must be provided at the container level.
`full_drop_off`	Party	The container yard / terminal the full container should be dropped off after being picked up from the pickup location.
`delivery`	Party	The location where the cargo that will be in this container should be delivered. When distinct delivery locations are required for different containers the delivery must be provided at the container level.
`earliest_empty_pickup`	DateTime	The earliest date the empty container can be picked up from the empty pickup location.
`latest_empty_pickup`	DateTime	The latest date the empty container can be picked up from the empty pickup location. For target systems that do not utilize date ranges for this date, the earliest_empty_pickup should be utilized.
`earliest_empty_drop_off`	DateTime	The earliest date the empty container can be delivered to the pickup location.
`latest_empty_drop_off`	DateTime	The latest date the empty container can be delivered to the pickup location. For target systems that do not utilize date ranges for this date, the earliest_empty_drop_off should be utilized.
`earliest_full_pickup_date`	DateTime	The earliest date the full container should be picked up from the pickup location. This may also be known as the Cargo Ready Date.
`latest_full_pickup_date`	DateTime	The latest date the full container should be picked up from the pickup location. For target systems that do not utilize date ranges for this date, the earliest_pickup_date should be utilized.
`earliest_full_drop_off`	DateTime	The earliest date the full container can be dropped off at the full_drop_off location. This may also be known as the Cutoff or Cutoff Physical date.
`latest_full_drop_off`	DateTime	The latest date the full container can be dropped off at the full_drop_off location. This may also be known as the Cutoff or Cutoff Physical date.
`earliest_full_delivery_date`	DateTime	The earliest requested date the container should be delivered to the delivery location.
`latest_full_delivery_date`	DateTime	The earliest requested date the container should be delivered to the delivery location. For target systems that do not utilize date ranges for this date, the earliest_full_delivery_date should be utilized.
`documents`	Array<Document>	Any documents / files associated solely with this individual container.
`custom_properties`	CustomProperties

Party top

Name	Data Type	Description
`identifiers`	Array<PartyIdentifier>	An array of all applicable identifiers that can be used to identify the party.
`name`	String	The entity's name.
`address_1`	String	The address' street number and name.
`address_2`	String	The address' secondary address information.
`city`	String	The address' city component.
`country_subdivision`	String	The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data.
`country`	String	The address' 2 character ISO-3166-2 country Code.
`postal_code`	String	The unique postal code identifier for the address.
`contact`	Contact	A point of contact at the party.

PartyIdentifier top

Name	Data Type	Description	Required
`code`	String	The identifier code	YES
`code_type`	String	The type of data that the identifier code represents. Allowed values: tms_external_identifier, booking_system_identifier, iata, scac, legal_entity_id, duns.	YES
`code_country`	String	The 2 character ISO-3166-2 country code that the id code was issued in / by.

Contact top

Name	Data Type	Description
`name`	String	The contact's full name.
`phone_numbers`	Array<PhoneNumber>
`email_addresses`	Array<EmailAddress>

PhoneNumber top

Name	Data Type	Description	Required
`phone_type`	String	The type of phone number. Allowed values: main, mobile, work, home, fax, other.	YES
`phone_number`	String	The actual phone number. When at all possible, to increase interoperability, phone numbers should be formatted according to RFC3966. Also see libphonenumber when parsing phone numbers.	YES

EmailAddress top

Name	Data Type	Description	Required
`email_type`	String	The type of email address. Allowed values: main, work, personal, other.	YES
`email_address`	String	The email address	YES

Address top

Name	Data Type	Description	Required
`type`	String	A location type identifier. Allowed values: address.	YES
`name`	String	A name for the address. Typically the name of the business located at the address.
`address_1`	String	The address' street number and name.	YES
`address_2`	String	The address' secondary address information.
`city`	String	The address' city component.	YES
`country_subdivision`	String	The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data.
`country`	String	The address' 2 character ISO-3166-2 country Code.	YES
`postal_code`	String	The unique postal code identifier for the address.
`unlocode`	String	A UN/Locode identifier correlated with the address.
`unlocode_description`	String	A free text description of the UN/Locode.

Port top

Name	Data Type	Description	Required

UnLocode top

Name	Data Type	Description	Required
`type`	String	A location type identifier Allowed values: unlocode.	YES
`unlocode`	String	The UN/Locode identifier for the sea port.	YES
`unlocode_description`	String	A free text description of the UN/Locode.

AirPort top

Name	Data Type	Description	Required
`type`	String	A location type identifier Allowed values: airport.	YES
`iata_code`	String	The IATA airport location identifier.	YES
`iata_code_description`	String	A free text description of the IATA Code.
`unlocode`	String	The UN/Locode identifier correlated with the IATA code.

Weight top

Name	Data Type	Description	Required
`amount`	Decimal	The numeric weight amount	YES
`unit`	String	The unit of measure associated with the amount property. tonne = Metric Tonne (1,000 kilograms), ton = Imperial Tonne (1,000 pounds) Allowed values: kilogram, tonne, pound, ton.	YES

Volume top

Name	Data Type	Description	Required
`amount`	Decimal	The numeric volume amount	YES
`unit`	String	The unit of measure associated with the amount property. gallon - US liquid gallon (3.785411784 litres), imperial_gallon = UK gallon (4.54609 litres) Allowed values: cubic_meter, cubic_foot, liter, gallon, imperial_gallon.	YES

Dimensions top

Name	Data Type	Description	Required
`unit`	String	Allowed values: inch, foot, centimeter, meter.	YES
`length`	Decimal		YES
`width`	Decimal		YES
`height`	Decimal		YES

Temperature top

Name	Data Type	Description	Required
`unit`	String	Allowed values: celsius, fahrenheit.	YES
`amount`	Decimal		YES

Value top

Name	Data Type	Description	Required
`amount`	Decimal	The value amount.	YES
`currency`	String	The ISO 4217 currency code indicating the currency of the value.	YES

Document top

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
`custom_properties`	CustomProperties

Charge top

Name	Data Type	Description	Required
`charge_identifier`	String	A value that uniquely identifies the charge. This may be used to convey a primary key for some systems while for others it can also just be a numeric counter.
`line_number`	Decimal	A line number that can be used to sort the charges in the correct presentation order. The number must be greater than 0.
`charge_code`	String	A code used by the issuer to identify the goods or service associated with the charge.	YES
`charge_classification`	String	A code used by the issuer accounting system that classifies the type of charge.
`description`	String	A description of the goods or services associated with the charge.
`charge_amount`	Charge_charge_amount	The amount associated with the charge as will be billed by the creditor.	YES
`payment_terms`	String	The terms of payment associated with the charge. Allowed values: collect, prepaid.
`charge_location_type`	String	Identifies the general section of the shipment that the charges are associated with. Allowed values: origin, destination.
`creditor`	Party	The party that has provided goods or services and is owed money by the debtor.	YES
`debtor`	Party	The party that incurs the liability for charge.
`custom_properties`	CustomProperties

CustomProperties top

Name	Data Type	Description	Required

Root_split_booking top

Name	Data Type	Description
`split_status`	String	Indicates whether the booking data contained in this confirmation is split from another, parent booking. If this property is not present, it can be assumed the booking was not split. Allowed values: split_from_parent, not_split.
`parent_booking_number`	String	If the booking was split apart from another booking, this value represents the carrier booking number of that booking.
`split_reason_code`	String	A platform specific code identifying a specific reason for why the booking was split.
`split_reason_description`	String	A free-text field providing additional details regarding the booking split.
`split_comments`	String	Additional free-text comments regarding the split booking.

Root_export_license top

Name	Data Type	Description	Required
`export_license_number`	String	The export license number to associate with this booking.	YES
`issued_date`	String	The issue date of the export license.
`expiration_date`	String	The expiration date of the export license.

HazardousGoods_radioactivity top

Name	Data Type	Description	Required
`unit`	String	Allowed values: megabecquerel.
`value`	Decimal

Container_gas_level top

Name	Data Type	Description	Required
`gas`	String	Allowed values: carbon_dioxide, nitrogen, oxygen.
`value`	Decimal	The percentage of this gas requested present in the container.

Charge_charge_amount top

Name	Data Type	Description	Required
`total`	Decimal	The total amount for the charge.	YES
`currency`	String	The ISO 4217 currency code indicating the currency the charge represents.	YES

Introduction to Open Connect

API Information

Integration Types & Schemas

Carrier Operations - Booking Response

Objects