Get PackageSpecification entities.

GETRequest

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

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

const result = await client.packageSpecifications.list({
  organization: 0,
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "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"
  }
]

Response 400

Bad request

application/json

Example 1

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

Query parameters

• accommodationListingnumberoptional
• categorynumberoptional
• availablebooleanoptional
• packagebooleanoptional
• seasonalbooleanoptional
• yearbooleanoptional
• slugstringoptional
• idnumberoptional
• archivedbooleanoptional
• datestringoptional
• orderBystringoptional
• optionalbooleanoptional
• hasContractbooleanoptional
• accommodationsbooleanoptional
• detailsbooleanoptional
• accommodationCategorynumberoptional
• accommodationnumberoptional
• activebooleanoptional
• dateFromstringoptional
• dateTostringoptional
• divisionnumberoptional
• localestringoptional
• localityCategorynumberoptional
• publicbooleanoptional
• settingsbooleanoptional
• organizationnumberrequired

Returns

Array of PackageSpecification

Schema shown for 200 · application/json

• idnumber
• titlestring
• metaTitlestring
• slugstring
• excerptstringoptional
• descriptionstringoptional
• imagestringoptional
• dateFromstring
• dateTostring
• numOfDaysnumber
• includedNumOfPersonsnumberoptional
  Default: 0
• unitPricestring
• hasUnitOfMeasurementPersonbooleanoptional
  Default: false
• hasUnitOfMeasurementNumOfPersonsbooleanoptional
  Default: false
• hasPaymentConditionsbooleanoptional
  Default: false
• packagebooleanoptional
  Default: false
• seasonalbooleanoptional
  Default: false
• yearbooleanoptional
  Default: false
• optionalbooleanoptional
  Default: false
• publicbooleanoptional
  Default: false
• activebooleanoptional
  Default: true
• excludeIfDateFromAndToIsNotEqualbooleanoptional
  Default: false
• reservationConfirmationFooterstringoptional
• reservationConfirmationEmailNotesstringoptional
• contractFooterstringoptional
• taxRatestringoptional
• valueAddedTaxIncludedbooleanoptional
  Default: true
• hasContractbooleanoptional
  Default: false
• localestring
• createdstring
• modifiedstringoptional
• archivedstringoptional