---
title: "Returns list of travel offers based on the criteria."
method: POST
path: "/widgetsvc/traveloffers"
tags: ["WidgetService"]
---

# Returns list of travel offers based on the criteria.

`POST /widgetsvc/traveloffers`

## Request

- Base URL: `https://api.travelify.io`
- URL: `https://api.travelify.io/widgetsvc/traveloffers`
- Auth: none declared

## Request body

- TravelOfferCriteria: Model defining a travel offer criteria request
  - `dealmap` boolean: States if the request is for a deal map or offer box (default = false)
  - `deduping` 1 | 2: Enumerator defining type of travel offer deduping:<br>1=None, 2=Aggressive
  - `type` 0 | 1 | 2 | 3 | 4: Enumerator defining type of travel offers:<br>0=Any, 1=Flights, 2=Accommodation, 3=Packages, 4=CarRental
  - `packageType` 0 | 1 | 2: Enumerator defining type of offer package types:<br>0=Any, 1=DynamicPackages, 2=PackageHolidays
  - `maxOffers` integer: Maximum number of offers to return
  - `budgetMin` integer: Minimum budget
  - `budgetMax` integer: Maximum budget
  - `pricingByType` 1 | 2 | 3: Enumerator defining pricing by types:<br>1=Total, 2=Person, 3=Night
  - `currency` string, required: ISO4217 3-letter currency code (e.g. GBP).
  - `language` string, required: ISO639-1 2-letter language code (e.g. en).
  - `nationality` string, required: ISO3166 2-letter nationality country code (e.g. GB).
  - `origin` string, nullable: Optional 3-letter IATA airport/city code or 2-letter country code
  - `origins` string[], nullable: Optional list of 3-letter IATA airport/city code or 2-letter country code
  - `destination` string, nullable: Optional IATA airport code, 2-letter country code, resort or city name
  - `destinations` string[], nullable: Optional list of IATA airport code, 2-letter country code, resort or city name
  - `rollingDates` boolean: Whether to use rolling dates (if true must set DatesMin and DatesMax)
  - `datesMin` integer, nullable: Optional minimum days from today
  - `datesMax` integer, nullable: Optional maximum days from today
  - `startDate` string, date-time, nullable: Optional start date
  - `endDate` string, date-time, nullable: Optional end date
  - `exactDates` boolean: Whether date range is exact dates (if false then searches whole month)
  - `returnOnly` boolean: Return travel options only (default=true)
  - `durationMin` integer, nullable: Optional minimum duration
  - `durationMax` integer, nullable: Optional maximum duration
  - `carrierCodes` string[], nullable: Optional list of airline carrier codes
  - `cabinClasses` CabinClasses[], nullable: Optional list of flight cabin classes
  - `ratingMin` number, double, nullable: Optional minimum rating
  - `propertyTypes` PropertyTypes[], nullable: Optional list of property types
  - `boardBases` BoardBasis[], nullable: Optional list of board basis
  - `sort` string, nullable: Sorting of travel offers returned

## Response `200`

OK

- APIResponseData: Model defining the data API response.
  - `success` boolean: Indicator as to whether API request was successful.
  - `error` string, nullable: Returns an error if success is returned as false.
  - `data` unknown
  - `deposit` OrderDepositOptionDBO: Model for defining deposit option
    - `id` integer: Deposit identifier
    - `optionId` integer: Deposit option identifier
    - `initialAmount` number, double: Initial payment amount
    - `currency` string, nullable: Currency code
    - `breakdown` DepositBreakdown[], nullable: Breakdown
      - `num` integer: Installment number
      - `amount` number, double: Installment amount
      - `dueDate` string, date-time: Installment due date
      - `supplierDueDate` string, date-time, nullable: Optional supplier balance due date

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/travelify/apis/travelify-io-api.md) - [All operations](https://skmtc.dev/travelify/apis/travelify-io-api/llms.txt) - [OpenAPI document](https://skmtc.dev/travelify/apis/travelify-io-api/revisions/70f1c708e1af?raw)