booking.md

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	Getter	Setter
id	?string	Optional	A unique ID of this object representing a booking. Constraints: Maximum Length: 36	getId(): ?string	setId(?string id): void
version	?int	Optional	The revision number for the booking used for optimistic concurrency.	getVersion(): ?int	setVersion(?int version): void
status	?string(BookingStatus)	Optional	Supported booking statuses.	getStatus(): ?string	setStatus(?string status): void
createdAt	?string	Optional	The RFC 3339 timestamp specifying the creation time of this booking.	getCreatedAt(): ?string	setCreatedAt(?string createdAt): void
updatedAt	?string	Optional	The RFC 3339 timestamp specifying the most recent update time of this booking.	getUpdatedAt(): ?string	setUpdatedAt(?string updatedAt): void
startAt	?string	Optional	The RFC 3339 timestamp specifying the starting time of this booking.	getStartAt(): ?string	setStartAt(?string startAt): void
locationId	?string	Optional	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. Constraints: Maximum Length: 32	getLocationId(): ?string	setLocationId(?string locationId): void
customerId	?string	Optional	The ID of the Customer object representing the customer receiving the booked service. Constraints: Maximum Length: 192	getCustomerId(): ?string	setCustomerId(?string customerId): void
customerNote	?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	getCustomerNote(): ?string	setCustomerNote(?string customerNote): void
sellerNote	?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	getSellerNote(): ?string	setSellerNote(?string sellerNote): void
appointmentSegments	?(AppointmentSegment[])	Optional	A list of appointment segments for this booking.	getAppointmentSegments(): ?array	setAppointmentSegments(?array appointmentSegments): void
transitionTimeMinutes	?int	Optional	Additional time at the end of a booking. Applications should not make this field visible to customers of a seller.	getTransitionTimeMinutes(): ?int	setTransitionTimeMinutes(?int transitionTimeMinutes): void
allDay	?bool	Optional	Whether the booking is of a full business day.	getAllDay(): ?bool	setAllDay(?bool allDay): void
locationType	?string(BusinessAppointmentSettingsBookingLocationType)	Optional	Supported types of location where service is provided.	getLocationType(): ?string	setLocationType(?string locationType): void
creatorDetails	?BookingCreatorDetails	Optional	Information about a booking creator.	getCreatorDetails(): ?BookingCreatorDetails	setCreatorDetails(?BookingCreatorDetails creatorDetails): void
source	?string(BookingBookingSource)	Optional	Supported sources a booking was created from.	getSource(): ?string	setSource(?string source): void
address	?Address	Optional	Represents a postal address in a country. For more information, see Working with Addresses.	getAddress(): ?Address	setAddress(?Address address): void

Example (as JSON)

{
  "id": "id4",
  "version": 92,
  "status": "PENDING",
  "created_at": "created_at2",
  "updated_at": "updated_at0"
}