Product API
ReferenceProduct API

Amenity resources

The Product API enables you to create and edit room amenities. Amenities of a given room type can be accessed as a subresource of a specific room type any time after it was created. By default, for newly created room types, there will be no amenities. The only operations available are GET to read amenities, and PUT to set amenities (as a full overlay, all currently supported amenities have to be passed in a PUT).

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.

Read a single room type's amenities

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

Request parameters

ParameterParameter TypeDescriptionRequiredData Type

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. Integer

Yes

string

Success responses

Status CodeDescriptionResponse Model

200

OK

Array[RoomTypeAmenityDTO ]

Set room type amenities for an existing room type

  • Method: PUT
  • URL: https://services.expediapartnercentral.com/properties/{propertyId}/roomTypes/{roomTypeId}/amenities
  • Consumes: application/vnd.expedia.eps.product-v3+json
  • Produces: application/vnd.expedia.eps.product-v3+json

Request parameters

ParameterParameter TypeDescriptionRequiredData Type

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

body

body

JSON message with the room type amenities

Yes

Array[RoomTypeAmenity Definition ]

Example syntax

1[
2 {
3 "code": "ROOM_WIFI_INTERNET",
4 "detailCode": "SURCHARGE"
5 },
6 {
7 "code": "ROOM_BATHTUB_TYPE",
8 "detailCode": "DEEP_SOAKING"
9 },
10 {
11 "code": "ROOM_TV",
12 "detailCode": "FLAT_PANEL"
13 },
14 {
15 "code": "ROOM_TV_SIZE",
16 "detailCode": "SIZE_INCH",
17 "value": 42
18 },
19 {
20 "code": "ROOM_NUMBER_OF_SEPARATE_BEDROOMS",
21 "value": 2
22 },
23 {
24 "code": "ROOM_RECENT_RENOVATION_MONTH",
25 "value": 5
26 },
27 {
28 "code": "ROOM_RECENT_RENOVATION_YEAR",
29 "value": 2011
30 },
31 {
32 "code": "ROOM_PET_FRIENDLY"
33 }
34]

Success responses

Status CodeDescriptionResponse Model

200

OK

Array [RoomTypeAmenity Definition ]

RoomTypeAmenity Definition

For a full list of supported amenity codes, detail codes and values, see amenityCodes.

Property NameTypeDescription

code

amenityCodes

Uniquely identifies an amenity. A given code can only ever be specified once for a room type.

detailCode

amenityCodes

Adds precision or qualifies the amenity. Mandatory for some amenities, optional for others and prohibited by the rest of the amenities.

value

amenityCodes

Adds precision to the amenity. Mandatory for some amenities, optional for others and prohibited by the rest of the amenities.