latestSwagger 2.02026-08-172560124.6 KB

6863a5956792

reservations

Get reservation by id

This endpoint allows an agent or a user to get a reservation by id. The id is either agent-specific or a public id. The agent/user needs to be authenticated.

The endpoint will return HTTP 404 - Not Found if the reservation with the specified id could not be found.

It will return HTTP 403 - Forbidden if the agent/user is not authenticated, if the agent/user doesn't have permissions, if the reservation doesn't belong to the authenticated agent or if the user doesn't have permissions to see objects from the merchant owner of the reservation

####Request:

  • reservationId: Agent-specific or public ID of the requested reservation

####Response:

  • id: Agent-specific or public ID of the requested reservation
  • number: Quandoo internal identifier of the reservation
  • quandooId: The public id of this reservation on quandoo system.
  • status: The status of the reservation eg. CREATED, CONFIRMED, CUSTOMER CANCELED etc.
  • startTime: The start time of the reservation. Format: yyyy-MM-ddTHH:mm:ssZ
  • endTime: The end time of the reservation. Format: yyyy-MM-ddTHH:mm:ssZ
  • capacity: The capacity (people count) of the reservation
  • merchantId: The ID of the merchant at which this reservation was made.
  • customerId: The public ID of the customer to which this reservation belongs
  • promoCode: The promotion code associated with this reservation. Optional.
  • extraInfo: extra information that the customer provided for the reservation. Optional.
  • links: Related links that can be followed based on this response.
  • reservationTags: A list of reservation tag IDs.
  • createdAt: The date the reservation was created. Format: yyyy-MM-ddTHH:mm:ssZ
  • updatedAt: The date the reservation was last updated. Format: yyyy-MM-ddTHH:mm:ssZ

Example curl:

curl https://{host}/v{X}/reservations/07f53b36-3f48-11e5-a151-feff819cdc9f

Example response:

{
  "id": "07f53b36-3f48-11e5-a151-feff819cdc9f",
  "number": 1092454812,
  "quandooId": "07f53b36-3f48-11e5-a151-feff819cdc9f",
  "status": "CREATED",
  "startTime": "2015-06-22T12:00:00+00:00",
  "endTime": "2015-06-22T13:00:00+00:00",
  "capacity": 4,
  "merchantId": 1384,
  "customerId": "35fff464-142c-48ac-a0c6-ed72a1615664",
  "promocode": "SOME_CAMPAIGN_CODE",
  "extraInfo": "request for baby chair",
  "links": [
    {
      "href": "https://{host}/v{X}/reservations/07f53b36-3f48-11e5-a151-feff819cdc9f",
      "method": "PATCH",
      "rel": "update"
    }
  ],
  "createdAt": "2015-06-01T15:21:54Z",
  "updatedAt": "2015-06-01T18:45:30Z"
}
get/v1/reservations/{reservationId}

Path parameters

reservationIdstring required

Id of the reservation

Response

OK