GET AgentPromotionPrices by context, contextId

Overview

Retrieve trip departure prices

Request

GET /[context]/[contextId]/AgentPromotionPrices

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory
Departure
contextId
Integer
Mandatory
Departure Id

Response Information

Response Properties

Name
Type
Description
priceOptions
List<AgentPromotionPriceOption>
A collection of available pricing options grouped by promotion type
exclusions
List<RRPElementExclusion>
RRP Element Exclusion
kitty
RRPKitty
Kitty Price
lastUpdatedDateTime
String
Last Updated Date Time

Kitty

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

Priceoptions

Name
Type
Description
promotionDescription
String
Agent Promotion Description
promotionCode
String
Promotion Code
prices
List<PromotionRoomTypePricing>
RRP Pricing future and current

Prices

Name
Type
Description
single
List<PromotionPrice>
RRP Price Single
twin
List<PromotionPrice>
RRP Price Twin
multi
List<PromotionPrice>
RRP Price Multi
typeCode
String
Type Code

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

{
  "priceOptions": [
    {
      "promotionDescription": "A special discount for Partner ABC",
      "promotionCode": "ABCD1234",
      "prices": [
        {
          "single": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "twin": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "multi": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "typeCode": "abc"
        },
        {
          "single": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "twin": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "multi": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "typeCode": "abc"
        }
      ]
    },
    {
      "promotionDescription": "A special discount for Partner ABC",
      "promotionCode": "ABCD1234",
      "prices": [
        {
          "single": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "twin": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "multi": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "typeCode": "abc"
        },
        {
          "single": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "twin": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "multi": [
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            },
            {
              "basePrice": 300.0,
              "totalPrice": 300.0,
              "discountedBasePrice": 200.0,
              "discountedTotalPrice": 200.0,
              "childBasePrice": 300.0,
              "childTotalPrice": 300.0,
              "childDiscountedBasePrice": 200.0,
              "childDiscountedTotalPrice": 200.0,
              "currencyId": 18,
              "currencyCode": "GBP",
              "validFrom": "2015-01-31",
              "validTo": "2015-01-31",
              "isHighlightDeal": true,
              "isHighlightPrice": true
            }
          ],
          "typeCode": "abc"
        }
      ]
    }
  ],
  "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
  },
  "lastUpdatedDateTime": "2019-11-06T11:06:46.257"
}