4aa7f4326443
Add additional stops to a shipment
shipmentReference and at least one new stop are required. Each new stop must include address, action, name, sequence, windowStart, windowEnd, and other fields dependent on the type of shipment. For US-based clients, the address must include street address, city, state, and zipcode. The action is either "pickup" or "delivery". The sequence number is sequence of the stop within the shipment. The name of the stop is the location name. windowStart is when the pickup/delivery window starts for that stop. windowEnd is when the pickup/delivery window ends for that stop. If the shipment is shorthaul, the new stop must include load data and it must be indicated whether the cargo is a full truckload or not. If the shipment is drayage, the new stop must indicate whether the container is empty or not and location must be included.
Request body
Example request
{
"shipmentReference": "ABC-123",
"newStops": [
{
"sequence": 1,
"address": "1550 Cota Ave, Long Beach, CA 90813, USA",
"action": "pickup",
"name": "Atlas Marine",
"windowStart": "2023-01-01T21:00:00.000Z",
"windowEnd": "2024-01-01T21:00:00.000Z",
"isEmptyContainer": true,
"loads": [
{
"type": "pallets"
}
]
}
]
}Response
Status Code 200: Successful Response - the request was successful!
Example response
{
"shipment": {
"market": {
"name": "San Antonio",
"code": "SAT"
},
"shipment_id": "ABC-123",
"stops": [
{
"_id": "stopID123",
"action": "deliver",
"location": [
{
"id": "1234567890z9310",
"address": "211 E. Ocean Blvd, Suite 350, Long Beach, CA 90802, USA",
"street": "211 E. Ocean Blvd",
"suite_or_apt": "Suite 350",
"zipcode": "90802",
"city": "Long Beach",
"state": "CA",
"lng": -123.456789,
"lat": 37.1234567
}
],
"status": "unstarted",
"shipment_type": "shorthaul",
"sequence": 2,
"window_start": "2023-07-24T23:30:00.000Z",
"window_end": "2023-07-24T23:30:00.000Z"
}
]
}
}