• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Shift

A record of the hourly rate, start, and end times for a single work shift for an employee.

This might include a record of the start and end times for breaks taken during the shift.

Properties

Name Description
id
string

The UUID for this object.

Max Length 255
employee_id
string

Deprecated

The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use team_member_id instead.

location_id
string

The ID of the location this shift occurred at. The location should be based on where the employee clocked in.

timezone
string

The read-only convenience value that is calculated from the location based on the location_id. Format: the IANA timezone database identifier for the location timezone.

start_at
string

Required

RFC 3339; shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated.

Min Length 1
end_at
string

RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.

wage
ShiftWage

Job and pay related information. If the wage is not set on create, it defaults to a wage of zero. If the title is not set on create, it defaults to the name of the role the employee is assigned to, if any.

breaks
Break [ ]

A list of all the paid or unpaid breaks that were taken during this shift.

status
string

Describes the working state of the current Shift.

version
integer (32-bit)

Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write; potentially overwriting data from another write.

created_at
string

Read only A read-only timestamp in RFC 3339 format; presented in 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

updated_at
string

Read only A read-only timestamp in RFC 3339 format; presented in 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

team_member_id
string

The ID of the team member this shift belongs to. Replaced employee_id at version "2020-08-26".

Share feedback

Thanks for visiting the Square API documentation. What's on your mind?