Ticket Distributor Knowledge Base

TABLE OF CONTENTS

Query rates of the ticket product
- REQUEST
- RESPONSE

Used by the distributor to retrieve the dynamic information (e.g., Price) of products.

Query rates of the ticket product

This API is used to query the DerbySoft cache to query the available ticket product rate

REQUEST

Request Headers

Level	Field Name	Data Type	Required	Description	Example
1	authorization*	string	Y	Oauth2 authorization token
1	echo-token*	string	Y	A unique echo token is generated from the distributor	cc28bac659c44422b2dab11705934a4f
1	distributor-id*	string	Y	Distributor ID in the Derbysoft system	DISTRIBUTOR
1	brand-id	string	N	Property brand, required for Disney, United Parks	WDW
1	office-id	string	N	The distributor identifier for each of their offices or points of sale consists of distributorid(Disney) and officeid(Disney), which are combined with the underscore. Required for Disney	DERBY-1_DERBY001
1	supplier-id*	string	Y		DISNEY

Request Body

Level	Field Name	Data Type	Required	Description	Example
1	dateRange*		Y
2	startDate*	date	Y	Start date of date range, format with yyyy-MM-dd
2	endDate	date	N	End date of date range, format with yyyy-MM-dd
1	productId	string	N		5XK03A
1	durationDays	integer	N	The number of days included in the ticket purchase
1	affiliation	string	N	Available discount code

Request Example

Request Example: post //shopping

{
  "dateRange": {
    "startDate": "2022-02-13",
    "endDate": "2022-02-15"
  },
  "productId": [
    "5XK03A",
    "5XK03C"
  ],
  "durationDays": 5,
  "affiliation": "STD_GST"
}

RESPONSE

Response Schema

Level	Field Name	Data Type	Required	Description	Example
1	supplier-id*	string	Y	supplier-id	DISNEY
1	destination		N
2	countryCode*	string	Y	Country Code, ISO 3166-1 alpha-2 code, Min 1 char
2	countryName*	string	Y	Min 1 char
2	subdivisionCode*	string	Y	Subdivision Code, ISO 3166-2 code, Min 1 char
2	subdivisionName*	string	Y	Min 1 char
2	subdivisionCategory*	string	Y	Subdivision Category, such as state, province
2	cityName	string	N
1	productId*	string	Y		5XK03A
1	brand-id	string	N	Property brand, required for Disney, United Parks	WDW
1	durationDays	integer	N	The number of days included in the ticket purchase	5
1	marketRegions	array	N	It will be used for ticket products, advising whether the tickets can only be sold to a specific region.	["INTL_WHOLESALE"]
1	affiliations	array	N	All available discount codes for this product	["STD_GST"]
1	rates		Y	Product price details for a period
2	usageDateRange		N	The usage window of this product
3	startDate	date	Y	Start date of date range, format with yyyy-MM-dd	2025-03-11
3	endDate	date	N	End date of date range, format with yyyy-MM-dd	2026-02-28
2	date*	string	Y	Check in date. Format with yyyy-MM-dd	2026-10-09
2	price*		Y
3	amountBeforeTax	number	N	Single ticket price without tax
3	amountAfterTax	number	N	Single ticket price with tax
3	decimalPlaces	integer	N	Decimal places
2	currency*	string	Y	Currency code
3	exchangeBeforeTax	number	N	the full retail price of the ticket without tax
3	exchangeAfterTax	number	N	The full retail price of the ticket with tax
3	netDiscount		N
4	type	enum	N	Allowed: PERCENTAGE┃AMOUNT
4	value	number	N	Net discount value.

Response Example

Success Response (HTTP Status 200)

[
  {
    "supplierId": "DISNEY",
    "destination": {
      "countryCode": "US",
      "countryName": "United States",
      "subdivisionCode": "US-IL",
      "subdivisionName": "Illinois",
      "subdivisionCategory": "State",
      "cityName": "Chicago"
    },
    "productId": "5XK03A",
    "brandId": "WDW",
    "durationDays": 5,
    "marketRegions": [
      "INTL_WHOLESALE"
    ],
    "affiliations": [
      "STD_GST"
    ],
    "rates": [
      {
        "usageDateRange": {
          "startDate": "2022-02-13",
          "endDate": "2022-02-15"
        },
        "date": "2022-02-13",
        "price": {
          "amountBeforeTax": 120.01,
          "amountAfterTax": 150.01,
          "decimalPlaces": 2,
          "currency": "USD",
          "exchangeBeforeTax": 652.06,
          "exchangeAfterTax": 694.06,
          "netDiscount": {
            "type": "PERCENTAGE",
            "value": 0.01
          }
        }
      }
    ]
  }
]

Error Response (HTTP Status 500)

{
  "errorCode": "System",
  "errorMessage": "Internal Server Error"
}

Shopping API

Query rates of the ticket product

REQUEST

RESPONSE