USusenash
Shifts

Get a shift

Changed on

Retrieve a single courier shift by ID, including its times, assigned courier, and store location.

get/v1/shift/{id}

Request

Path parameters

idstring required

Shift ID

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

  • e3713837c5c9Revision changes
    • info

      api operation id get_shift_v1_shift__string_id__get removed and replaced with shifts_v1_get_shift_route_shift__string_id__get

    • info

      added the optional property // to the response with the status