API Information

Integration Types & Schemas

Carrier Operations - Booking Acknowledgement

Receive Booking Responses / Acknowledgements from the carrier.

Objects

Name	Description
Root	A response from the carrier acknowledging receipt of a booking request.
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.
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 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 acknowledging. 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 acknowledgement is targeting.	YES
`transaction_date`	DateTime	The date and time this acknowledgement data was constructed.
`acknowledgement_status`	String	An indicator designating the type of booking acknowledgement issued by the carrier. received = booking data has been received by the carrier. accepted = booking data has been accepted into the carrier's system. rejected = booking data has been rejected by the carrier. This will typically be due to invalid or missing booking data. 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: received, accepted, rejected, cancelled, replaced.
`acknowledgement_status_description`	String	A free-text field providing additional descriptive text regarding the acknowledgement status.
`acknowledgement_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.
`acknowledgement_reason_description`	String	Free-text description providing details for the acknowledgement status.
`master_bill_of_lading`	String	The master bill of lading number the carrier has assigned to the booking.
`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.
`carrier`	Party	The carrier associated with the booking request.
`booking_party`	Party	The party that is that responsible for the booking.
`custom_properties`	CustomProperties

Party top

Name	Data Type	Description	Required
`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	Required
`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

CustomProperties top

Name	Data Type	Description	Required

© 2026 Chain.io, Inc.