Resource: Booking
A booking for an inventory slot
JSON representation |
---|
{ "name": string, "merchantId": string, "serviceId": string, "startTime": string, "duration": string, "clientInformation": { object ( |
Fields | |
---|---|
name |
Resource name of the booking: |
merchantId |
ID of the merchant for the slot |
serviceId |
ID of the merchant service |
startTime |
Start time of the appointment slot A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
duration |
Duration of the appointment slot A duration in seconds with up to nine fractional digits, ending with ' |
clientInformation |
Personal information of the client making the appointment |
status |
Status of the booking |
paymentInformation |
Information about payment transactions that relate to the booking. |
partySize |
Party size of the booking |
ClientInformation
Personal information about the person making a booking
JSON representation |
---|
{
"givenName": string,
"familyName": string,
"address": {
object ( |
Fields | |
---|---|
givenName |
Given name of the client |
familyName |
Family name of the client |
address |
Address of the client |
telephone |
Phone number of the client |
email |
Email address of the client |
BookingStatus
Status of a booking
Enums | |
---|---|
BOOKING_STATUS_UNSPECIFIED |
Not specified. |
CONFIRMED |
Booking has been confirmed |
PENDING_MERCHANT_CONFIRMATION |
Booking is awaiting confirmation by the merchant before it can transition into CONFIRMED status (this is NOT currently supported) |
PENDING_CLIENT_CONFIRMATION |
Booking is awaiting confirmation by the client before it can transition into CONFIRMED status (this is NOT currently supported) |
CANCELED |
Booking has been canceled on behalf of the user. |
NO_SHOW |
Client did not show for the appointment |
NO_SHOW_PENALIZED |
Client did not show for the appointment in violation of the cancellation policy. |
FAILED |
Booking could not be completed due to a processing failure. |
DECLINED_BY_MERCHANT |
Booking was asynchronously declined by the merchant. |
PaymentInformation
Payment details that relate to a booking
JSON representation |
---|
{
"prepaymentStatus": enum ( |
Fields | |
---|---|
prepaymentStatus |
Prepayment status of the booking. If the prepaymentStatus is PREPAYMENT_PROVIDED or PREPAYMENT_REFUNDED, then paymentTransactionId contains the associated unique transaction id. |
paymentTransactionId |
Unique identifier for a payment transaction associated with the booking. Empty if not applicable. |
PrepaymentStatus
Prepayment status of a booking.
Enums | |
---|---|
PREPAYMENT_STATUS_UNSPECIFIED |
Not specified, defaults to PREPAYMENT_NOT_PROVIDED. |
PREPAYMENT_PROVIDED |
The fee for the booking has been paid in advance. |
PREPAYMENT_NOT_PROVIDED |
The fee for the booking has not been paid in advance. |
PREPAYMENT_REFUNDED |
The fee was previously PREPAYMENT_PROVIDED but has now been refunded. |
Methods |
|
---|---|
|
Updates an existing Booking . |