API Definition

The Product API will enable our hotels partners to create and edit their room types and rate plans via APIs, without having to use EPC or contact their market manager. The API also enables our partners to read the definition of the room types and rate plans created in the system.

Authentication

Partner must include a valid username/password in the HTTP header of the request using the below format:

Authorization: Basic <username and password encoded by Base64>

Example:

Authorization: Basic RVFDdGVzdDEyOTMzODcwOmV3NjduazMz

Where "RVFDdGVzdDEyOTMzODcwOmV3NjduazMz" is the string "EQCtest12933870:ew67nk33" (username:password) Base64-encoded.

For more information about getting started for the first time, and authorization, please refer to the FAQ & Guides section

Swagger.json File for Product API

To facilitate integrating with the Product API, Expedia offers a Swagger.json file documenting the Product API model and operations. Please watch our Video Tutorial for more information on how developers can leverage this file to kick start development.

API Principles & Standards

• HTTP 1.1 : Our API only supports HTTP 1.1. Requests made with HTTP 1.0 explicitly will be denied.
• JSON : The service will return JSON documents for read, create, and update requests, and accept JSON payloads for create and update requests.
• Secure HTTP w/TLS v1.2 : The API is only available via HTTPS, and supports GET (read), POST (create), and PUT (update) operations. Our API will not accept connections using SSL or TLS below v1.2 protocol. We will only establish connections with TLS v1.2 protocol.
• REST : The service adheres to REST principles and exposes three resources: Rate Plans, Room Types, and Properties.
• MUST-IGNORE : The service is constantly evolving and we expect consumers of our service to enforce a must-ignore policy. If the Product API starts returning additional data elements in responses, partners should ignore the data elements they do not need. Partners should also be able to serve the additional data back in an update request, as our update requests are full overlay, and failure to provide additional data back in update requests could cause data to be removed.
• Entity : All successful responses returned by EPS services are encapsulated within an HTTP Entity. Entity is used as a way to make successful responses generic across different resources and operations. The Entity element may represent a single object, or multiple objects; if the latter, it would be an array.
• Errors : If a request produces one or more errors, the response will return an array of one or more errors. If Errors are present, Entity will not be present.

Resources & Endpoints Overview

• All of Expedia APIs now live under the https://services.expediapartnercentral.com/ domain. API users should make sure to only ever use the fully qualified domain name in their requests to our APIs, and never try to guess/hardcode the IP this address resolves to. In order to provide a robust, highly available and scalable solution, Expedia can change the IPs being used without notice.
• In order to access property information: /products/properties/{propertyResourceId}. Property resource ID is optional. If omitted, the list of active properties assigned to the account will be returned.
• Room types can be accessed in the context of a property: /properties/{propertyResourceId}/roomTypes/{roomTypeResourceId}. Room type resource ID is optional. If omitted, the list of active room types for the property will be returned.
• Rate plans can be accessed as part of a room type (they belong to a room type): /properties/{propertyResourceId}/roomTypes/{roomTypeResourceId}/ratePlans/{ratePlanResourceId}. Rate plan resource ID is optional. If omitted, the list of active rate plans for that room type will be returned.

Versioning

Expedia chose to version this API by making use of different content types per version. This gives Expedia the flexibility to version each resource (property, room type, rate plan) independently.

Starting with version 2, it is now required to provide a content-type header including the version with any POST or PUT request. For example:

Content-Type: application/vnd.expedia.eps.product-v2+json

The Accept header also now indicates which version is expected to be returned. Accept header is optional. If ommitted, Expedia will default to return the latest version. If provided, Expedia will validate that the version requested for the response is a valid one. Example of a valid Accept header:

Accept: application/vnd.expedia.eps.product-v2+json

HTTP Status Code

The API will leverage HTTP status codes as defined by RFC 2616, Section 10. More specifically, users should expect the following from the API:

HTTP Headers

HTTP headers are slightly different between a request made to the EPS Product API, and responses returned.

Format – Request

*required for create and modify requests only

Format – Response

Basic Response Wrapper Structure with Entity and Errors

All responses provided by the API will either contain an HTTP Entity element, which may represent a single object or an array of objects, or an Errors object for an array of errors.

Entity

The entities supported by the product API are rate plans, room types and properties.

The Entity approach allows partners to use the same wrapper for all resources exposed by the new generation of Expedia Partner Services like the EPS Product and EPS Image services.

Consider the following code in Java:

public class ResponseWrapperDTO<T> implements Serializable {
    private T entity;
    private List<ErrorDTO> errors;
}

Entities can be Product/RatePlan/RoomType/Property etc. Simple entity response:

{
  "entity": {
    "resourceId": 123,
    ...
  }
}

Single Entity VS Entity Array in Read/GET Responses

There are two different read operations available against the Product API resources:

• To get a specific resource, the resource ID needs to be specified on the URL. For example: /products/properties/{propertyId}
• To get all the active resources in the system, omit the resource ID on the URL. For example: /products/properties/.

For example, when requesting a single property, EPS Product API will return the property resource information as part of an Entity object:

{
  "entity": {
    "resourceId": 1,
    ...
  }
}

When requesting all properties assigned to a user account, an array of properties is returned:

{
  "entity": [
    {
      "resourceId": 1,
      …
    }, {
      "resourceId": 2,
      …
    }
  ]
}

Errors

If a response doesn’t contain an Entity, it will contain Errors:

{
  "errors": [
    {
      "code": 1000,
      "message": "Access denied: your account is not authorized to manage this property."
    }
  ]
}

Error

Entity vs Errors

Entity and errors are in the same wrapper because most frameworks will de-serialize responses automatically, but require a target type to which the response will be de-serialized.

Both successful and unsuccessful responses are returned by the same DTO, but can have either entity or errors, never both.

A Java implementation to handle this, using Spring’s RestTemplate, could look like this:

   ResponseEntity<ResponseWrapperDTO<RoomTypeDTO>> response = restTemplate.exchange(
            "url",
            HttpMethod.POST,
            entity,
            new ParameterizedTypeReference<ResponseWrapperDTO<RoomTypeDTO>>() {});

Property

Obtain a list of properties

• Method: GET
• Url: https://services.expediapartnercentral.com/products/properties
• Consumes: HTTP Request (GET)
• Produces: application/vnd.expedia.eps.product-v2+json

Parameters

Success Responses

Read a single property

• Method: GET
• Url: https://services.expediapartnercentral.com/products/properties/{propertyId}
• Consumes: HTTP Request (GET)
• Produces: application/vnd.expedia.eps.product-v2+json

Parameters

Success Responses

Property Resource Definition

CutOff

PropertyAddress

Room type

Obtain a list of room types

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

Parameters

Success Responses

Creates a new room type

• Method: POST
• Url: https://services.expediapartnercentral.com/properties/{propertyId}/roomTypes
• Consumes: application/vnd.expedia.eps.product-v2+json
• Produces: application/vnd.expedia.eps.product-v2+json

Parameters

Examples

{
        "partnerCode": "MyStringCode",
        "name": {
            "attributes": {
                "typeOfRoom": "Penthouse",
                "roomClass": "Executive",
                "includeBedType": true,
                "view": "City View",
                "featuredAmenity": "Jetted Tub",
                "customLabel": "Rooftop Terrace"
            }
        },
        "ageCategories": [
            {
                "category": "Adult", 
                "minAge": 18
            }, 
            {
                "category": "ChildAgeA", 
                "minAge": 6
            }, 
            {
                "category": "Infant", 
                "minAge": 0
            }
        ], 
        "maxOccupancy": {
            "adults": 2, 
            "children": 1, 
            "total": 3
        }, 
        "standardBedding": [
            {
                "option": [
                    {
                        "quantity": 1,
                        "type": "King Bed"
                    }
                ]
            }
        ], 
        "extraBedding": [
            {
                "quantity": 1,
                "type": "Rollaway Bed",
                "size": "Full",
                "surcharge": {
                    "type": "Per Day",
                    "amount": 20
                }
            }
        ],
        "smokingPreferences": [
            "Non-Smoking"
        ],
        "roomSize": {
            "squareFeet": 300,
            "squareMeters": 14
        },
        "views": [
            "Ocean View",
            "Beach View"
        ]
}

Success Responses

Read a single room type

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

Parameters

Success Responses

Modify an existing room type

Expedia offers 2 ways to modify a room type.

Using the PUT verb, partners can perform a full overlay change of the room type resource. It means that all elements of a room type need to be provided, and any optional element not provided will be erased/removed.

Using the PATCH verb, partners can perform a partial update of a room type. Expedia implemented the Merge-Patch RFC.

Room Type Modify - Full Overlay (PUT)

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

Parameters

Examples

{
        "resourceId": 200142893,
        "partnerCode": "MyStringCode",
        "name": {
            "attributes": {
                "typeOfRoom": "Penthouse",
                "roomClass": "Executive",
                "includeBedType": true,
                "view": "City View",
                "featuredAmenity": "Jetted Tub",
                "customLabel": "Rooftop Terrace"
            },
            "value": "Executive Penthouse, 1 King Bed, Jetted Tub, City View (Rooftop Terrace)"
        },
        "status": "Active",
        "ageCategories": [
            {
                "category": "Adult", 
                "minAge": 18
            }, 
            {
                "category": "ChildAgeA", 
                "minAge": 6
            }, 
            {
                "category": "Infant", 
                "minAge": 0
            }
        ], 
        "maxOccupancy": {
            "adults": 2, 
            "children": 1, 
            "total": 3
        }, 
        "standardBedding": [
            {
                "option": [
                    {
                        "quantity": 1, 
                        "type": "King Bed",
                        "size": "King"
                    }
                ]
            }
        ], 
        "extraBedding": [
            {
                "quantity": 1,
                "type": "Sofa Bed",
                "size": "Full",
                "surcharge": {
                    "type": "Per Day",
                    "amount": 20
                }
            }
        ],
        "smokingPreferences": [
            "Non-Smoking"
        ],
        "roomSize": {
            "squareFeet": 300,
            "squareMeters": 14
        },
        "views": [
            "Ocean View",
            "Beach View"
        ],
        "wheelchairAccessibility": true
}

Success Responses

Room Type Modify - Partial Update (PATCH)

Expedia chose the merge-patch method for partial update, as described in IETF RFC.

This method allows partners to update a room type by providing only the fields/values they need to change. This saves partners from having to first read the room type before updating it. If partners provide the complete room type data, this method essentially behaves just like the update method.

The response will always be the complete image of the room type after changes have been applied.

Important

The PATCH logic only applies to first (top) level elements/objects of the room type. Partners can decide to include any number of these top level elements/objects, and any elements/objects not included will be ignored/untouched. If a partner includes any array or complex object (such as name, age categories or max occupancy), these objects will need to be fully specified with all the desired elements/attributes/object changes, as they are treated as full overlay.

First-level elements/objects not provided in the input will remain unchanged. Some top-level elements can be removed. To do so, you have to explicitly specify it in the JSON message, as null. For array types, you need to provide a "null" or empty array value.

Also note that all validation rules are applied on the complete updated room type data. For instance, only providing a ageCategories that has no "Adult" category will yield the appropriate error response.

• Method: PATCH
• Url: https://services.expediapartnercentral.com/properties/{propertyId}/roomTypes/{roomTypeId}
• Consumes: application/vnd.expedia.eps.product-v2+json
• Produces: application/vnd.expedia.eps.product-v2+json

Parameters

Examples

Updating both the partner code and the name attributes:

{
  "partnerCode": "PatchedPartnerCode",
  "name": {
      "attributes": {
        "typeOfRoom": "Loft",
        "roomClass": "Deluxe",
        "area": "Poolside"
      }
    }
}

Updating only the maximum occupancy:

{
  "maxOccupancy": {
      "total": 3,
      "adults": 2
    }
}

Success Responses

RoomType Resource Definition

RoomTypeName

More information can be found on room type names in the "FAQ and Guides" section, under "Understanding Expedia's Logic Around Room Names" section.

RoomNameAttributes

More information can be found on room type names in the "FAQ and Guides" section, under "Understanding Expedia's Logic Around Room Names" section.

RoomTypeAgeCategory

Occupancy

BeddingOption

Bed

Extra Bed

Surcharge

RoomSize

RoomTypeLinks

Room Type Amenities

Amenities of a given room type can be accessed as a sub resource 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).

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-v2+json

Parameters

Success Responses

Set room type amenities to an existing room type

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

Parameters

Examples

[
  {
    "code": "ROOM_WIFI_INTERNET",
    "detailCode": "SURCHARGE"
  }, {
    "code": "ROOM_BATHTUB_TYPE",
    "detailCode": "DEEP_SOAKING"
  }, {
    "code": "ROOM_TV",
    "detailCode": "FLAT_PANEL"
  }, {
    "code": "ROOM_TV_SIZE",
    "detailCode": "SIZE_INCH",
    "value": 42
  }, {
    "code": "ROOM_NUMBER_OF_SEPARATE_BEDROOMS",
    "value": 2
  }, {
    "code": "ROOM_RECENT_RENOVATION_MONTH",
    "value": 5
  }, {
    "code": "ROOM_RECENT_RENOVATION_YEAR",
    "value": 2011
  }, {
    "code": "ROOM_PET_FRIENDLY"
  }
]

Success Responses

RoomTypeAmenity Definition

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

Room Type Rate Thresholds

Rate Thresholds defines 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. Rate thresholds can only be read by partners, they cannot be set, changed or deleted.

Room type rate thresholds can be defined by Expedia in one of 2 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 defaults to global thresholds not exposed via this API.

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-v2+json

Parameters

Success Responses

RateThresholds Resource Definition

RateThresholdsLinks

rateThresholdsSourceEnum

Example GET https://services.expediapartnercentral.com/properties/12933870/roomTypes/201706782/rateThresholds

{
  "entity": {
    "type": "SellLAR",
    "minAmount": 98.55,
    "maxAmount": 310.2,
    "source": "RecentBookings",
    "_links": {
      "self": {
        "href": "https://services.expediapartnercentral.com/properties/12933870/roomTypes/201706782/rateThresholds"
      }
    }
  }
}

Rate plan

Obtain a list of rate plans

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

Parameters

Success Responses

Create a new rate plan

• Method: POST
• Url: https://services.expediapartnercentral.com/properties/{propertyId}/roomTypes/{roomTypeId}/ratePlans
• Consumes: application/vnd.expedia.eps.product-v2+json
• Produces: application/vnd.expedia.eps.product-v2+json

Parameters

Examples

{
  "name": "My Rate Plan Name",
  "rateAcquisitionType": "NetRate",
  "distributionRules": [
    {
      "partnerCode": "ECCode",
      "distributionModel": "ExpediaCollect"
    }, {
      "partnerCode": "HCCode",
      "distributionModel": "HotelCollect"
    }
  ],
  "status": "Active",
  "type": "Standalone",
  "pricingModel": "PerDayPricing",
  "occupantsForBaseRate": 2,
  "taxInclusive": false,
  "cancelPolicy": {
    "defaultPenalties": [
      {
        "deadline": 0,
        "perStayFee": "1stNightRoomAndTax",
        "amount": 0
      }, {
        "deadline": 24,
        "perStayFee": "None",
        "amount": 0
      }
    ],
        "exceptions": [
            {
                "endDate": "2019-04-01",
                "startDate": "2019-03-01",
                "penalties": [
                    {
                        "amount": 1.0,
                        "deadline": 0,
                        "perStayFee": "1stNightRoomAndTax"
                    },
                    {
                        "amount": 1.0,
                        "deadline": 24,
                        "perStayFee": "FullCostOfStay"
                    }
                ]
            }
        ]
  },
  "additionalGuestAmounts": [
    {
      "ageCategory": "Adult",
      "amount": 8.73
    }, {
      "ageCategory": "ChildAgeA",
      "amount": 5
    }
  ],
  "serviceFeesPerStay": [
      {
    "isTaxable": false,
    "percent": 0.2
     },
     {
    "isTaxable": true,
    "amountPerNight": 5.0,
    "amountPerStay": 20.0,
     }
    ],
    "serviceFeesPerPerson": [
     {
     "dateStart": "2018-09-20",
     "dateEnd": "2079-06-06",
     "ageCategory": "Adult",
     "isTaxable": true,
     "amountPerStay": 20
      },
      {
      "dateStart": "2018-07-27",
      "dateEnd": "2018-09-19",
      "ageCategory": "Adult",
      "isTaxable": true,
      "amountPerNight": 12
      }
      ],
  "valueAddInclusions": [
    "Free Parking", "Free Breakfast", "Free Internet"
  ],
  "minLOSDefault": 1,
  "maxLOSDefault": 28,
  "minAdvBookDays": 0,
  "maxAdvBookDays": 500,
  "bookDateStart": "1900-01-01",
  "bookDateEnd": "2079-06-06",
  "travelDateStart": "1901-01-01",
  "travelDateEnd": "2079-06-06",
  "mobileOnly": false
}

Success Responses

Read a single rate plan

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

Parameters

Success Responses

Modify an existing rate plan

Expedia offers 2 ways to modify a rate plan.

Using the PUT verb, partners can perform a full overlay change of the rate plan resource. It means that all elements of a rate plan need to be provided, and any optional element not provided will be erased/removed.

Using the PATCH verb, partners can perform a partial update of a rate plan. Expedia implemented the Merge-Patch RFC.

Rate Plan Modify - Full Overlay (PUT)

• Method: PUT
• Url: https://services.expediapartnercentral.com/properties/{propertyId}/roomTypes/{roomTypeId}/ratePlans/{ratePlanId}
• Consumes: application/vnd.expedia.eps.product-v2+json
• Produces: application/vnd.expedia.eps.product-v2+json

Parameters

Example

{
  "resourceId": 205020307,
  "name": "My Rate Plan Name",
  "rateAcquisitionType": "NetRate",
  "distributionRules": [
    {
      "expediaId": "205020307",
      "partnerCode": "ECCode",
      "distributionModel": "ExpediaCollect",
      "manageable": true,
      "compensation": {
        "percent": 0.23,
        "minAmount": 0
      }
    }, {
      "expediaId": "205020307A",
      "partnerCode": "HCCode",
      "distributionModel": "HotelCollect",
      "manageable": true,
      "compensation": {
        "percent": 0.23
      }
    }
  ],
  "status": "Active",
  "type": "Standalone",
  "pricingModel": "PerDayPricing",
  "occupantsForBaseRate": 2,
  "taxInclusive": false,
  "depositRequired": false,
  "creationDateTime": "2016-10-20T21:05:12Z",
  "lastUpdateDateTime": "2016-10-21T18:37:27Z",
  "cancelPolicy": {
    "defaultPenalties": [
      {
        "deadline": 0,
        "perStayFee": "1stNightRoomAndTax",
        "amount": 0
      }, {
        "deadline": 24,
        "perStayFee": "None",
        "amount": 0
      }
    ],
        "exceptions": [
            {
                "endDate": "2019-04-01",
                "startDate": "2019-03-01",
                "penalties": [
                    {
                        "amount": 1.0,
                        "deadline": 0,
                        "perStayFee": "1stNightRoomAndTax"
                    },
                    {
                        "amount": 1.0,
                        "deadline": 24,
                        "perStayFee": "FullCostOfStay"
                    }
                ]
            }
        ]
  },
  "additionalGuestAmounts": [
    {
      "dateStart": "2015-11-27",
      "dateEnd": "2079-06-06",
      "ageCategory": "Adult",
      "amount": 8.73
    }, {
      "dateStart": "2015-11-27",
      "dateEnd": "2079-06-06",
      "ageCategory": "ChildAgeA",
      "amount": 5
    }
  ],
   "serviceFeesPerStay": [
     {
    "isTaxable": false,
    "percent": 0.2
     },
     {
    "isTaxable": true,
    "amountPerNight": 5.0,
    "amountPerStay": 20.0,
     }
     ]
       "serviceFeesPerPerson": [
     {
     "dateStart": "2018-09-20",
     "dateEnd": "2079-06-06",
     "ageCategory": "Adult",
     "isTaxable": true,
     "amountPerStay": 20
      },
      {
      "dateStart": "2018-07-27",
      "dateEnd": "2018-09-19",
      "ageCategory": "Adult",
      "isTaxable": true,
      "amountPerNight": 12
      }
      ],
  "valueAddInclusions": [
    "Free Parking", "Free Breakfast", "Free Internet"
  ],
  "minLOSDefault": 1,
  "maxLOSDefault": 28,
  "minAdvBookDays": 0,
  "maxAdvBookDays": 500,
  "bookDateStart": "1900-01-01",
  "bookDateEnd": "2079-06-06",
  "travelDateStart": "1901-01-01",
  "travelDateEnd": "2079-06-06",
  "mobileOnly": false,
  "_links": {
    "self": {
      "href": "https://services.expediapartnercentral.com/properties/12933870/roomTypes/201706782/ratePlans/205020307"
    }
  }
}

Success Responses

Rate Plan Modify - Partial Update (PATCH)

Expedia chose the merge-patch method for partial update, as described in IETF RFC.

This method allows partners to update a rate plan by providing only the fields/values they need to change. This saves partners from having to first read the rate plan before updating it. If partners provide the complete rate plan data, this method essentially behaves just like the update method.

The response will always be the complete image of the rate plan after changes have been applied.

Important

The PATCH logic only applies to first (top) level elements/objects of the rate plan. Partners can decide to include any number of these top level elements/objects, and any elements/objects not included will be ignored/untouched. If a partner includes any array or complex object (such as cancel policy, additional guest amounts or distribution rules), these objects will need to be fully specified with all the desired elements/attributes/object changes, as they are treated as full overlay.

First-level elements/objects not provided in the input will remain unchanged. Some top-level elements can be removed. To do so, you have to explicitly specify it in the JSON message, as null. For array types, you need to provided a "null" or empty array value.

Also note that all validation rules are applied on the complete updated rate plan data. For instance, only providing a travelDateStart that is after the current travelDateEnd will yield the appropriate error response.

• Method: PATCH
• Url: https://services.expediapartnercentral.com/properties/{propertyId}/roomTypes/{roomTypeId}/ratePlans/{ratePlanId}
• Consumes: application/vnd.expedia.eps.product-v2+json
• Produces: application/vnd.expedia.eps.product-v2+json

Parameters

Examples

Updating both the name and the status:

{
  "name": "My New Rate Plan Name",
  "status": "Inactive"
}

Updating only the cancel policy:

{
    "cancelPolicy": {
        "defaultPenalties": [
            {
                "deadline": 0,
                "perStayFee": "1stNightRoomAndTax",
                "amount": 0
            },
            {
                "deadline": 24,
                "perStayFee": "None",
                "amount": 0
            }
        ],
        "exceptions": [
            {
                "endDate": "2019-04-01",
                "startDate": "2019-03-01",
                "penalties": [
                    {
                        "amount": 1.0,
                        "deadline": 0,
                        "perStayFee": "1stNightRoomAndTax"
                    },
                    {
                        "amount": 1.0,
                        "deadline": 24,
                        "perStayFee": "FullCostOfStay"
                    }
                ]
            }
        ]
    }
}

Success Responses

Delete an existing rate plan

• Method: DELETE
• Url: https://services.expediapartnercentral.com/properties/{propertyId}/roomTypes/{roomTypeId}/ratePlans/{ratePlanId}
• Consumes: HTTP Request (DELETE)
• Produces: application/vnd.expedia.eps.product-v2+json

Parameters

Success Responses

RatePlan Resource Definition

AdditionalGuestAmount

serviceFeesPerStay

serviceFeesPerPerson

CancelPolicy

Cancel Policy Exception

Penalty

DistributionRule

CompensationRule

CompensationExceptionRule

RatePlanLinkage

RateDerivationRule

Period

RatePlanLinks

Link

rateAcquisitionTypeEnum

Error codes

Renders the page describing the business error codes used by the API

• Method: GET
• Url: https://services.expediapartnercentral.com/products/documentation/api/errors
• Consumes: HTTP Request (GET)
• Produces: text/html

Success Responses

Enumerations & Domain Values

PredefinedRoomNamesEnum

typeOfRoomEnum

roomClassEnum

bedroomDetailsEnum

featuredAmenityEnum

viewEnum

Views can be used either in room name attributes, or in an array of up to 2 views defined at the room-level. The list of values supported for each is slightly different. The below table indicates where each view can be used. Most can be used in both places without problem.

areaEnum

categoryEnum

smokingPreferenceEnum

bedTypeEnum

Bed types can not all be used as extra or standard beds. To understand if a bed type can be used in the standard bedding configuration of the room, or can only be provided in the extra bed list, please refer to the Standard/Extra column. Trying to provide a standard-only bed as extra (or vice-versa) via the API will result in the API returning an error.

bedSizeEnum

As guidance, size references can be found below, to help partners better understand what each type refers to. All sizes are width sizes, and both centimeters (cm) and inches (in) are provided.

Valid Bed Type and Size Combinations

Expedia doesn't support all possible combinations of bed types and size. The table below indicates which sizes can be used with each bed type. Partners attempting to make use of any other size will get an error back from the API when they do so.

surchargeTypeEnum

Note: Surcharge type Unknown will be returned for any room where a surcharge cost has been specified without a type or an amount. The client is expected to add this information in such cases, and therefore, type Unknown is not supported in POST, PUT and PATCH operations.

valueAddInclusionsEnum

There are 2 possible enums. One applies to all rate plans of type Standalone and Package, the other to rate plans of type Corporate.

perStayFeeEnum

adjustmentTypeEnum

amenityCodes, detailCodes and Values

The amenity codes/detail codes and values have been split into sub sections with names to faciliate discovery and understanding.

Internet Access

Bathroom

Food-related

Entertainment

Bedding and Linens

Room Layout

Services

Room Features

Club/Executive Level