Product API
ReferenceProduct API

Rate threshold resources

Rate thresholds define the minimum and maximum acceptable amounts that can be pushed for a room night, under any rate plan of the room type. They are used to verify that the rate being pushed for the rate plans of this room are not abnormally low or abnormally high. You can only read rate thresholds; they cannot be set, changed, or deleted.

Room type rate thresholds can be defined by Expedia Group in one of two ways: set by a manual override, or automatically calculated from the last 10 bookings made against any rate plan of the room type. By default, the automatic method is used. Thresholds will not be returned until at least 10 reservations were made, so it is expected that newer room types will have no room type thresholds defined. When no room-specific thresholds exist, Expedia Group defaults to global thresholds not exposed via this API.

The Product API response is transmitted through a synchronous connection to update the property’s system with the status of the Product API request. If a connectivity problem or another issue occurs, an error code will be returned that indicates what issue occurred.

Product API is RESTful and all requests and responses must be sent over a secure connection. All request and response bodies, including errors are encoded in JSON.

To facilitate integrating with Product API, Expedia Group offers a

Swagger JSON file file documenting Product API’s model and operations.

Obtain rate thresholds for a single room type

  • Method: GET
  • URL: https://services.expediapartnercentral.com/properties/{propertyId}/roomTypes/{roomTypeId}/rateThresholds
  • Consumes: HTTP Request (GET)
  • Produces: application/vnd.expedia.eps.product-v3+json

Request parameters

Parameter

Parameter Type

Description

Required

Data Type

Default Value

Authorization

header

Authorization token in HTTP header. Format: Authorization: Basic [username:password encoded by Base64]

Yes

Base64 encoded auth token

propertyId

path

Expedia Property ID

Yes

string

roomTypeId

path

Room type resource ID

Yes

string

Success responses

Status Code

Description

Response Model

200

OK

RateThresholds

Definitions

RateThresholds resource definition

Property Name

Type

Description

type

rateAcquisitionTypeEnum

Type of the rate verification thresholds. The only supported value is: SellLAR.

minAmount

number

Defines minimum acceptable rate, expressed as a decimal number. If the rate is lower than this minimum value, the Availability and Rates (AR) API rate update for any rate plans of this room type will be ignored and a warning will be returned.

maxAmount

number

Defines maximum acceptable rate, expressed as a decimal number. If the rate is higher than this maximum value, the Availability and Rates (AR) API rate update for any rate plans of this room type will be ignored and a warning will be returned.

source

rateThresholdsSourceEnum

Defines how the minimum and maximum amounts were calculated. It is either RecentBookings (thresholds calculated using last 10 bookings, and applying multiplication and division factor to find maximum and minimum values) or Manual (manually defined by Expedia Group). RecentBookings is Expedia Group's default method.

_links

RateThresholdsLinks

Collection of URLs that point to various resources related to the current resource.

Property Name

Type

Description

self

Link

URL of the current resource.

Example

The room type's rate thresholds resource defines the configuration of the rate thresholds applicable to all rate plans of a room type. It defines the lowest and highest acceptable rates for any rate plans of a room, for a stay date.

This example shows how to retrieve the rate thresholds for a given room type.

Request:

1GET https://services.expediapartnercentral.com/properties/1780044/roomTypes/200828484/rateThresholds
4Request-ID : 307af24f-f59a-11e4-822e-005056b1298f

Response:

If there are rate thresholds defined for the room type, the response would be as follows:

1{
2 "entity": {
3 "type": "SellLAR",
4 "minAmount": 98.55,
5 "maxAmount": 310.2,
6 "source": "RecentBookings",
7 "_links": {
8 "self": {
9 "href": "https://services.expediapartnercentral.com/properties/1780044/roomTypes/200828484/rateThresholds"
10 }
11 }
12 }
13}

If there are no rate thresholds defined for the room type, the response will be empty:

1{}
Note: Rate thresholds creation (POST), update (PUT, PATCH) and deletion (DELETE) operations are not supported.