Price Schedule **

The Price Schedule capability adds an endpoint to the OBS Capabilities API that allows operators to set prices for available Units on a daily basis and for different times in that day.

Many of Redeam's Resellers are actively moving to Price Schedule supported functionality. Additional pricing features and functionality will be added to this capability vs the standard Pricing capability. We highly recommend the use of Price Schedule to future proof your implementation with Redeam.

We do not recommend using both Price Schedule and Pricing per Product. Pricing is intended for static pricing that is constant regardless of date/time. Price Schedule is intended for pricing that may vary by date. If you have ANY variation in pricing by date please use Price Schedule and set a price for every date that you have availability. This will ensure that the Resellers get the price you intended for that date.

This capability does not modify the Product object in the base OBS specification, so no X-Capabilities header is required for Price Schedule. Reference can be found here

Products which utilize the price schedule MUST be booked using price-schedule prices, if a price-schedule price is available on the selected travel date.

Products with valid availability for a date with no price-schedule prices are bookable. This means the system will not deny the booking. If a price-schedule-enabled product is successfully booked on a date with no price-schedule prices, the price specified in the redeam/pricing capability will be used - or a default value of $0 will be assigned. Please make sure product price-schedules are in alignment with product availability!

GET /suppliers/:supplierId/products/:productId/pricing/schedule

Requests to the Price Schedule API endpoint contain two required path parameters and two optional query parameters:

Parameter NameDescriptionInFormatExampleRequired
supplierIdId of the Supplier, unique within the OBSpathstringWidget WorldYes
productIdId of the Product, unique within the SupplierpathstringWidget World TourYes
startDateStart of the date range to return, inclusivequeryRFC33392021-04-15No
endDateEnd of the date range to return, inclusivequeryRFC33392021-05-15No

These parameters accept dates only, and not times. For example, 2021-04-15 is valid, but 2021-04-15T00:00:00Z is not.

All dates MUST be local to the Product.

If the startDate is not provided, it defaults to the current date (localized to the Product).

If the endDate is not provided, it defaults to the startDate + 30 days.

The response contains a single Price Schedule object, which contains three nested dictionaries or maps.

  • The top-level map uses OptionIDs as keys.
  • Each OptionID key contains a map using one or more Dates as the key.
  • Each Date key contains a map using one or more UnitIDs as the key.
  • Finally, each UnitID points to an array. Each array contains, for that Unit and Date:
    • An optional array of startTimes containing the times of the day. If startTimes is empty, this price is valid for the entire date.
    • All valid prices (original, net, retail) and their currency
    • An optional array of includedTaxes if any taxes or additional fees are included in the prices

Examples

Example Price Schedule
Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Location

Questions? We'd love to hear them. Contact Redeam support.

On This Page
Price Schedule ** GET /suppliers/:supplierId/products/:productId/pricing/scheduleExamples