Bookings
Lists all bookings.
Table Specific Information
Select
The add-in uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the add-in.
- Id supports the following operators: =, IN.
- CustomerId supports the following operator: =.
- AppointmentSegmentsTeamMemberId supports the following operator: =.
- StartAt supports the following operators: =, >=, <=, >, <.
Retrieve all the bookings:
SELECT * FROM Bookings
Retrieve a specific booking:
SELECT * FROM Bookings WHERE Id = 'zkras0xv0xwswx'
Retrieve several bookings at once by supplying their Ids with IN. The add-in sends these to the Square bulk retrieve endpoint, so the list is served by a single request rather than one request per Id. The maximum BatchSize supported by Bookings is 10, and a longer list is split across as many requests as needed. Note that = does not use this endpoint; a single-Id filter is answered by the per-booking request instead. An Id that does not match a booking is omitted from the results rather than reported as an error.
SELECT * FROM Bookings WHERE Id IN ('sc3p3m7dvctfr1', 'tdegug1dvctdef', 'tdegug1fqni3wh')
Insert
To create a Booking, you must specify LocationId, StartAt, AppointmentSegmentsTeamMemberId, AppointmentSegmentsServiceVariationId and AppointmentSegmentsServiceVariationVersion
INSERT INTO Bookings (LocationId, StartAt, AppointmentSegmentsTeamMemberId, AppointmentSegmentsServiceVariationId, AppointmentSegmentsServiceVariationVersion) VALUES ('L12345', '2026-05-14T10:00:00', 'TM67890', 'SV11223', 1)
Update
A Booking can be updated by providing its Id.
UPDATE Bookings set AppointmentSegmentsDurationMinutes = 20, AppointmentSegmentsTeamMemberId = 123 where Id = '123'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique Id of this object representing a booking. |
| LocationId | String | False |
The Id of the Location object representing the location where the booked service is provided. |
| CustomerId | String | False |
The Id of the Customer object representing the customer receiving the booked service. |
| CustomerNote | String | False |
The free-text field for the customer to supply notes about the booking. |
| SellerNote | String | False |
The free-text field for the seller to supply notes about the booking. |
| Status | String | True |
The status of the booking, describing where the booking stands with respect to the booking state machine. The allowed values are PENDING, CANCELLED_BY_CUSTOMER, CANCELLED_BY_SELLER, DECLINED, ACCEPTED, NO_SHOW. |
| AppointmentSegmentsDurationMinutes | Int32 | False |
The time span in minutes of an appointment segment for this booking. |
| AppointmentSegmentsServiceVariationId | String | False |
The Id of the CatalogItemVariation object representing the service booked in this segment. |
| AppointmentSegmentsTeamMemberId | String | False |
The Id of the TeamMember object representing the team member booked in this segment. |
| AppointmentSegmentsServiceVariationVersion | Int64 | False |
The current version of the item variation representing the service booked in this segment. |
| AppointmentSegmentsIntermissionMinutes | Int32 | True |
Time between the end of this segment and the beginning of the subsequent segment. |
| AppointmentSegmentsAnyTeamMember | Boolean | True |
Indicates whether the customer accepts any team member, instead of a specific one, to serve this segment. |
| AppointmentSegmentsResourceIds | String | True |
The Ids of the seller-accessible resources used for this appointment segment. |
| TransitionTimeMinutes | Int32 | True |
Additional time at the end of a booking. |
| AllDay | Boolean | True |
Indicates whether the booking is of a full business day. |
| LocationType | String | False |
The type of location where the booking is held. The allowed values are BUSINESS_LOCATION, CUSTOMER_LOCATION, PHONE. |
| CreatorType | String | True |
The seller-accessible type of the creator of the booking. The allowed values are TEAM_MEMBER, CUSTOMER. |
| CreatorTeamMemberId | String | True |
The Id of the team member who created the booking, when the booking creator is of the TEAM_MEMBER type. Access to this field requires seller-level permissions. |
| CreatorCustomerId | String | True |
The Id of the customer who created the booking, when the booking creator is of the CUSTOMER type. Access to this field requires seller-level permissions. |
| Version | Int32 | False |
The revision number for the booking used for optimistic concurrency. |
| CreatedAt | Datetime | True |
The RFC 3339 timestamp specifying the creation time of this booking. |
| UpdatedAt | Datetime | True |
The RFC 3339 timestamp specifying the most recent update time of this booking. |
| StartAt | Datetime | False |
The RFC 3339 timestamp specifying the starting time of this booking. |
| Source | String | True |
The source of the booking. Access to this field requires seller-level permissions. The allowed values are FIRST_PARTY_MERCHANT, FIRST_PARTY_BUYER, THIRD_PARTY_BUYER, API. |