Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.25 KB

booking.md

File metadata and controls

38 lines (29 loc) · 2.25 KB
Raw

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.

Structure

Booking

Fields

Name Type Tags Description
id string Optional A unique ID of this object representing a booking.
version int Optional The revision number for the booking used for optimistic concurrency.
status str (Booking Status) Optional Supported booking statuses.
created_at string Optional The timestamp specifying the creation time of this booking, in RFC 3339 format.
updated_at string Optional The timestamp specifying the most recent update time of this booking, in RFC 3339 format.
start_at string Optional The timestamp specifying the starting time of this booking, in RFC 3339 format.
location_id string Optional The ID of the Location object representing the location where the booked service is provided.
customer_id string Optional The ID of the Customer object representing the customer attending this booking
customer_note string Optional 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.
Constraints: Maximum Length: 4096
seller_note string Optional 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.
Constraints: Maximum Length: 4096
appointment_segments List of Appointment Segment Optional A list of appointment segments for this booking.

Example (as JSON)

{
  "id": "id0",
  "version": 172,
  "status": "CANCELLED_BY_SELLER",
  "created_at": "created_at2",
  "updated_at": "updated_at4"
}