Get a list of Stops for a given Shipment

SecurityAuthToken

Request

path Parameters

shipmentId

required

string <uuid>

The id of the shipment

query Parameters

page	integer indicates what page of a list of query results you want to view
page-size	integer indicates the how many items to return per page in a list request
ordering	string determines which column to sort by. Prepend with '-' to sort desc

header Parameters

X-Company-Id

string

allows request to retrieve information about the company given in the header instead of the company associated with the requesting user

Responses

200

Successfully returned a list of Stops

Response Schema: application/json

page_size	integer
	Array of objects (Stop)
total_count	integer
total_pages	integer

default

Default error response

get/shipments/{shipmentId}/stops/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"page_size": 0,
"results": [{"accessorials": [{"code": "string",
"currency_unit": "string",
"description": "string",
"id": 0,
"is_charge_code": true,
"long_description": "string",
"price": 0.1,
"type": "string"
}
],
"alerts": [{"alert_type": "AT_RISK",
"created_at": "2019-08-24T14:15:22Z",
"created_by_driver": "4b7764ea-906e-4a4e-9227-7c0083c9979c",
"created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59",
"description": "string",
"expiration": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"location": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"occurred_at": "2019-08-24T14:15:22Z",
"reason_code": "ACCIDENT",
"stop": "0bfa2243-0f07-4994-a5a2-d14bef007f26",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"appointment_needed": true,
"appointment_type": {"code": "string",
"id": 0,
"name": "string"
},
"appointment_window": {"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"carrier_specified_eta": {"created_at": "2019-08-24T14:15:22Z",
"initial_window_end": "2019-08-24T14:15:22Z",
"initial_window_start": "2019-08-24T14:15:22Z",
"running_window_end": "2019-08-24T14:15:22Z",
"running_window_start": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"confirmed_arrival_at": "2019-08-24T14:15:22Z",
"confirmed_departure_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"display_eta_window": "string",
"display_planned_window": "string",
"display_schedule": "string",
"eta_overridden_by": "42d07ec7-3b78-426f-8b1b-ad95f5bf150e",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instructions": "string",
"internal_notes": "string",
"is_completed": true,
"is_dropoff": true,
"is_pickup": true,
"location": {"address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"company_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_using_address_book_entry_id": "string",
"dock_external_id": "string",
"facility_id": "string",
"facility_name": "string",
"friday_close_time": "14:15:22Z",
"friday_open_time": "14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identification_code": "string",
"location_name": "string",
"location_type": {"id": 0,
"name": "string"
},
"monday_close_time": "14:15:22Z",
"monday_open_time": "14:15:22Z",
"notes": "string",
"open_friday": true,
"open_monday": true,
"open_saturday": true,
"open_sunday": true,
"open_thursday": true,
"open_tuesday": true,
"open_wednesday": true,
"point_of_contacts": [{"email": "string",
"first_name": "string",
"job_title": "string",
"last_name": "string",
"phone_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"load_board_enabled": true,
"load_board_invite_last_sent_at": "2019-08-24T14:15:22Z",
"preferences": {"cancellation": true,
"delayed": true,
"delivered": true,
"eta_changed": true,
"picked_up": true,
"receive_bol_on_shipment_booked": true,
"shipment_booked": true,
"trailer_assigned": true
},
"user": "76f62a58-5404-486d-9afc-07bded328704"
}
],
"saturday_close_time": "14:15:22Z",
"saturday_open_time": "14:15:22Z",
"sunday_close_time": "14:15:22Z",
"sunday_open_time": "14:15:22Z",
"thursday_close_time": "14:15:22Z",
"thursday_open_time": "14:15:22Z",
"tuesday_close_time": "14:15:22Z",
"tuesday_open_time": "14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"wednesday_close_time": "14:15:22Z",
"wednesday_open_time": "14:15:22Z"
},
"ordinal_index": 0,
"planned_date": "string",
"planned_time_window_end": "14:15:22Z",
"planned_time_window_start": "14:15:22Z",
"planning_window": {"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"predictive_model_eta": {"created_at": "2019-08-24T14:15:22Z",
"initial_window_end": "2019-08-24T14:15:22Z",
"initial_window_start": "2019-08-24T14:15:22Z",
"running_window_end": "2019-08-24T14:15:22Z",
"running_window_start": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"sequence_number": 0,
"status": "AT_STOP",
"status_reason_code": "ACCIDENT",
"trip_management_eta": "2019-08-24T14:15:22Z",
"trip_management_eta_last_updated": "2019-08-24T14:15:22Z",
"unconfirmed_arrival_at": "2019-08-24T14:15:22Z",
"unconfirmed_departure_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_count": 0,
"total_pages": 0
}