<- Object

Object

All versions ->

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.

Link to section

Properties

Link to section

string

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

Max Length

Link to section

version

integer(32-bit)

The revision number for the booking used for optimistic concurrency.

Link to section

status

string

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

Link to section

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

Link to section

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

Link to section

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

Link to section

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

Link to section

customer_id

string

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

Max Length

192

Link to section

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

Link to section

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

Link to section

appointment_segments

A list of appointment segments for this booking.

Link to section

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.

Link to section

all_day

boolean

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

Link to section

location_type

string

The type of location where the booking is held.

Link to section

creator_details

Read only Information about the booking creator.

Link to section

source

string

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

Link to section

address

Stores a customer address if the location type is CUSTOMER_LOCATION.