Skip to main content

ReservationBetaApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
reservationControllerAttachPaymentPOST /v1/reservation/attach-paymentAttach Reservation Payment
reservationControllerConfirmReservationPOST /v1/reservation/confirmConfirm reservation
reservationControllerCreateReservationPOST /v1/reservationCreate reservation request
reservationControllerGetReservationHistoryGET /v1/reservation/historyGet Reservation History
reservationControllerGetReservationStatusGET /v1/reservation/{reservation_id}Get reservation status and information
reservationControllerGetReservationStatusByNumberGET /v1/reservation/check-status/{reservation_number}Get reservation info using reservation number
reservationControllerGetReservationTypeInfoGET /v1/reservation/type/{id}Get reservation type information
reservationControllerGetStoresWithReservationsPOST /v1/reservation/store/searchGet store list that offers reservations

reservationControllerAttachPayment

AttachedReservationPaymentEntity reservationControllerAttachPayment(ReservationPaymentAttachDTO)

Attach Reservation Payment

Parameters

NameTypeDescriptionNotes
ReservationPaymentAttachDTOReservationPaymentAttachDTO

Return type

AttachedReservationPaymentEntity

Authorization

api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

reservationControllerConfirmReservation

ConfirmReservationEntity reservationControllerConfirmReservation(ConfirmReservationDTO)

Confirm reservation

Parameters

NameTypeDescriptionNotes
ConfirmReservationDTOConfirmReservationDTO

Return type

ConfirmReservationEntity

Authorization

api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

reservationControllerCreateReservation

CreateReservationEntity reservationControllerCreateReservation(CreateReservationDTO)

Create reservation request

Parameters

NameTypeDescriptionNotes
CreateReservationDTOCreateReservationDTO

Return type

CreateReservationEntity

Authorization

api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

reservationControllerGetReservationHistory

ReservationEntity reservationControllerGetReservationHistory(id, status, limit, offset)

Get Reservation History

Parameters

NameTypeDescriptionNotes
idStringCustomer ID that you passed to us[default to null]
statusStringReservation status filter[optional] [default to null] [enum: pending, new, accepted, canceled, completed]
limitBigDecimalThe number of record to return, 0 means all will be returned[optional] [default to null]
offsetBigDecimalThe number of records to skip[optional] [default to null]

Return type

ReservationEntity

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

reservationControllerGetReservationStatus

ReservationInfoEntity reservationControllerGetReservationStatus(reservation_id)

Get reservation status and information

Parameters

NameTypeDescriptionNotes
reservation_idStringReservation id[default to null]

Return type

ReservationInfoEntity

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

reservationControllerGetReservationStatusByNumber

ReservationInfoEntity reservationControllerGetReservationStatusByNumber(reservation_number)

Get reservation info using reservation number

Parameters

NameTypeDescriptionNotes
reservation_numberStringReservation number[default to null]

Return type

ReservationInfoEntity

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

reservationControllerGetReservationTypeInfo

ReservationTypeClass reservationControllerGetReservationTypeInfo(id, date)

Get reservation type information

Parameters

NameTypeDescriptionNotes
idStringReservation type id[default to null]
dateStringIntended date to reserve[default to null]

Return type

ReservationTypeClass

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

reservationControllerGetStoresWithReservations

AvailableReservationEntity reservationControllerGetStoresWithReservations(SearchAvailableStoresForReservationDTO)

Get store list that offers reservations

Parameters

NameTypeDescriptionNotes
SearchAvailableStoresForReservationDTOSearchAvailableStoresForReservationDTO

Return type

AvailableReservationEntity

Authorization

api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json