To add a shift and assign it to a restaurant employee, send a
POST
request to the
/labor/v1/shifts
endpoint of the labor API.
The response provides information about the shift, including the Toast platform GUID.
The following example curl command sends a
POST
request to the
/labor/v1/shifts
endpoint.
Example request to add a shift and assign it to an employee
curl -v -X POST \
-H "Authorization: Bearer eyJzI1NiJ9hbGciOiJSU.eyJhd9yaXR5Ij
oiQ1JVTkNIVElNRSIsInJzR3VpZCI6IjE4YzQ5YWJlLWFlODItNGFlYy04ND
M1LWJhYTRjMjVlYTY2MiIsInNjb3BlIjpbImxWQiOlsidG9hc3QiXSwibmFt
aW5nQXV0aGhYm9yIiwib3JkZXJzIiwidXNlcm1nbXQiXSwiZXhwIjoxNDg0M
zg5ODUwLCJqdGkiOiJlMDYzZjJkMy1jNGYyLTRiZjItODJmNi01MTg1NWMzZ
DAxM2YiLCJjbGllbnRfaWQiOiJjcnVuY2h0aW1lIn0.X1_0y9Hzj5F9gdOw2
o6VSYTyZwooAJiFMDmNakbZrtiUdYwLzuLwLpCMQzX5pKYtOqDUz_cetGJL3
txKL1L-K2j1Enoq8An8hEM6e8J0KdAiwrYFO3W3CmWedaoz95K9ghNZVCs28
Td2Sp3Ix3fObxbrvanocx9_OT8S9uM8hdSXmBI_ykTWvOVgK4hO24V3DJy4b
9bz1FtgOvrClhELxCe8dJy7jiwAR60xczlCF5rna98RMLN6zY4ffjmljKFZ6
QV0KkVppWjEiJn7oFHiIylCX1sSg7sddrGatj0xJzts3GJ8u8_lryUNHaEvJ
dWq4Yzwo007AMgxjH9d241Y-g" \
-H "Toast-Restaurant-External-ID: 4622e7a9-b4be-3fef-9220-b3dad273e0b4" \
-H "Content-Type: application/json" \
-d @my-shift-information.json \
"https://[toast-api-hostname]
/labor/v1/shifts"
Specify the GUID of the restaurant to add the shift to. This must be an individual restaurant, not the GUID for a restaurant group. |
|
Specify the data type of the message body in the
Content-Type header field. The value must
be |
|
Include information about the new employee in the message
body of the |
The following example shows the message body data that provides information about the shift.
Example message body for a request to add a shift
{ "employeeReference": { "entityType": "RestaurantUser", "guid": "0a7ced2c-b782-4585-8f41-4bb1656c3f67" }, "entityType": "Shift", "inDate": "2017-01-13T06:00:00.000+0000", "jobReference": { "entityType": "RestaurantJob", "guid": "a674499f-cddd-4b8b-a6b3-6d44147da330" }, "outDate": "2017-01-13T13:00:00.000+0000" }
The following example shows the response for a
POST
request to the
/labor/v1/shifts
resource.
Example response from a request to add a shift
{ "guid": "08312056-c56f-4a10-a3c2-5660bf2b5143", "entityType": "Shift", "externalId": null, "outDate": "2017-01-13T13:00:00.000+0000", "createdDate": "2016-12-29T05:33:16.712+0000", "deleted": false, "deletedDate": null, "employeeReference": { "guid": "0a7ced2c-b782-4585-8f41-4bb1656c3f67", "entityType": "RestaurantUser", "externalId": null }, "modifiedDate": "2016-12-29T05:33:16.712+0000", "inDate": "2017-01-13T06:00:00.000+0000", "jobReference": { "guid": "a674499f-cddd-4b8b-a6b3-6d44147da330", "entityType": "RestaurantJob", "externalId": null } }