As a Carrier, respond to a booking request, or update an existing response.
ACCEPT a booking by providing any identifiers applicable to the Shipment across
applicable route-segments in the form of a BookingResponse
.
All route-segments must be present in the response, even to specify there are no identifiers
known at the time of acceptance.
A Carrier may update identifiers with this call if they have already accepted a booking.
REJECT a booking by selecting a reason for rejection in the form of a BookingRejection
.
A Carrier may not PUT a Rejection to a booking after they have already accepted it.
The carrier's approval of a booking.
The carrier should supply any identifiers they have for the shipment in their response.
Array of objects (LogisticsIdentifier) Methods for identifying the shipment; usually a BOOKING_NUMBER or BOL. | |
required | Array of objects (RouteSegmentResponse) non-empty List of the accepted dates to travel the route-segments requested by the shipper. All of the route-segments requested by the shipper in the booking must be included. |
OceanBookingResponseDetails (object) or TruckloadBookingResponseDetails (object) Further response details applicable to the booking. |
Successful Response
Bad Request
Unauthorized
Not Found
{- "shipmentIdentifiers": [
- {
- "type": "BOOKING_NUMBER",
- "value": "123456789"
}, - {
- "type": "BILL_OF_LADING",
- "value": "987654321"
}, - {
- "type": "CARRIER_NAME",
- "value": "Ocean Carrier Name"
}, - {
- "type": "CARRIER_SCAC",
- "value": "CLTD"
}, - {
- "type": "VESSEL_NAME",
- "value": "Vessel Name"
}, - {
- "type": "VOYAGE_NUMBER",
- "value": "1234"
}
], - "routeSegments": [
- {
- "routeSegmentId": "5a0498bb-fb7d-4805-90c9-da6acd246a73",
- "fromDate": "2092-12-10",
- "toDate": "2092-12-12"
}
], - "details": {
- "portsDetails": [
- {
- "portType": "PORT_OF_DISCHARGE",
- "estimatedDatetime": "2092-12-10T00:00:00+00:00"
}, - {
- "portType": "PORT_OF_LOADING",
- "estimatedDatetime": "2092-12-10T00:00:00+00:00"
}
], - "estimatedFinalDestinationDatetime": "2092-12-10T00:00:00+00:00",
- "cutOffDetails": {
- "cutOffDatetime": "2092-12-01T08:30:00+00:00",
- "vesselCutOffDatetime": "2092-12-01T08:30:00+00:00",
- "documentationCutOffDatetime": "2092-12-01T08:30:00+00:00"
}
}
}
{- "shipmentId": "47efd5a2-af91-4417-950a-7f546cd1b5cf",
- "attributes": [
- {
- "name": "string",
- "value": "string",
- "values": [
- "string"
]
}
], - "capacityProviderIdentifier": {
- "type": "SCAC",
- "value": "string"
}, - "carrierContacts": [
- {
- "companyName": "string",
- "givenName": "string",
- "familyName": "string",
- "phoneNumber": "string",
- "mobilePhoneNumber": "string",
- "email": "user@example.com"
}
], - "totalRate": {
- "currency": "USD",
- "amount": 0
}, - "rateIdentifiers": [
- {
- "source": "SYSTEM",
- "type": "SPOT_QUOTE",
- "value": "string"
}
], - "expirationDateTime": "2019-08-24T14:15:22Z",
- "routeSegmentIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "notes": "string",
- "shipmentDetails": [
- {
- "pickupStopId": "eff50f2a-8964-41f9-b45d-0a4f6f94e159",
- "deliveryStopId": "2ca57692-0523-4424-a638-167e5e26f7d3",
- "handlingUnits": {
- "details": [
- {
- "monetaryValue": {
- "currency": "USD",
- "amount": 0
}, - "quantity": 0,
- "handlingUnitType": "BAG",
- "stackable": false,
- "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unit": "FT"
}, - "weight": {
- "weight": 0,
- "weightUnit": "LB"
}
}
]
}, - "items": [
- {
- "description": "string",
- "identifiers": [
- {
- "type": "CONTAINER_NUMBER",
- "value": "string"
}
], - "unitQuantity": 0,
- "unitType": "BAG"
}
], - "description": "string",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "accessorials": [
- {
- "code": "REFRIGERATED",
- "details": {
- "min": 0,
- "max": 0,
- "unit": "CELSIUS"
}
}
], - "loadId": "9fa4c9ea-0db7-4bb2-8f50-086d18a90403"
}
], - "apiConfiguration": {
- "bookingWebhookName": "string"
}, - "shipperContactInfo": {
- "companyName": "string",
- "givenName": "string",
- "familyName": "string",
- "phoneNumber": "string",
- "mobilePhoneNumber": "string",
- "email": "user@example.com"
}, - "shippingDetails": {
- "multipleDrivers": true,
- "truckDetails": {
- "truckDimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unitOfMeasure": "IN"
}, - "weight": 0,
- "weightUnitOfMeasure": "LB",
- "truckType": "AUTO_CARRIER"
}, - "hazmatDetails": {
- "hazardClasses": [
- "string"
]
}
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "status": "PROCESSING",
- "shipmentIdentifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "routeSegments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "fromStop": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "PICKUP",
- "arrivalDate": "2019-08-24",
- "arrivalAppointmentWindow": {
- "startTime": "14:15:22Z",
- "endTime": "14:15:22Z"
}, - "contacts": [
- {
- "companyName": "string",
- "givenName": "string",
- "familyName": "string",
- "phoneNumber": "string",
- "mobilePhoneNumber": "string",
- "email": "user@example.com"
}
], - "accessorials": [
- {
- "code": "REFRIGERATED",
- "details": {
- "min": 0,
- "max": 0,
- "unit": "CELSIUS"
}
}
], - "location": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- {
- "type": "EXTERNAL",
- "value": "string"
}
], - "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}
}
}, - "toStop": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "PICKUP",
- "arrivalDate": "2019-08-24",
- "arrivalAppointmentWindow": {
- "startTime": "14:15:22Z",
- "endTime": "14:15:22Z"
}, - "contacts": [
- {
- "companyName": "string",
- "givenName": "string",
- "familyName": "string",
- "phoneNumber": "string",
- "mobilePhoneNumber": "string",
- "email": "user@example.com"
}
], - "accessorials": [
- {
- "code": "REFRIGERATED",
- "details": {
- "min": 0,
- "max": 0,
- "unit": "CELSIUS"
}
}
], - "location": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- {
- "type": "EXTERNAL",
- "value": "string"
}
], - "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}
}
}
}
], - "rejectionReason": "COST_NOT_AGREED",
- "carrierResponseMethod": "EMAIL",
- "automatedFailureReason": "ERROR_CREDENTIALS",
- "bookingSourceMethod": "API",
- "carrierRejectionNotes": "string",
- "transportationMode": "OCEAN",
- "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
- "carrierProvidedIdentifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "createdDateTime": "2019-08-24T14:15:22Z",
- "lastModifiedDateTime": "2019-08-24T14:15:22Z"
}