Find a Booking by ID

This endpoint retrieves details for a specific booking, providing information such as booking status, party size, contact details, and special notes. This allows Mozrest to access booking information in real time.

Endpoint

GET https://partner-domain.com/v1/mozrest/booking/{bookingId}

URL Parameters

Example Request

curl GET "https://partner-domain.com/v1/mozrest/booking/{bookingId}" \
  -H "Authorization: Bearer {{api_key}}" 

Example Response

{
  "id": "60e890aca5f07b6ee5b950b1",
  "bookingChannel": {
    "id": "60e890aca5f07b6ee5b950b3",
    "name": "Channel Name"
  },
  "venueId": "60e890aca5f07b6ee5b950b1",
  "partySize": 4,
  "status": "confirmed",
  "date": "2021-11-07T12:00:00+02:00",
  "notes": "I'm alergic to peanuts and broccoli",
  "paymentGatewayToken":null,
  "contact": {
    "id": "60e890aca5f07b6ee5b950b1",
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@gmail.com",
    "telephone": "44344223322",
    "locale": "en",
    },
    "optInConsent": true
  }
}

Response Definitions

• id: Unique identifier for the booking.
• bookingChannel: Object containing the booking channel’s id and name.
• venueId: Unique identifier for the venue in which the booking is made.
• partySize: Number of people for the reservation.
• status: Current status of the booking (e.g., "confirmed").
• date: Date and time of the booking in ISO 8601 format.
• notes: Special notes or requests made by the customer.
• paymentGatewayToken: Token if payment information was processed through a gateway.
• contact: Object containing contact details for the booking owner:
  • id: Unique identifier for the contact.
  • firstname: First name of the contact person.
  • lastname: Last name of the contact person.
  • email: Email address of the contact person.
  • telephone: Phone number of the contact person.
  • locale: Preferred language/locale of the contact.
  • optInConsent: Boolean indicating whether the contact has opted in for communications.