As a shipper, create a booking request for an existing shipment to send to a Carrier.
Successful Response
Bad Request
Unauthorized
Not Found
{- "attributes": [
- {
- "name": "attribute name",
- "values": [
- "string value 1",
- "string value 2"
]
}
], - "capacityProviderIdentifier": {
- "type": "CARRIER_SCAC",
- "value": "CODE"
}, - "carrierContacts": [
- {
- "companyName": "Carrier Company Name",
- "givenName": "John",
- "familyName": "Hudson",
- "email": "j.hudson@carrier-company.project44.com"
}
], - "totalRate": {
- "currency": "USD",
- "amount": 3500
}, - "rateIdentifiers": [
- {
- "source": "EXTERNAL",
- "type": "CONTRACT",
- "value": "contract-1234"
}
], - "expirationDateTime": "2092-12-01T08:30:00+00:00",
- "routeSegmentIds": [
- "3101428c-705c-4ec0-967b-7975bd1d3edc"
], - "shipmentDetails": [
- {
- "pickupStopId": "1f7c4d02-919e-4d75-a2cf-7641ee271d58",
- "deliveryStopId": "5e5eed3f-ab19-4e59-931d-3768c0d2d9b8",
- "handlingUnits": {
- "details": [
- {
- "monetaryValue": {
- "currency": "USD",
- "amount": 1200
}, - "quantity": 10,
- "handlingUnitType": "PALLET",
- "stackable": true,
- "dimensions": {
- "length": 48,
- "width": 40,
- "height": 40,
- "unit": "IN"
}, - "weight": {
- "value": 2750,
- "unit": "LB"
}
}
]
}, - "description": "Temperature-Sensitive Goods",
- "identifiers": [
- {
- "type": "PURCHASE_ORDER",
- "value": "1234"
}
], - "accessorials": [
- {
- "code": "REFRIGERATED",
- "details": {
- "min": 32,
- "max": 40,
- "unit": "FAHRENHEIT"
}
}
]
}
], - "apiConfiguration": {
- "bookingWebhookName": "Shipper WebhookName"
}, - "shipperContactInfo": {
- "companyName": "Shipper Company Name",
- "givenName": "Jennifer",
- "familyName": "Smith",
- "email": "j.smith@shipper-company.project44.com"
}, - "shippingDetails": {
- "parties": [
- {
- "partyType": "SHIPPER",
- "contactInfo": {
- "companyName": "Shipper Company Name",
- "givenName": "Jennifer",
- "familyName": "Smith",
- "email": "j.smith@shipper-company.project44.com"
}, - "addressInfo": {
- "addressLines": [
- "400 Montgomery St",
- "2nd Floor"
], - "postalCode": "94104",
- "city": "San Francisco",
- "state": "CA",
- "country": "US"
}
}, - {
- "partyType": "NOTIFY_PARTY",
- "contactInfo": {
- "companyName": "Notify Party Company Name",
- "givenName": "Henry",
- "familyName": "Jacobsen",
- "email": "h.jacobsen@notify-company.project44.com"
}, - "addressInfo": {
- "addressLines": [
- "222 W. Merchandise Mart Plaza",
- "Suite 1744"
], - "postalCode": "60654",
- "city": "Chicago",
- "state": "IL",
- "country": "US"
}
}
], - "serviceType": "DOOR_TO_DOOR",
- "bookingType": "FULL_CONTAINER_LOAD",
- "incoterm": "DAP",
- "containerCount": {
- "reeferCount": {
- "fortyFootContainerCount": 1
}
}, - "accessorials": [
- {
- "code": "REFRIGERATED",
- "details": {
- "min": 32,
- "max": 40,
- "unit": "FAHRENHEIT"
}
}
]
}
}
{- "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"
}