Booking

Get a booking

get
/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Booking/{bookingId}

Gets the specified booking.

Authorizations
HTTPRequired

Bearer token using a JWT

Path parameters
deploymentIdinteger · int32Required

The deployment Id.

providerIdinteger · int32Required

The ResDiary unique provider Id.

bookingIdinteger · int32Required

The ResDiary unique booking Id.

Query parameters
api-versionstringOptional
Responses
chevron-right
200

OK

The details of a booking.

Idinteger · int32Optional

The internal ResDiary booking Id.

BookingReferencestringOptional

The booking reference.

MembershipIdstringOptional

The customer's membership Id.

CustomerNamestringOptional

The customer's name.

CustomerEmailstringOptional

The customer's email address.

CustomerMobileCountryCodeinteger · int32Optional

The customer's mobile number country code.

CustomerMobilestringOptional

The customer's mobile number.

IsOptedInForEmailbooleanOptional

Indicates whether the customer has opted in for group marketing emails.

GroupEmailMarketingOptInTextstringOptional

The group marketing opt in text for email.

GroupEmailMarketingOptInDateTimestring · date-timeOptional

The group marketing opt in datetime for email.

IsOptedInForSmsbooleanOptional

Indicates whether the customer has opted in for marketing group SMS messages.

GroupSmsMarketingOptInTextstringOptional

The group marketing opt in text for SMS.

GroupSmsMarketingOptInDateTimestring · date-timeOptional

The group marketing opt in datetime for SMS.

ReceiveRestaurantEmailMarketingbooleanOptional

true if the customer wishes to receive restaurant email marketing, false otherwise.

RestaurantEmailMarketingOptInTextstringOptional

The restaurant marketing opt in text for email.

RestaurantEmailMarketingOptInDateTimestring · date-timeOptional

The restaurant marketing opt in datetime for email.

ReceiveRestaurantSmsMarketingbooleanOptional

true if the customer wishes to receive restaurant SMS marketing, false otherwise.

RestaurantSmsMarketingOptInTextstringOptional

The restaurant marketing opt in text for SMS.

RestaurantSmsMarketingOptInDateTimestring · date-timeOptional

The restaurant marketing opt in datetime for SMS.

IsConfirmedWithGuestbooleanOptional

Indicates whether the booking has been confirmed with the guest.

CommentsstringOptional

Any comments made against the booking.

ProviderIdinteger · int32Optional

The Id of the restaurant the booking was made in.

RestaurantNamestringOptional

The restaurant's name.

CoversBookedinteger · int32Optional

The number of covers in the booking.

VisitDateTimestring · date-timeOptional

The date and time of the visit.

Spendnumber · doubleOptional

The amount spent during the visit.

Statusstring · enumOptional

The status of the booking.

Possible values:
ArrivalStatusstringOptional

The arrival status of the booking (Fully seated, Waiting in bar, etc).

MealStatusstringOptional

The meal status of the booking (Drinks, Starter, Mains, etc).

BookingSourcestringOptional

The source of the booking (channel).

BookingDateTimestring · date-timeOptional

The date and time the booking was created, in UTC.

CustomerFirstNamestringOptional

The customer's First Name

CustomerSurnamestringOptional

The customer's Surname

CustomerIdinteger · int32Optional

The unique id for the customer.

ServiceNamestringOptional

The name of the service in which the booking has been made.

RoomNumberstringOptional

The room number of the guest for whom the booking has been made (applies to hotels only).

ReceiptXmlstringOptional

The EPOS Receipt for the booking in XML format.

Durationinteger · int32Optional

The duration of the booking in minutes. This time excludes the turn time for the table.

TurnTimeinteger · int32Optional

The amount of time allotted to change the table over for the next booking in minutes.

CurrencyCodestringOptional

The currency of any payments made against the booking

IsCreditCardAddedbooleanOptional

true if a credit card has been added

CustomerMarketingSourceIpAddressstringOptional

The IP address of the client making the booking. Defaults to the IP address that the request comes from.

CancellationReasonIdinteger · int32Optional

The cancellation reason id associated with this booking

get
/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Booking/{bookingId}
200

OK

Get earliest booking date

get
/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Booking/EarliestDate

Gets the date of the earliest booking for the restaurant.

Authorizations
HTTPRequired

Bearer token using a JWT

Path parameters
deploymentIdinteger · int32Required

The Id of the deployment that the restaurant is in.

providerIdinteger · int32Required

The restaurant's Id.

Query parameters
api-versionstringOptional
Responses
chevron-right
200

OK

Resultstring · date-timeOptional
get
/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Booking/EarliestDate
200

OK

List bookings for date

get
/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Booking/{bookingDate}

Gets the bookings for the provider on the specified date.

Authorizations
HTTPRequired

Bearer token using a JWT

Path parameters
deploymentIdinteger · int32Required

The Id of the deployment that the provider is in.

providerIdinteger · int32Required

The provider's Id.

bookingDatestring · date-timeRequired

The date to get bookings for, in UTC.

Query parameters
api-versionstringOptional
Responses
chevron-right
200

OK

The details of a booking.

Idinteger · int32Optional

The internal ResDiary booking Id.

BookingReferencestringOptional

The booking reference.

MembershipIdstringOptional

The customer's membership Id.

CustomerNamestringOptional

The customer's name.

CustomerEmailstringOptional

The customer's email address.

CustomerMobileCountryCodeinteger · int32Optional

The customer's mobile number country code.

CustomerMobilestringOptional

The customer's mobile number.

IsOptedInForEmailbooleanOptional

Indicates whether the customer has opted in for group marketing emails.

GroupEmailMarketingOptInTextstringOptional

The group marketing opt in text for email.

GroupEmailMarketingOptInDateTimestring · date-timeOptional

The group marketing opt in datetime for email.

IsOptedInForSmsbooleanOptional

Indicates whether the customer has opted in for marketing group SMS messages.

GroupSmsMarketingOptInTextstringOptional

The group marketing opt in text for SMS.

GroupSmsMarketingOptInDateTimestring · date-timeOptional

The group marketing opt in datetime for SMS.

ReceiveRestaurantEmailMarketingbooleanOptional

true if the customer wishes to receive restaurant email marketing, false otherwise.

RestaurantEmailMarketingOptInTextstringOptional

The restaurant marketing opt in text for email.

RestaurantEmailMarketingOptInDateTimestring · date-timeOptional

The restaurant marketing opt in datetime for email.

ReceiveRestaurantSmsMarketingbooleanOptional

true if the customer wishes to receive restaurant SMS marketing, false otherwise.

RestaurantSmsMarketingOptInTextstringOptional

The restaurant marketing opt in text for SMS.

RestaurantSmsMarketingOptInDateTimestring · date-timeOptional

The restaurant marketing opt in datetime for SMS.

IsConfirmedWithGuestbooleanOptional

Indicates whether the booking has been confirmed with the guest.

CommentsstringOptional

Any comments made against the booking.

ProviderIdinteger · int32Optional

The Id of the restaurant the booking was made in.

RestaurantNamestringOptional

The restaurant's name.

CoversBookedinteger · int32Optional

The number of covers in the booking.

VisitDateTimestring · date-timeOptional

The date and time of the visit.

Spendnumber · doubleOptional

The amount spent during the visit.

Statusstring · enumOptional

The status of the booking.

Possible values:
ArrivalStatusstringOptional

The arrival status of the booking (Fully seated, Waiting in bar, etc).

MealStatusstringOptional

The meal status of the booking (Drinks, Starter, Mains, etc).

BookingSourcestringOptional

The source of the booking (channel).

BookingDateTimestring · date-timeOptional

The date and time the booking was created, in UTC.

CustomerFirstNamestringOptional

The customer's First Name

CustomerSurnamestringOptional

The customer's Surname

CustomerIdinteger · int32Optional

The unique id for the customer.

ServiceNamestringOptional

The name of the service in which the booking has been made.

RoomNumberstringOptional

The room number of the guest for whom the booking has been made (applies to hotels only).

ReceiptXmlstringOptional

The EPOS Receipt for the booking in XML format.

Durationinteger · int32Optional

The duration of the booking in minutes. This time excludes the turn time for the table.

TurnTimeinteger · int32Optional

The amount of time allotted to change the table over for the next booking in minutes.

CurrencyCodestringOptional

The currency of any payments made against the booking

IsCreditCardAddedbooleanOptional

true if a credit card has been added

CustomerMarketingSourceIpAddressstringOptional

The IP address of the client making the booking. Defaults to the IP address that the request comes from.

CancellationReasonIdinteger · int32Optional

The cancellation reason id associated with this booking

get
/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/Booking/{bookingDate}
200

OK

Get booking changes for date

get
/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/BookingChange/{changeDate}

Gets the changes to any bookings for the specified date.

Authorizations
HTTPRequired

Bearer token using a JWT

Path parameters
deploymentIdinteger · int32Required

The Id of the deployment that the provider is in.

providerIdinteger · int32Required

The provider's Id.

changeDatestring · date-timeRequired

The date to get the changes for, in UTC.

Query parameters
api-versionstringOptional
Responses
chevron-right
200

OK

Contains a change that was made to a booking. Null fields mean they have not been changed. If all the fields are null, it means that a property that is not currently being reported has been changed.

BookingIdinteger · int32Optional

The internal ResDiary booking Id.

ChangeDateTimestring · date-timeOptional

The date and time the change was made in UTC.

ChangeUserIdinteger · int32Optional

The internal ResDiary Id of the user who made the change.

ChangeUserNamestringOptional

The username of the user who made the change.

Coversinteger · int32Optional

The new number of covers.

VisitDateTimestring · date-timeOptional

The new visit date and time.

StatusstringOptional

The new booking status.

OldProviderIdinteger · int32Optional

The previous provider id of the booking.

NewProviderIdinteger · int32Optional

The new provider id of the booking, as the booking has moved to a different restaurant and/or the restaurant has been renamed.

Spendnumber · doubleOptional

The amount spent during the visit.

IsConfirmedWithGuestbooleanOptional

Whether this booking was reconfirmed with the customer.

RoomNumberstringOptional

The room number of the guest for whom the booking has been made (applies to hotels only).

ReceiptXmlstringOptional

The EPOS Receipt for the booking in XML format.

Durationinteger · int32Optional

The duration of the booking in minutes. This time excludes the turn time for the table. For the full duration that the table is held for add on the value of the turn time property.

TurnTimeinteger · int32Optional

The amount of time allotted to change the table over for the next booking in minutes.

TotalPaymentMadenumber · floatOptional

The total payment that has been made against the booking.

IsCreditCardAddedToBookingbooleanOptional

True if a credit card has been added to the booking.

ArrivalStatusstring · enumOptional

The new arrival status for this booking.

Possible values:
MealStatusstring · enumOptional

The new meal status for the booking.

Possible values:
OldProviderNamestringOptional

The provider name of the old restaurant

NewProviderNamestringOptional

The provider name of the new restaurant

get
/api/ConsumerApi/v1/DataExtract/Restaurant/{deploymentId}/{providerId}/BookingChange/{changeDate}
200

OK

Last updated

Was this helpful?