As a shipper, create a shipment for booking.
Success
Bad Request
Unauthorized
One may create a parent shipment definition without any bookings if they would like to return later and add them on.
{- "identifiers": [
- {
- "type": "CUSTOMER_REFERENCE",
- "value": "SHIPMENT-12345"
}
], - "routeInfo": {
- "stops": [
- {
- "id": "e379cef8-5af6-47e3-9c8f-052faa2c5061",
- "type": "PICKUP",
- "arrivalDate": "2092-12-10",
- "location": {
- "address": {
- "addressLines": [
- "222 W. Merchandise Mart Plaza",
- "Suite 1744"
], - "postalCode": "60654",
- "city": "Chicago",
- "state": "IL",
- "country": "US"
}
}
}, - {
- "id": "b996b45d-94cb-42ac-aa6f-cd8c7cfe7a5b",
- "type": "DELIVERY",
- "arrivalDate": "2092-12-12",
- "location": {
- "address": {
- "addressLines": [
- "3800 N Lamar Blvd",
- "Suite 210"
], - "postalCode": "78756",
- "city": "Austin",
- "state": "TX",
- "country": "US"
}
}
}
], - "routeSegments": [
- {
- "fromStopId": "e379cef8-5af6-47e3-9c8f-052faa2c5061",
- "toStopId": "e379cef8-5af6-47e3-9c8f-052faa2c5061"
}
]
}, - "attributes": [
- {
- "name": "attribute name",
- "values": [
- "string value 1",
- "string value 2"
]
}
]
}
{- "identifiers": [
- {
- "type": "CUSTOMER_REFERENCE",
- "value": "SHIPMENT-12345"
}
], - "routeInfo": {
- "stops": [
- {
- "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
- "type": "PICKUP",
- "arrivalDate": "2092-12-10",
- "arrivalAppointmentWindow": {
- "startTime": "10:15:00",
- "endTime": "12:45:00"
}, - "contacts": [ ],
- "accessorials": [ ],
- "location": {
- "identifiers": [ ],
- "address": {
- "addressLines": [
- "222 W. Merchandise Mart Plaza",
- "Suite 1744"
], - "postalCode": "60654",
- "city": "Chicago",
- "state": "IL",
- "country": "US"
}
}
}, - {
- "id": "9f4894b9-ea9c-4705-be80-5f8e454ee273",
- "type": "DELIVERY",
- "arrivalDate": "2092-12-12",
- "arrivalAppointmentWindow": {
- "startTime": "15:15:00",
- "endTime": "17:00:00"
}, - "contacts": [ ],
- "accessorials": [ ],
- "location": {
- "identifiers": [ ],
- "address": {
- "addressLines": [
- "3800 N Lamar Blvd",
- "Suite 210"
], - "postalCode": "78756",
- "city": "Austin",
- "state": "TX",
- "country": "US"
}
}
}
], - "routeSegments": [
- {
- "id": "57a01ada-d3a5-4072-a9b9-8f2c961371b0",
- "fromStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4",
- "toStopId": "58000a28-3064-404d-9ec5-695ccd5d06d4"
}
]
}, - "attributes": [
- {
- "name": "attribute name",
- "values": [
- "string value 1",
- "string value 2"
]
}
], - "name": "shipmentName",
- "notes": "shipmentNotes",
- "bookings": [
- {
- "shipmentId": "d1b4c593-7b6a-49d2-8c8e-12c914c20016",
- "attributes": [
- {
- "name": "attribute name",
- "values": [
- "string value 1",
- "string value 2"
]
}
], - "capacityProviderIdentifier": {
- "type": "DOT_NUMBER",
- "value": "01234567"
}, - "carrierContacts": [
- {
- "companyName": "Carrier Company Name",
- "givenName": "John",
- "familyName": "Hudson",
- "phoneNumber": "1223334445",
- "mobilePhoneNumber": "1223334444",
- "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": [
- "57a01ada-d3a5-4072-a9b9-8f2c961371b0"
], - "notes": "Hello carrier! This is a note from the shipper, visible to you.",
- "shipmentDetails": [
- {
- "pickupStopId": "b464a6c0-5826-46dd-9652-8c4c15f639f0",
- "deliveryStopId": "b464a6c0-5826-46dd-9652-8c4c15f639f0",
- "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"
}
}
]
}, - "items": [
- {
- "description": "Chicken meat",
- "identifiers": [
- {
- "type": "SALES_ORDER",
- "value": "SO-1a2b3c"
}
], - "unitQuantity": 12,
- "unitType": "BOX"
}
], - "description": "Temperature-Sensitive Goods",
- "identifiers": [
- {
- "type": "PURCHASE_ORDER",
- "value": "1234"
}
], - "accessorials": [
- {
- "code": "REFRIGERATED",
- "details": {
- "min": 32,
- "max": 40,
- "unit": "FAHRENHEIT"
}
}
], - "loadId": "03968e4f-22fe-43ff-b76f-e77220456201"
}
], - "apiConfiguration": {
- "bookingWebhookName": "Shipper WebhookName"
}, - "shipperContactInfo": {
- "companyName": "Shipper Company Name",
- "givenName": "Jennifer",
- "familyName": "Smith",
- "phoneNumber": "1223334445",
- "mobilePhoneNumber": "1223334444",
- "email": "j.smith@shipper-company.project44.com"
}, - "shippingDetails": {
- "loadPreference": "FULL",
- "trailerType": "REFRIGERATED",
- "trailerLength": {
- "value": 52,
- "unit": "FT"
}, - "trailerVolume": {
- "value": 2548,
- "unit": "CUBIC_FT"
}, - "accessorials": [
- {
- "code": "REFRIGERATED",
- "details": {
- "min": 4,
- "max": 10,
- "unit": "CELSIUS"
}
}
]
}, - "id": "81b0523b-bcf6-421d-9da0-ebef5ad6de3b",
- "status": "BOOKED",
- "shipmentIdentifiers": [
- {
- "type": "CUSTOMER_REFERENCE",
- "value": "SHIPMENT-12345"
}
], - "routeSegments": [
- {
- "id": "57a01ada-d3a5-4072-a9b9-8f2c961371b0",
- "fromStop": {
- "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
- "type": "PICKUP",
- "arrivalDate": "2092-12-10",
- "arrivalAppointmentWindow": {
- "startTime": "10:15:00",
- "endTime": "12:45:00"
}, - "contacts": [ ],
- "accessorials": [ ],
- "location": {
- "identifiers": [ ],
- "address": {
- "addressLines": [
- "222 W. Merchandise Mart Plaza",
- "Suite 1744"
], - "postalCode": "60654",
- "city": "Chicago",
- "state": "IL",
- "country": "US"
}
}
}, - "toStop": {
- "id": "58000a28-3064-404d-9ec5-695ccd5d06d4",
- "type": "PICKUP",
- "arrivalDate": "2092-12-10",
- "arrivalAppointmentWindow": {
- "startTime": "10:15:00",
- "endTime": "12:45:00"
}, - "contacts": [ ],
- "accessorials": [ ],
- "location": {
- "identifiers": [ ],
- "address": {
- "addressLines": [
- "222 W. Merchandise Mart Plaza",
- "Suite 1744"
], - "postalCode": "60654",
- "city": "Chicago",
- "state": "IL",
- "country": "US"
}
}
}
}
], - "carrierResponseMethod": "EMAIL",
- "bookingSourceMethod": "API",
- "transportationMode": "TRUCKLOAD",
- "masterShipmentId": "30fd2695-a419-4ecc-b18a-52a2e06bcaf5",
- "carrierProvidedIdentifiers": [
- {
- "type": "BOOKING_NUMBER",
- "value": "BN-1223334444"
}, - {
- "type": "DRIVER_MOBILE_PHONE_NUMBER",
- "value": "5556667777"
}
], - "createdDateTime": "2024-03-25T10:39:05",
- "lastModifiedDateTime": "2024-03-25T10:39:05"
}
], - "id": "d1b4c593-7b6a-49d2-8c8e-12c914c20016",
- "createdDateTime": "2024-03-25T10:39:05",
- "lastModifiedDateTime": "2024-03-25T10:39:05"
}