GET Prices by context, contextId

Overview

Retrieve trip departure and product prices

Request

GET /[context]/[contextId]/Prices

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory 
Context is either Product or Departure
contextId
Integer
Mandatory 
For Product Context :Product ID 
For Departure Context :Departure ID

Response Information

[productPricesCollection]

Response Properties

Name
Type
Description
prices
List<PriceSeason>
List of product price seasons. valid only in the context of product

Prices

Name
Type
Description
effectiveFrom
String
Start date for price validity,
based on the date that the transfer/accommodation is booked on
effectiveTo
String
End date for price validity,
based on the date that the transfer/accommodation is booked on
pricesPerCurrency
List<PricesPerCurrency>
Array of prices per currency for this date range

Pricespercurrency

Name
Type
Description
currency
String
Currency
numberOfCustomers
String
Number of customers that this price applies to (if booked at the same time)
Some products offer discounts for booking multiple customers at the same time
This property will not be included for products that have a fixed price for the overall product (i.e. not per customer)
total
Decimal
*Product: Total price for the specified number of customers (or for the product if it’s a fixed price product) 
*Departure: The discounted total price for the specified number of adult passengers to travel

[departurePricesCollection]

Response Properties

Name
Type
Description
prices
List<DeparturePricesPerCurrency>
List of departure prices. Valid only in the context of departure
exclusions
List<RRPElementExclusion>
RRP Element Exclusion
kitty
RRPKitty
Kitty Price

Kitty

Name
Type
Description
kittyCurrencyId
Integer
Kitty Currency Id
kittyCurrencyCode
String
Kitty Currency Code
kittyCurrencySymbol
String
Kitty Currency Symbol
kittyAmount
Decimal
Kitty Amount

Prices

Name
Type
Description
roomType
String
Room type
perAdultPrice
Decimal
The undiscounted price for one adult passenger to travel
perChildPrice
Decimal
Price per child  (Not applicable to fixed price products) 
*Only applies to family trips
totalChildPrice
Decimal
Total Child price 
*Only applies to family trips
discountedPricePerAdult
Decimal
The discounted price for one adult passenger to travel
discountedPricePerChild
Decimal
Discounted Gross Price Per Child 
*Only applies to family trips
totalAdultPriceBeforeDiscount
Decimal
The undiscounted price for the specified number of  adult passengers to travel
totalChildPriceBeforeDiscount
Decimal
Total child price before discount 
*Only applies to family trips
currency
String
Currency
numberOfCustomers
String
Number of customers that this price applies to (if booked at the same time)
Some products offer discounts for booking multiple customers at the same time
This property will not be included for products that have a fixed price for the overall product (i.e. not per customer)
total
Decimal
*Product: Total price for the specified number of customers (or for the product if it’s a fixed price product) 
*Departure: The discounted total price for the specified number of adult passengers to travel

Exclusions

Name
Type
Description
elementTitle
String
Element Title
currencyId
Integer
Currency Id
currencyCode
String
Currency Code
currencySymbol
String
Currency Symbol
amount
Decimal
Amount

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

[productPricesCollection]

{
  "prices": [
    {
      "effectiveFrom": "2015-01-01",
      "effectiveTo": "2015-01-31",
      "pricesPerCurrency": [
        {
          "currency": "AUD",
          "numberOfCustomers": "3",
          "total": 1258.0
        },
        {
          "currency": "AUD",
          "numberOfCustomers": "3",
          "total": 1258.0
        }
      ]
    },
    {
      "effectiveFrom": "2015-01-01",
      "effectiveTo": "2015-01-31",
      "pricesPerCurrency": [
        {
          "currency": "AUD",
          "numberOfCustomers": "3",
          "total": 1258.0
        },
        {
          "currency": "AUD",
          "numberOfCustomers": "3",
          "total": 1258.0
        }
      ]
    }
  ]
}

[departurePricesCollection]

{
  "prices": [
    {
      "roomType": "twinShare",
      "perAdultPrice": 1258.0,
      "perChildPrice": 1000.0,
      "totalChildPrice": 1000.0,
      "discountedPricePerAdult": 200.0,
      "discountedPricePerChild": 100.0,
      "totalAdultPriceBeforeDiscount": 1400.0,
      "totalChildPriceBeforeDiscount": 1200.0,
      "currency": "AUD",
      "numberOfCustomers": "3",
      "total": 1258.0
    },
    {
      "roomType": "twinShare",
      "perAdultPrice": 1258.0,
      "perChildPrice": 1000.0,
      "totalChildPrice": 1000.0,
      "discountedPricePerAdult": 200.0,
      "discountedPricePerChild": 100.0,
      "totalAdultPriceBeforeDiscount": 1400.0,
      "totalChildPriceBeforeDiscount": 1200.0,
      "currency": "AUD",
      "numberOfCustomers": "3",
      "total": 1258.0
    }
  ],
  "exclusions": [
    {
      "elementTitle": "ABC",
      "currencyId": 3,
      "currencyCode": "AUD",
      "currencySymbol": "$",
      "amount": 100.0
    },
    {
      "elementTitle": "ABC",
      "currencyId": 3,
      "currencyCode": "AUD",
      "currencySymbol": "$",
      "amount": 100.0
    }
  ],
  "kitty": {
    "kittyCurrencyId": 3,
    "kittyCurrencyCode": "AUD",
    "kittyCurrencySymbol": "$",
    "kittyAmount": 50.0
  }
}