Booking Response EDI - JSON Specification

Summary

The EDI-flavored JSON for an EDI 990 (Response to a Load Tender). This is the Chain.io destination file type "chainioBookingResponseEDI". A downstream EDI translation engine serializes it to X12 990, so field values are pre-coded to X12 code lists and any segment references below are logical correspondence, not literal output. One response per file. This is NOT the same as the canonical Booking Response ("chainioBookingResponseJSON"): the EDI form is a single "booking_response" object with no top-level "version" or "doc_type", and adds "flow_execution_uuid" and "additional_reference_numbers".
NameDescription
RootThe top level document. Unlike the canonical Booking Response there is no "version" or "doc_type" wrapper and exactly one response is present.
BookingResponseA carrier/party response accepting or declining a load tender (EDI 990).
AdditionalReferenceNumberA coded reference number (X12 N9 loop).
NameData TypeDescriptionRequired
booking_responseBookingResponseThe single booking-response object.YES
NameData TypeDescriptionRequired
additional_reference_numbersArray<AdditionalReferenceNumber>Configurable additional reference numbers (X12 N9/REF loop). EDI-only; empty unless configured.
flow_execution_uuidStringThe Chain.io flow execution id. EDI-only; not present on the canonical Booking Response.
forwarder_controlling_branch_codeStringThe forwarder branch responsible for the shipment.
forwarder_controlling_company_codeStringThe forwarder company responsible for the shipment.
notesStringFree-text note on the response.
requesting_party_shipment_referenceStringThe requesting party's shipment reference (the shipment id from the originating 204 load tender).
responding_party_shipment_referenceStringThe responding (carrier) party's reference for the shipment.
response_dateDateTimeThe response timestamp, ISO 8601 UTC.
response_typeStringWhether the tender is accepted or declined. "accept" or "decline" (X12 B1 purpose).
shipper_referenceStringShipper reference number.
transmission_uidStringA unique id generated for this transmission, used for tracing and logging.
NameData TypeDescriptionRequired
codeStringThe reference qualifier (X12 N9-01), e.g. 19, TN, CN, CR.
valueStringThe reference value (X12 N9-02).

Example