Lookup Reservation entity.

Lookup a Reservation entity by ‘number’ and either ‘email’ and/or ‘postalCode’.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.reservations.lookup({
  number: "<number>",
});

Responses

200400404

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "date": "2023-04-23T13:13:00Z",
  "referenceDate": "2023-04-23T13:13:00Z",
  "hasCustomCheckinCheckoutTime": false,
  "numOfPersonsWithCheckin": 0,
  "numOfPersonsWithCheckout": 0,
  "numOfAdditionalGuestsWithCheckin": 0,
  "numOfAdditionalGuestsWithCheckout": 0,
  "closed": true,
  "confirmed": true,
  "cancelable": true,
  "cancelled": true,
  "denied": true,
  "refunded": true,
  "reincarnatable": true,
  "session": true,
  "optionExpired": true,
  "excludeExpiredPaymentsListing": true,
  "preferredUnitForGuest": true,
  "package": true,
  "seasonal": true,
  "year": true,
  "annualSettlementIncluded": true,
  "hasCustomPaymentConditions": true,
  "hasAutomaticElectricCurrent": true,
  "grouped": true,
  "locked": true,
  "accommodationEditable": true,
  "accommodationUnitEditable": true,
  "removable": true,
  "excludeFromCat": true,
  "hasCancellationInsurance": true,
  "locale": "locale",
  "additionalGuests": [
    {
      "id": 0,
      "dateFrom": "dateFrom",
      "dateTo": "dateTo",
      "created": "created",
      "ageGroupSpecificationDescription": "ageGroupSpecificationDescription",
      "name": "name",
      "firstName": "firstName",
      "surname": "surname",
      "surnamePrefix": "surnamePrefix",
      "birthDate": "birthDate",
      "modified": "modified",
      "ageGroupSpecification": {
        "id": 0,
        "type": "type",
        "description": "description",
        "excludedFromMaxNumOfPersons": true,
        "required": true,
        "relatedToCustomAccommodations": true,
        "locale": "locale",
        "priority": 0,
        "minNumOfPersons": 0,
        "maxNumOfPersons": 0,
        "minAge": 0,
        "maxAge": 0,
        "created": "created",
        "modified": "modified"
      }
    }
  ],
  "ageGroupLines": [
    {
      "id": 0,
      "description": "description",
      "quantity": 0,
      "allocated": 0,
      "priority": 0,
      "ageGroupSpecification": {
        "id": 0,
        "type": "type",
        "description": "description",
        "excludedFromMaxNumOfPersons": true,
        "required": true,
        "relatedToCustomAccommodations": true,
        "locale": "locale",
        "priority": 0,
        "minNumOfPersons": 0,
        "maxNumOfPersons": 0,
        "minAge": 0,
        "maxAge": 0,
        "created": "created",
        "modified": "modified"
      },
      "reservation": null
    }
  ],
  "petLines": [
    {
      "id": 0,
      "description": "description",
      "quantity": 0,
      "petSpecification": {
        "id": 0,
        "name": "name",
        "type": "type",
        "locale": "locale",
        "accommodations": [
          {}
        ],
        "relatedToCustomAccommodations": false,
        "default": false
      },
      "reservation": {
        "id": 1000
      }
    }
  ],
  "attachments": [
    {
      "id": 0,
      "locale": "locale",
      "name": "name",
      "filename": "filename",
      "url": "url",
      "type": "type"
    }
  ],
  "cancellationInsuranceChargeLines": [
    {
      "id": 0,
      "taxRate": "taxRate",
      "taxTotal": "taxTotal",
      "taxBaseAmount": "taxBaseAmount",
      "totalPrice": "totalPrice",
      "type": "type",
      "amount": "amount",
      "percentage": "percentage"
    }
  ],
  "contexts": [
    {
      "id": 0,
      "dateFrom": "dateFrom",
      "dateTo": "dateTo",
      "numOfDays": 0,
      "numOfPersonsLines": [
        {}
      ],
      "normal": false,
      "package": false,
      "seasonal": false,
      "year": false,
      "packageSpecification": {
        "id": 0,
        "title": "title",
        "metaTitle": "metaTitle",
        "slug": "slug",
        "dateFrom": "dateFrom",
        "dateTo": "dateTo",
        "numOfDays": 0,
        "unitPrice": "unitPrice",
        "locale": "locale",
        "created": "created",
        "excerpt": "excerpt",
        "description": "description",
        "image": "image",
        "includedNumOfPersons": 0,
        "hasUnitOfMeasurementPerson": false,
        "hasUnitOfMeasurementNumOfPersons": false,
        "hasPaymentConditions": false,
        "package": false,
        "seasonal": false,
        "year": false,
        "optional": false,
        "public": false,
        "active": true,
        "excludeIfDateFromAndToIsNotEqual": false,
        "reservationConfirmationFooter": "reservationConfirmationFooter",
        "reservationConfirmationEmailNotes": "reservationConfirmationEmailNotes",
        "contractFooter": "contractFooter",
        "taxRate": "taxRate",
        "valueAddedTaxIncluded": true,
        "hasContract": false,
        "modified": "modified",
        "archived": "archived"
      },
      "reservationPackageSpecification": {
        "id": 0,
        "dateFrom": "dateFrom",
        "dateTo": "dateTo",
        "numOfDays": 0,
        "reservation": {}
      }
    }
  ]
}

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Response 404

Not found

application/json

Example 1

{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}

Query parameters

• numberstringrequired
• emailstringoptional
• postalCodestringoptional

Returns

Schema shown for 200 · application/json

Loading response fields…