Labor
UpdateShift
Updates an existing Shift.
When adding a Break to a Shift, any earlier Break instances in the Shift have the end_at property set to a valid RFC-3339 datetime string.
When closing a Shift, all Break instances in the Shift must be complete with end_at set on each Break.
put/v2/labor/shifts/{id}
Path parameters
idstring required
The ID of the object being updated.
Request body
Example request
{
"shift": {
"breaks": [
{
"break_type_id": "REGS1EQR1TPZ5",
"end_at": "2019-01-25T06:16:00-05:00",
"expected_duration": "PT5M",
"id": "X7GAQYVVRRG6P",
"is_paid": true,
"name": "Tea Break",
"start_at": "2019-01-25T06:11:00-05:00"
}
],
"declared_cash_tip_money": {
"amount": 500,
"currency": "USD"
},
"end_at": "2019-01-25T13:11:00-05:00",
"location_id": "PAA1RJZZKXBFG",
"start_at": "2019-01-25T03:11:00-05:00",
"team_member_id": "ormj0jJJZ5OZIzxrZYJI",
"version": 1,
"wage": {
"hourly_rate": {
"amount": 1500,
"currency": "USD"
},
"tip_eligible": true,
"title": "Bartender"
}
}
}Response
Success
Example response
{
"shift": {
"breaks": [
{
"break_type_id": "REGS1EQR1TPZ5",
"end_at": "2019-01-25T06:16:00-05:00",
"expected_duration": "PT5M",
"id": "X7GAQYVVRRG6P",
"is_paid": true,
"name": "Tea Break",
"start_at": "2019-01-25T06:11:00-05:00"
}
],
"created_at": "2019-02-28T00:39:02Z",
"declared_cash_tip_money": {
"amount": 500,
"currency": "USD"
},
"employee_id": "ormj0jJJZ5OZIzxrZYJI",
"end_at": "2019-01-25T13:11:00-05:00",
"id": "K0YH4CV5462JB",
"location_id": "PAA1RJZZKXBFG",
"start_at": "2019-01-25T03:11:00-05:00",
"status": "CLOSED",
"team_member_id": "ormj0jJJZ5OZIzxrZYJI",
"timezone": "America/New_York",
"updated_at": "2019-02-28T00:42:41Z",
"version": 2,
"wage": {
"hourly_rate": {
"amount": 1500,
"currency": "USD"
},
"job_id": "dZtrPh5GSDGugyXGByesVp51",
"tip_eligible": true,
"title": "Bartender"
}
}
}