Skip to main content

Reports

Finished shifts#

List finished shifts.

See: Filtering

Response

Response body:

AttributeTypeDescriptionNullable
idIntegerA unique identifier of the shiftfalse
user_idIntegerID of the user who worked the shiftfalse
user_loginStringUsername of the user who worked the shiftfalse
user_org_levelStringA level of the user who worked the shift. Possible values are COMPANY, DIVISION, REGION, SHOPfalse
user_positionStringA position of the user who worked the shifttrue
user_display_nameStringName of the user who worked the shift. Returns Given name + Surname, or login.false
division_idIntegerID of the division of the store where the shift took place.false
division_nameStringName of the division of the store where the shift took place.false
region_idIntID of the region of the store where the shift took place.false
region_nameStringName of the region of the store where the shift took place.false
shop_idStringID of the store where the shift took place.false
shop_sapStringNumber of the store where the shift took place.false
shop_localityStringName of the store where the shift took place.true
shop_addressStringAddress of the store where the shift took place.true
start_timeLocalDateTimeDate and time of the start of the shift in UTC.false
start_time_offsetIntegerUTC offset of the timezone where the user was at the start of the shift. (in minutes)false
finish_timeLocalDateTimeDate and time of the end of the shift in UTC.false
finish_time_offsetIntegerUTC offset of the timezone where the user was at the start of the shift. (in minutes)false
durationIntegerDuration of the shift in seconds.false
commentStringA comment of the user who worked the shift.true
start_location_latFloatThe latitude the user was at at the start of the shifttrue
start_location_lonFloatThe longitude the user was at at the start of the shifttrue
start_location_distanceIntegerThe distance between the user who worked the shift and the store at the start of the shift.true
start_location_matchBooleanA flag that indicates the distance between the store and the start of shift coordinates does not exceed the permissible valuetrue
finish_location_latStringThe latitude of the user at at the end of the shifttrue
finish_location_lonStringThe longitude of the user at the end of the shifttrue
finish_location_distanceStringThe distance between the user who worked the shift and the store at the end of the shift.true
finish_location_matchStringA flag that indicates the distance between the store and the end of shift coordinates does not exceed the permissible valuetrue
auto_finishedStringA flag that indicates the shift was completed automatically.false

Examples

curl https://api.qvalon.com/v1/connector/rpc/wfm_timers \
--header 'Authorization: Bearer <your_token>'
200 OK
[
{
"id": 10214,
"user_id": 1606,
"user_login": "samplemail@example.com",
"user_org_level": "SHOP",
"user_position": "Cashier",
"user_display_name": "John Doe",
"division_id": 28,
"division_name": "USA",
"region_id": 85,
"region_name": "California",
"shop_id": 665,
"shop_sap": "LA 03",
"shop_locality": "Los-Angeles 03",
"shop_address": "1110 S Long Beach Blvd, Compton, CA 90221, USA",
"start_time": "2022-08-01T16:00:00",
"start_time_offset": -420,
"finish_time": "2022-08-02T01:00:00",
"finish_time_offset": -420,
"duration": 25200,
"comment": null,
"start_location_lat": 33.8858461,
"start_location_lon": -118.2079284,
"start_location_distance": 350,
"start_location_match": true,
"finish_location_lat": 33.8858461,
"finish_location_lon": -118.2079284,
"finish_location_distance": 350,
"finish_location_match": true,
"auto_finished": false
}
]