---
title: "Get LOS Pricing"
method: POST
path: "/api/rate/fplos/search"
---

# Get LOS Pricing

`POST /api/rate/fplos/search`

## Request body

- SearchLosRequest — The request body
  - `propertyId` integer, required — Valid Agoda Property ID that partner has access to
  - `roomId` integer, required — Agoda Room ID related to the property inventory element. <br/> <i>Agoda active Room IDs can be returned with Getproduct request.</i>
  - `ratePlanId` integer, required — Agoda Rateplan ID related to a particular offer active on a room. <br/> Agoda active Rate Type IDs can be returned with Getproduct request.
  - `checkInDateRange` CheckInDateRange, required — Date range of interested check-in date
    - `start` string, YYYY-MM-DD, required — Start of check-in date range to get rate in the format YYYY-MM-DD
    - `end` string, YYYY-MM-DD, required — End of check-in date range to get rate in the format YYYY-MM-DD
  - `los` LOS
    - `start` integer, required — Start length of stay range
    - `end` integer, required — End length of stay range

## Response `200`

Create response

- SearchLosResponse — The search query result
  - `propertyId` integer — Valid Agoda Property ID that partner has access to
  - `roomId` integer — Agoda Room ID related to the property inventory element. <br/> <i>Agoda active Room IDs can be returned with Getproduct request.</i>
  - `ratePlanId` integer — Agoda Rateplan ID related to a particular offer active on a room. <br/> Agoda active Rate Type IDs can be returned with Getproduct request.
  - `rates` RateList[]
    - `checkInDate` string, YYYY-MM-DD — Check-in date
    - `rate` Rate
      - `currency` string — Rate plan's rate currency (must be the same currency as set up in property level)
      - `prices` Price[] — Price List
        - `los` integer — Length of stay
        - `value` number — Price Value (with the currrency described in property level)
        - `occupancy` object
          - `min` integer — minimum occupancy
          - `max` integer — maximum occupancy
    - `restriction` RateRestriction — the object inidicate the rate restriction
      - `closed` boolean — Controls if rate type is open for sale or closed to sale. Close will stop room type regular inventory being sold even if inventory is available.
      - `cta` boolean — Close to arrival: Make a room unavailable to book if the guest check-in on a certain date. <br/> Set to make rate type open or closed for arrival on this date. Customer can still stay through this date if they arrive on past date.
      - `ctd` boolean — Close to departure: Make a room unavailable to book if the guest check-out on a certain date. Set to make rate type open or closed for departure on this date. Customer can still stay through this date if they depart on future date.
      - `minStay` integer — Minimum length of stay that is required to search and book this room type. minStay cannot be greater than maxStay.
      - `maxStay` integer — Maximum length of stay that is required to search and book this room type. maxStay cannot be less than minStay.<br> -1 stands for infinity, or no maxStay defined
      - `minStayThrough` integer — Minimum stay through - Minimum length of stay that is required to search and book this room type for stay through.
      - `minAdvPurchase` integer — Minimum Days in advance that rate must be booked to be eligible for a specific rateplan.
      - `maxAdvPurchase` integer — Maximum Days in advance that rate must be booked to be eligible for a specific rateplan.
      - `losRestriction` string — Restriction per los, only valid if closed flag is false. Length of this field is equal to max LOS sent in the request. Example, date: 2021-12-01 and losRestriction: 1110111101, this means user won't see the allotment for 4 and 9 los, if he wants to checkin on this date.

## Other responses

- `403` — Failing request

## Changes

- **2026-07-17** `29dd979133e4` — 6 breaking
  - the request property `checkInDateRange` became required
  - the request property `los/end` became required
  - the request property `los/start` became required
  - the request property `propertyId` became required
  - …2 more
- **2022-07-24** `507c4900f771` — 1 warning, 1 info
  - removed the optional property `rates/items/checkinDate` from the response with the `200` status
  - added the optional property `rates/items/checkInDate` to the response with the `200` status
- **2022-07-20** `0b262c69387e` — 1 breaking, 3 warning
  - the `rates` response's property type/format changed from ``/`` to `array`/`` for status `200`
  - removed the optional property `rates/checkinDate` from the response with the `200` status
  - removed the optional property `rates/rate` from the response with the `200` status
  - removed the optional property `restriction` from the response with the `200` status
- **2022-07-19** `ee0e87c99fb6` — 1 breaking
  - the `restriction/losRestriction` response's property type/format changed from `integer`/`int32` to `string`/`` for status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/agoda-com/apis/los-pricing-api/changes/api/rate/fplos/search/post.md)

---

[API](https://skmtc.dev/agoda-com/apis/los-pricing-api.md) · [All operations](https://skmtc.dev/agoda-com/apis/los-pricing-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/agoda-com/los-pricing-api/revisions/29dd979133e4/schema)