Object Index
You are viewing an old version of the API
Booking
BETA
Object Index
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
|
Read only A unique ID of this object representing a booking. |
version
|
The revision number for the booking used for optimistic concurrency. |
status
|
Read only The status of the booking, describing where the booking stands with respect to the booking state machine. |
created_
|
Read only The timestamp specifying the creation time of this booking, in RFC 3339 format. 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_
|
Read only The timestamp specifying the most recent update time of this booking, in RFC 3339 format. 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_
|
The timestamp specifying the starting time of this booking, in RFC 3339 format. 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_
|
The ID of the Location object representing the location where the booked service is provided. |
customer_
|
The ID of the Customer object representing the customer attending this booking |
customer_
|
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. |
seller_
|
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. |
appointment_
|
A list of appointment segments for this booking. |