Get all shifts

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/shifts \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "name": "<string>",
  "plannedStart": "<string>",
  "plannedEnd": "<string>",
  "status": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "plannedBreakDuration": 123,
  "shiftMetadata": {},
  "optimizationParams": {
    "serviceTimeRelativeEfficiency": 1,
    "plannedBreaks": [
      {
        "end": 30,
        "start": 0
      }
    ],
    "departureDelay": 15,
    "vehicleConfig": {
      "key": "value"
    }
  },
  "storeLocationId": "<string>",
  "externalStoreLocationId": "<string>",
  "zoneIds": [
    "<string>"
  ],
  "externalZoneIds": [
    "<string>"
  ],
  "courierId": "<string>",
  "vehicleId": "<string>"
}

GET

shifts

Get all shifts

curl --request GET \
  --url https://api.sandbox.usenash.com/v1/shifts \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "name": "<string>",
  "plannedStart": "<string>",
  "plannedEnd": "<string>",
  "status": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "plannedBreakDuration": 123,
  "shiftMetadata": {},
  "optimizationParams": {
    "serviceTimeRelativeEfficiency": 1,
    "plannedBreaks": [
      {
        "end": 30,
        "start": 0
      }
    ],
    "departureDelay": 15,
    "vehicleConfig": {
      "key": "value"
    }
  },
  "storeLocationId": "<string>",
  "externalStoreLocationId": "<string>",
  "zoneIds": [
    "<string>"
  ],
  "externalZoneIds": [
    "<string>"
  ],
  "courierId": "<string>",
  "vehicleId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

startTime

string<date-time>

required

The start time of the shifts to list. The start time of the shifts to list.

Example:

"2025-05-01T00:00:00Z"

endTime

string<date-time>

required

The end time of the shifts to list. The end time of the shifts to list.

Example:

"2025-06-01T00:00:00Z"

storeLocationId

string | null

The store location ID to list shifts for. The store location ID to list shifts for.

externalStoreLocationId

string | null

The external store location ID to list shifts for. The external store location ID to list shifts for.

Response

Response for shift.

string

required

The ID of the shift.

name

string

required

The name of the shift.

plannedStart

string

required

The planned start timestamp of the shift.

plannedEnd

string

required

The planned end timestamp of the shift.

status

string

required

The status of the shift.

createdAt

string

required

The creation timestamp of the shift.

updatedAt

string

required

The update timestamp of the shift.

plannedBreakDuration

integer | null

The planned break duration of the shift.

shiftMetadata

Shiftmetadata · object

The metadata of the shift.

optimizationParams

OptimizationParams · object

The optimization parameters of the shift.

Show child attributes

optimizationParams.serviceTimeRelativeEfficiency

number | null

The service time relative efficiency of the shift.

Example:

1

optimizationParams.plannedBreaks

BreakConfiguration · object[] | null

The planned breaks of the shift. (in minutes)

Show child attributes

optimizationParams.plannedBreaks.breakDuration

integer

required

The break duration of the break. (in minutes)

Example:

30

optimizationParams.plannedBreaks.timeWindow

any[] | null

The time window of the break. (in minutes)

Required array length: 2 elements

Example:

[0, 30]

optimizationParams.plannedBreaks.maxWorkingTime

integer | null

The max working time of the break. (in minutes)

Example:

30

Example:

[{ "end": 30, "start": 0 }]

optimizationParams.departureDelay

integer | null

The departure delay. (in minutes)

Example:

15

optimizationParams.vehicleConfig

VehicleConfig · object

The vehicle config of the shift.

Show child attributes

optimizationParams.vehicleConfig.weight

integer | null

The weight of the vehicle.

optimizationParams.vehicleConfig.height

integer | null

The height of the vehicle.

optimizationParams.vehicleConfig.length

integer | null

The length of the vehicle.

optimizationParams.vehicleConfig.width

integer | null

The width of the vehicle.

optimizationParams.vehicleConfig.maxstops

integer | null

The max stops of the vehicle.

optimizationParams.vehicleConfig.maxdistance

integer | null

The max distance of the vehicle.

optimizationParams.vehicleConfig.maxduration

integer | null

The max duration of the vehicle.

optimizationParams.vehicleConfig.speedfactor

number | null

The speed factor of the vehicle.

Example:

{ "key": "value" }

storeLocationId

string | null

The store location ID of the shift.

externalStoreLocationId

string | null

The external store location ID of the shift.

zoneIds

string[] | null

The zone IDs of the shift.

externalZoneIds

string[] | null

The external zone IDs of the shift.

courierId

string | null

The courier ID of the shift.

vehicleId

string | null

The vehicle ID of the shift.

Create a shift Get a shift

⌘I

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations & Zones

Jobs

Batch Jobs

Providers

Routes

Shifts

Templates

Store Catalog

Miscellaneous

Get all shifts

Authorizations

Query Parameters

Response