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

Object Index

You are viewing an old version of the API
Booking

Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location to a requesting customer in one or more appointment segments.

Properties

Name Description
id
string

Read only A unique ID of this object representing a booking.

Max Length 36
version
integer (32-bit)

The revision number for the booking used for optimistic concurrency.

status
string

Read only The status of the booking, describing where the booking stands with respect to the booking state machine.

created_at
string

Read only The RFC 3339 timestamp specifying the creation time of this booking.

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 The RFC 3339 timestamp specifying the most recent update time of this booking.

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

start_at
string

The RFC 3339 timestamp specifying the starting time of this booking.

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

location_id
string

The ID of the Location object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.

Max Length 32
customer_id
string

The ID of the Customer object representing the customer receiving the booked service.

Max Length 192
customer_note
string

The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant CatalogObject instance.

Max Length 4096
seller_note
string

The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific CatalogObject instance. This field should not be visible to customers.

Max Length 4096
appointment_segments
AppointmentSegment [ ]

A list of appointment segments for this booking.

transition_time_minutes
integer (32-bit)

Read only Additional time at the end of a booking. Applications should not make this field visible to customers of a seller.

all_day
boolean

Read only Whether the booking is of a full business day.

location_type
string

The type of location where the booking is held. Access to this field requires seller-level permissions.

creator_details
BookingCreatorDetails

Read only Information about the booking creator.

source
string

Read only The source of the booking. Access to this field requires seller-level permissions.