Shifts
Create a shift
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
Create a shift
POST
/
v1
/
shift
curl --request POST \
--url https://api.sandbox.usenash.com/v1/shift \
--header 'Content-Type: application/json' \
--data '{
"name": "Shift 1",
"plannedstart": "2021-01-01T00:00:00Z",
"plannedend": "2021-01-01T00:00:00Z",
"plannedbreakduration": 30,
"shiftmetadata": {
"key": "value"
},
"status": "active",
"storelocationid": "123",
"externalstorelocationid": "123",
"zoneids": [
"123"
],
"externalzoneids": [
"123"
]
}'
{
"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>"
}
Body
application/json
Input for creating a shift.
Response
200
application/json
OK
Response for shift.
curl --request POST \
--url https://api.sandbox.usenash.com/v1/shift \
--header 'Content-Type: application/json' \
--data '{
"name": "Shift 1",
"plannedstart": "2021-01-01T00:00:00Z",
"plannedend": "2021-01-01T00:00:00Z",
"plannedbreakduration": 30,
"shiftmetadata": {
"key": "value"
},
"status": "active",
"storelocationid": "123",
"externalstorelocationid": "123",
"zoneids": [
"123"
],
"externalzoneids": [
"123"
]
}'
{
"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>"
}