API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- Order Requirements
- POSTCreate Order
- POSTCreate Orders
- POSTCreate or update order by external identifier
- PATCHUpdate order
- GETGet order
- POSTCreate Quote
- GETGet Order Documents
- POSTSelect Quote
- POSTRefresh order quotes
- POSTAutodispatch Order
- POSTAdd Custom Event to Order
- DELArchive order
- PATCHUnarchive order
- Bulk Order Actions
- Delivery Windows & Capacity
Dispatch Strategies
Notifications
Store Locations & Zones
- POSTCreate store location
- PATCHUpdate Store Location
- GETGet Store Location
- GETGet Store Locations
- GETGet store location by external identifier
- DELDelete store location
- GETGet store locations that cover specified location (latitude & longitude, city_zipcode)
- POSTCreate a zone
- PATCHUpdate a zone
- DELDelete a zone
- GETGet zone
- GETGet zones
- GETGet zone by external identifier
- GETGet zones that cover specified location (latitude & longitude, city_zipcode)
Jobs
- Background
- POSTCreate Job
- POSTCreate or Update Job by External Identifier
- PATCHUpdate Job
- GETGet Job
- GETGet Job by External Identifier
- POSTSelect Quote
- POSTReassign a Task
- POSTRefresh Quotes
- POSTAutodispatch Job
- POSTAutodispatch Job by External Identifier
- POSTCancel Job
- POSTCancel Job by External Identifier
- POSTCreate Delivery Incident
- GETGet Refund Requests
- GETGet Refund Request
Batch Jobs
Providers
Routes
Templates
Miscellaneous
Shifts
Get all shifts
GET
/
v1
/
shifts
curl --request GET \
--url https://api.sandbox.usenash.com/v1/shifts
{
"id": "<string>",
"name": "<string>",
"plannedStart": "<string>",
"plannedEnd": "<string>",
"plannedBreakDuration": 123,
"shiftMetadata": {},
"status": "<string>",
"storeLocationId": "<string>",
"externalStoreLocationId": "<string>",
"zoneIds": [
"<string>"
],
"externalZoneIds": [
"<string>"
],
"courierId": "<string>",
"vehicleId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
Query Parameters
The start time of the shifts to list.
Example:
"2025-05-01T00:00:00Z"
The end time of the shifts to list.
Example:
"2025-06-01T00:00:00Z"
The store location ID to list shifts for.
The external store location ID to list shifts for.
Response
200
application/json
OK
Response for shift.
curl --request GET \
--url https://api.sandbox.usenash.com/v1/shifts
{
"id": "<string>",
"name": "<string>",
"plannedStart": "<string>",
"plannedEnd": "<string>",
"plannedBreakDuration": 123,
"shiftMetadata": {},
"status": "<string>",
"storeLocationId": "<string>",
"externalStoreLocationId": "<string>",
"zoneIds": [
"<string>"
],
"externalZoneIds": [
"<string>"
],
"courierId": "<string>",
"vehicleId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.