Bookings
Lists all bookings.
Table Specific Information
Select
The driver uses the Square API to process search criteria that refer to the Id column, while other filters are processed client side within the driver.
Retrieve all the bookings.
SELECT * from Bookings
Retrieve a booking.
SELECT * from Bookings where Id = 'zkras0xv0xwswx'
Columns
Name | Type | Description |
Id [KEY] | String | A unique ID of this object representing a booking. |
LocationId | String | The ID of the Location object representing the location where the booked service is provided. |
CustomerId | String | The ID of the Customer object representing the customer receiving the booked service. |
CustomerNote | String | The free-text field for the customer to supply notes about the booking. |
SellerNote | String | The free-text field for the seller to supply notes about the booking. |
Status | String | The status of the booking, describing where the booking stands with respect to the booking state machine. |
AppointmentSegmentsDurationMinutes | Int32 | The time span in minutes of an appointment segment for this booking. |
AppointmentSegmentsServiceVariationId | String | The ID of the CatalogItemVariation object representing the service booked in this segment. |
AppointmentSegmentsTeamMemberId | String | The ID of the TeamMember object representing the team member booked in this segment. |
AppointmentSegmentsServiceVariationVersion | Int64 | The current version of the item variation representing the service booked in this segment. |
AppointmentSegmentsIntermissionMinutes | Int32 | Time between the end of this segment and the beginning of the subsequent segment. |
AppointmentSegmentsAnyTeamMember | Boolean | Whether the customer accepts any team member, instead of a specific one, to serve this segment. |
AppointmentSegmentsResourceIds | String | The IDs of the seller-accessible resources used for this appointment segment. |
TransitionTimeMinutes | Int32 | Additional time at the end of a booking. |
AllDay | Boolean | Whether the booking is of a full business day. |
LocationType | String | The type of location where the booking is held. |
CreatorType | String | The seller-accessible type of the creator of the booking. |
CreatorTeamMemberId | String | 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 | 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 | The revision number for the booking used for optimistic concurrency. |
CreatedAt | Datetime | The RFC 3339 timestamp specifying the creation time of this booking. |
UpdatedAt | Datetime | The RFC 3339 timestamp specifying the most recent update time of this booking. |
StartAt | Datetime | The RFC 3339 timestamp specifying the starting time of this booking. |
Source | String | The source of the booking. Access to this field requires seller-level permissions. |