Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Update Reservation Vendor API Documentation

API ENDPOINT

[PATCH] <BASE_URL>/api/vendor/v1/vendor_reservations/:vendor_reservation_id.json?locale=en

Request Parameters

ParameterTypeRequiredDescription
vendor_reservation_idStringYesUnique identifier received from Create Reservation API
  • Body Parameters (JSON format):
ParameterTypeRequiredDescription
restaurant_idStringYesUnique identifier for the restaurant
reference_idStringYesVendor's internal reference for the booking
dateStringYesNew reservation date (Format: YYYY-MM-DD)
start_timeStringYesNew reservation time (Format: HH:MM)
adultIntegerYesNumber of adult guests
kidsIntegerYesNumber of child guests
special_requestStringNoAny special requests from the guest
selected_packagesArrayYesList of selected packages with quantities

Current Process for Vendor Reservation Update / Change

1. Reservation with Vendor Payment

Sample Request

  1. Create Reservation with vendor payment

  1. Update Reservation
PATCH /api/vendor/v1/vendor_reservations/7944.json
{
    "reservation": {
        "restaurant_id": "4589",
        "reference_id": "2004Vendor003",
         "date": "2025-03-10",
        "start_time": "18:00",
        "adult": 3,
        "kids": 0,
        "special_request": "Update Booking from HungryHub API",
        "selected_packages": [
            {
                 "id": "35513",
            "quantity": 3
            }
        ]
    }
}


Response

Condition or Prepaid Reservation Restrictions

  • When Vendor reservation is not exist
{
    "success": false,
    "message": "reservation not found",
    "data": null
}
  • Modifications Not Allowed:
    • Users cannot modify the number of pax (adults or kids) for prepaid reservations.
    • Users cannot change the selected package for vendor payment reservations

Error Response for Prepaid Reservation Changes:

{
  "success": false,
  "message": "You can’t modify a prepaid booking, please contact our support team (LINE@HUNGRYHUB)",
  "data": null
}

Time Slot Unavailability Error

  • If the requested date and time slot are unavailable, the system returns an error message.
{
  "success": false,
  "message": "You can’t modify a prepaid booking, please contact our support team (LINE@HUNGRYHUB)",
  "data": null
}

Reservation Cancellation for Vendor Payment

  • If a reservation is vendor payment-based (Prepaid), cancellation is restricted.
  • API Endpoint: {{base_url}}/api/vendor/v1/vendor_reservations/7944/cancel.json?locale=en
  • Error Response for Vendor Payment Cancellation:
{
    "success": false,
    "message": "Sorry, this booking can not be canceled",
    "data": null
}