NAnash
Shifts

Create a shift

Create a courier shift with start/end times and an assigned store location.

post/v1/shift

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Request body

idstring nullable

The ID of the shift.

namestring required

The name of the shift.

plannedStartstring required

The planned start timestamp of the shift.

plannedEndstring required

The planned end timestamp of the shift.

plannedBreakDurationinteger nullable

The planned break duration of the shift.

shiftMetadataobject nullable

The metadata of the shift.

statusstring nullable

The status of the shift.

storeLocationIdstring nullable

The store location ID of the shift.

externalStoreLocationIdstring nullable

The external store location ID of the shift.

zoneIdsstring[] nullable

The zone IDs of the shift.

externalZoneIdsstring[] nullable

The external zone IDs of the shift.

Example request

{
  "id": "sft_fKUFVWZQGbEfsyMwJYntE2",
  "name": "Shift 1",
  "plannedStart": "2021-01-01T00:00:00Z",
  "plannedEnd": "2021-01-01T00:00:00Z",
  "plannedBreakDuration": 30,
  "shiftMetadata": {
    "key": "value"
  },
  "optimizationParams": {
    "serviceTimeRelativeEfficiency": 1,
    "plannedBreaks": [
      {
        "end": 30,
        "start": 0
      }
    ],
    "departureDelay": 15,
    "shiftEndServiceTimeMinutes": 10
  },
  "status": "active",
  "storeLocationId": "123",
  "externalStoreLocationId": "123",
  "zoneIds": [
    "123"
  ],
  "externalZoneIds": [
    "123"
  ]
}

Response

OK

idstring required

The ID of the shift.

namestring required

The name of the shift.

plannedStartstring required

The planned start timestamp of the shift.

plannedEndstring required

The planned end timestamp of the shift.

plannedBreakDurationinteger nullable

The planned break duration of the shift.

shiftMetadataobject nullable

The metadata of the shift.

statusstring required

The status of the shift.

storeLocationIdstring nullable

The store location ID of the shift.

externalStoreLocationIdstring nullable

The external store location ID of the shift.

zoneIdsstring[] nullable

The zone IDs of the shift.

externalZoneIdsstring[] nullable

The external zone IDs of the shift.

courierIdstring nullable

The courier ID of the shift.

vehicleIdstring nullable

The vehicle ID of the shift.

createdAtstring required

The creation timestamp of the shift.

updatedAtstring required

The update timestamp of the shift.

Example response

{
  "optimizationParams": {
    "serviceTimeRelativeEfficiency": 1,
    "plannedBreaks": [
      {
        "end": 30,
        "start": 0
      }
    ],
    "departureDelay": 15,
    "shiftEndServiceTimeMinutes": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.