Booking flow - Cancel reservation

PATCH 
/v1/reservations/:id/cancel

Cancel a reservation.

Request

Path Parameters

id stringrequired

reservation uuid

Responses

200

Successful

*/*

Schema

Schema

reservationUuid stringrequired

reservation uuid

restaurantUuid stringrequired

restaurant uuid

mealDate daterequired

Reservation meal date

partySize integerrequired

Possible values: >= 1

Number of person attending to the reservation

status string

Possible values: [RECORDED, CONFIRMED, CANCELED, NO_SHOW, REQUESTED, REFUSED]

Reservation status

offerUuid string
customerNote string

Special request field that the diner can enter text in while making the reservation

customerUuid string

customer uuid

Example (from schema)

{
  "reservationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "restaurantUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mealDate": "2022-01-03T18:10:17.269Z",
  "partySize": 2,
  "status": "RECORDED",
  "offerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerNote": "note by the customer",
  "customerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afb3"
}

400

Bad Request

*/*

Schema

Schema

data

object

code string

Possible values: [CANCELLATION_ERROR]

error string

Possible values: [Bad Request]

statusCode number

Possible values: [400]

Example (from schema)

{
  "data": {
    "code": "CANCELLATION_ERROR"
  },
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

*/*

Schema

Schema

data object
error string

Possible values: [Unauthorized]

statusCode number

Possible values: [401]

Example (from schema)

{
  "data": {},
  "error": "Unauthorized",
  "statusCode": 401
}

404

Not Found

*/*

Schema

Schema

data

object

code string

Possible values: [RESERVATION_NOT_FOUND]

error string

Possible values: [Not Found]

statusCode number

Possible values: [404]

Example (from schema)

{
  "data": {
    "code": "RESERVATION_NOT_FOUND"
  },
  "error": "Not Found",
  "statusCode": 404
}

Loading...