Get a list of all stop locations for shipments user is associated with

SecurityAuthToken

Request

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
company_name	string Return stop locations whose company_name is equivalent to this value
company_name__contains	string Return stop locations with this value in the company_name

Responses

200

Successfully returned a list of stop locations for shipments user is associated with

Response Schema: application/json

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

default

Default error response

get/shipments/stop-locations/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"page_size": 0,
"results": [{"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"
}
],
"total_count": 0,
"total_pages": 0
}