<- Object

Object

All versions ->

ScheduledShiftBeta

Represents a specific time slot in a work schedule.

This object is used to manage the lifecycle of a scheduled shift from the draft to published state. A scheduled shift contains the latest draft shift details and current published shift details.

Link to section

Properties

Link to section

id

string

Read only The Square-issued ID of the scheduled shift.

Max Length
255
Link to section

draft_shift_details

The latest draft shift details for the scheduled shift. Draft shift details are used to stage and manage shifts before publishing. This field is always present.

Link to section

published_shift_details

Read only The current published (public) shift details for the scheduled shift. This field is present only if the shift was published.

Link to section

version

integer(32-bit)

Read only The current version of the scheduled shift, which is incremented with each update. This field is used for optimistic concurrency control to ensure that requests don't overwrite data from another request.

Link to section

created_at

string

Read only The timestamp of when the scheduled shift was created, in RFC 3339 format presented as UTC.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

updated_at

string

Read only The timestamp of when the scheduled shift was last updated, in RFC 3339 format presented as UTC.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00