Get DiscountSpecification entities.

GETRequest

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

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

const result = await client.discountSpecifications.list();

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 0,
    "description": "description",
    "validFrom": "validFrom",
    "validThrough": "validThrough",
    "locale": "locale",
    "created": "created",
    "periods": [
      {}
    ],
    "divisions": [
      {
        "id": 1000
      }
    ],
    "validFromReservationDate": "validFromReservationDate",
    "validThroughReservationDate": "validThroughReservationDate",
    "calculationStrategy": "amount",
    "type": "normal",
    "discountAmount": "discountAmount",
    "discountPercentage": "discountPercentage",
    "discountDays": 0,
    "roundUpToIntegerValues": false,
    "hasEligibleDiscountCode": false,
    "hasEligibleReservationPeriod": false,
    "hasEligibleMinNumOfDays": false,
    "hasEligibleMinNumOfPersons": false,
    "hasEligibleNumOfDays": false,
    "hasEligibleNumOfDaysBeforeArrival": false,
    "eligibleMinNumOfDays": 0,
    "eligibleMinNumOfPersons": 0,
    "eligibleNumOfDays": 0,
    "eligibleNumOfDaysBeforeArrival": 0,
    "eligibleForTourOperatorReservations": false,
    "combineWithOtherDiscounts": true,
    "package": true,
    "seasonal": true,
    "year": true,
    "relativeToDiscountPeriod": false,
    "relatedToCustomAccommodationPriceComponentGroups": false,
    "promotional": true,
    "archived": "archived",
    "modified": "modified"
  }
]

Response 400

Bad request

application/json

Example 1

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

Query parameters

• datestringoptional
• referenceDatestringoptional
• accommodationPriceComponentGroupnumberoptional
• descriptionstringoptional
• accommodationnumberoptional
• archivedbooleanoptional
• dateFromstringoptional
• dateTostringoptional
• offsetnumberoptional
• limitnumberoptional

Returns

Array of DiscountSpecification

Schema shown for 200 · application/json

• idnumber
• descriptionstring
• validFromstring
• validThroughstring
• validFromReservationDatestringoptional
• validThroughReservationDatestringoptional
• calculationStrategystringoptional
  Default: "amount"
• typestringoptional
  Default: "normal"
• discountAmountstringoptional
• discountPercentagestringoptional
• discountDaysnumberoptional
• roundUpToIntegerValuesbooleanoptional
  Default: false
• hasEligibleDiscountCodebooleanoptional
  Default: false
• hasEligibleReservationPeriodbooleanoptional
  Default: false
• hasEligibleMinNumOfDaysbooleanoptional
  Default: false
• hasEligibleMinNumOfPersonsbooleanoptional
  Default: false
• hasEligibleNumOfDaysbooleanoptional
  Default: false
• hasEligibleNumOfDaysBeforeArrivalbooleanoptional
  Default: false
• eligibleMinNumOfDaysnumberoptional
• eligibleMinNumOfPersonsnumberoptional
• eligibleNumOfDaysnumberoptional
• eligibleNumOfDaysBeforeArrivalnumberoptional
• eligibleForTourOperatorReservationsbooleanoptional
  Default: false
• combineWithOtherDiscountsbooleanoptional
  Default: true
• packagebooleanoptional
  Default: true
• seasonalbooleanoptional
  Default: true
• yearbooleanoptional
  Default: true
• relativeToDiscountPeriodbooleanoptional
  Default: false
• relatedToCustomAccommodationPriceComponentGroupsbooleanoptional
  Default: false
• promotionalbooleanoptional
  Default: true
• localestring
• archivedstringoptional
• createdstring
• modifiedstringoptional
• periodsDiscountSpecificationPeriod[]
• divisionsobject[]
  Show array — 1 property

  • idnumberoptional