# Products

Manage and retrieve all your products.

* View your inventory.
* Get tax information.
* Extensive search and filter.
* Retrieve availability and capacity.
* Get product ratings and reviews.

In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.

## List Product Locations

> Retrieve a list of all available product locations linked to your account. \
> \
> Locations represent physical or virtual places where products (such as tickets or experiences) are offered. These can include cities, landmarks, or specific venues, and help in organizing and filtering products geographically.

```json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"ProductID":{"name":"product_id","in":"query","required":false,"description":"[FILTER] on `product_id`.","schema":{"type":"string"}},"ItemsPerPage":{"name":"items_per_page","in":"query","required":false,"description":"[PAGING] Items Per Page - Allows user's to configure the `items_per_page` value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.  \n\nThis parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.  \n\nClients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the `items_per_page` response element in calculating actual page size.","schema":{"type":"integer","minimum":1,"maximum":200,"default":10}},"StartIndex":{"name":"start_index","in":"query","required":false,"description":"[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.","schema":{"type":"integer","minimum":1,"default":1,"maximum":10000}},"Page":{"name":"page","in":"query","required":false,"description":"[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items. \nThis is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The `page_index` and `total_pages` properties are used for this style of paging.","schema":{"type":"integer","minimum":1,"default":1}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"LocationListResponse":{"title":"Location List Response","type":"object","description":"Location list response.","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/LocationListResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"LocationListResponseData":{"title":"Location List Response Data","description":"Location list response data.","allOf":[{"$ref":"#/components/schemas/ReservedPaginationData"},{"type":"object","properties":{"items":{"title":"Locations","description":"Locations.","type":"array","items":{"$ref":"#/components/schemas/LocationListModel"}}},"required":["total_items","items"]}]},"ReservedPaginationData":{"title":"Reserved Pagination Data","type":"object","description":"The following properties are located in the data object, and help page through a list of items.\nThe paging properties below allow for various styles of paging, including:\n+ Previous/Next paging - Allows user's to move forward and backward through a list, one page at a time. The nextLink and previousLink properties (described in the \"Reserved Property Names for Links\" section below) are used for this style of paging.\n+ Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?startIndex=200.\n+ Page-based paging - Allows user's to jump directly to a specific page within the items. \n\n  This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The pageIndex and totalPages properties are used for this style of paging.","required":["kind","current_item_count","items_per_page","start_index","total_items","page_index","total_pages"],"properties":{"kind":{"$ref":"#/components/schemas/Kind"},"current_item_count":{"title":"Current Item Count","type":"integer","maximum":500,"minimum":0,"description":"The number of items in this result set. Should be equivalent to items.length, and is provided as a convenience property. For example, suppose a developer requests a set of search items, and asks for 10 items per page. The total set of that search has 14 total items. The first page of items will have 10 items in it, so both `items_per_page` and `current_item_count` will equal \"10\". The next page of items will have the remaining 4 items; `items_per_page` will still be \"10\", but `current_item_count` will be \"4\"."},"items_per_page":{"title":"Items Per Page","type":"integer","minimum":0,"maximum":200,"description":"The number of items in the result. This is not necessarily the size of the data.items array; if we are viewing the last page of items, the size of data.items may be less than `items_per_page`. However the size of data.items should not exceed `items_per_page`."},"start_index":{"title":"Start Index","type":"integer","minimum":1,"description":"The index of the first item in data.items. For consistency, `start_index` should be 1-based. For example, the first item in the first set of items should have a `start_index` of 1. If the user requests the next set of data, the `start_index` may be 10."},"total_items":{"title":"Total Items","type":"integer","readOnly":true,"description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0},"page_index":{"title":"Page Index","type":"integer","minimum":1,"description":"The index of the current page of items. For consistency, `page_index` should be 1-based. For example, the first page of items has a `page_index` of 1. `page_index` can also be calculated from the item-based paging properties: `page_index` = floor(`start_index` / `items_per_page`) + 1."},"total_pages":{"title":"Total Pages","type":"integer","minimum":0,"readOnly":true,"description":"The total number of pages in the result set. `total_pages` can also be calculated from the item-based paging properties above: `total_pages` = ceiling(`total_items` / `items_per_page`)"}}},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"LocationListModel":{"title":"Location","description":"Location list model.","allOf":[{"$ref":"#/components/schemas/LocationModel"},{"type":"object","properties":{"location_products":{"title":"Location Products","description":"The products available at this location.","type":"array","items":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string","readOnly":true}}}}]},"LocationModel":{"title":"Location Model","description":"Location model.","type":"object","additionalProperties":false,"properties":{"location_id":{"title":"Location ID","description":"Unique identifier of this location.","type":"string","readOnly":true},"location_label":{"title":"Location Label","description":"The label for this location.","type":"string"},"location_name":{"title":"Location Name","description":"Returns location name.","type":"string"},"location_description":{"title":"Location Description","description":"Optional description of the location.","type":"string"},"location_url":{"title":"Location URL","description":"The location URL.\n\nCan contain additional information about the location, or for example, show a link to an online video-conference.\n","type":"string","format":"URI"},"location_type":{"$ref":"#/components/schemas/LocationType"},"location_address":{"$ref":"#/components/schemas/AddressModel"},"location_contacts":{"title":"Location Contacts","description":"Location contacts.","type":"array","items":{"$ref":"#/components/schemas/ContactDetails"}},"location_opening_times":{"title":"Location Opening Times","description":"Opening times of this location.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimes"}},"location_custom_fields":{"title":"Location Custom Fields","description":"Freeform entry of any key-value pair.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}}},"required":["location_id","location_name","location_type"]},"LocationType":{"title":"Location Type","description":"Type of location.\n\n <details>\n  <summary>**Location Types**</summary>\n\n  * `SHOP` - Location where tickets can be purchased. Generally also offers the ability for customers to get support.\n  * `COMPANY` - Headquarters or similar location. \n  * `PICKUP` - Location where passengers can be picked-up, tour starts or vouchers can be retrieved.\n  * `POI` - Arbitrary Point-of-Interest.\n  * `VENUE` - Venue of the supplier.\n  * `DEPARTURE` - Departure location.\n  * `START` - Starting point of the product / tour.\n  * `END` - Ending point of the product / tour.\n  * `ENTRY` - Entrance of the venue. Generally for large venues which have multiple entrances.\n  * `DESTINATION` - In case of tours or transport.\n  * `MEETING` - Meeting point.\n  * `INFO` - Generally a location where customers can retrieve more information / support.\n  * `STOP` - In case of tours or transport.\n  * `ONLINE` - (UPCOMING) Activity or information is available online. A `location_url` is likely provided.\n  * `STEP` - A step in a certain tour or transport.\n  * `OTHER` - Any type not listed above.\n  * `UNKNOWN` - Type unknown / not set.\n  \n  </details>","type":"string","default":"VENUE","readOnly":true,"enum":["SHOP","COMPANY","PICKUP","POI","VENUE","DEPARTURE","START","END","ENTRY","DESTINATION","MEETING","INFO","STOP","ONLINE","STEP","OTHER","UNKNOWN"]},"AddressModel":{"title":"Address Model","type":"object","description":"Address details.","properties":{"id":{"title":"Address ID","type":"string","format":"uuid","deprecated":true,"readOnly":true,"description":"Unique address identifier."},"name":{"title":"Address Name","description":"Name / Label of this address / addressee.","type":"string"},"street":{"title":"Address Street","description":"Address line 1 / Street.","type":"string"},"addition":{"title":"Address Addition","description":"Additional address line 2.","type":"string"},"city":{"title":"Address City","description":"Town / City / Village.","type":"string"},"postal_code":{"title":"Address Postal Code","description":"Address postal code.","type":"string"},"region":{"title":"Address Region","description":"State / Province / Region.","type":"string"},"country":{"title":"Address Country","description":"Address country.","type":"string"},"country_code":{"title":"Address Country Code","description":"Returns country code of the product ( [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))","type":"string"},"place_id":{"title":"Address Google Place ID","description":"Google Place ID","type":"string"},"latitude":{"title":"Address Latitude","description":"Address latitude.","type":"string"},"longitude":{"title":"Address Longitude","description":"Address longitude.","type":"string"},"notes":{"title":"Address Note","description":"Address note.","type":"string"}}},"ContactDetails":{"title":"Contact Details","description":"Information on the contact.","type":"object","properties":{"contact_uid":{"title":"Contact User Identifier","description":"A unique contact identifier created by Prio. \n\nIn case this field is left blank, a new contact will be created in the system. If you pass an already existing `contact_uid`, those contact details will be  used and linked to the current/future order. In this case all other fields will be ignored.\n> Only applicable for partners using the Contacts Module (Returning guests). For regular transactions this parameter can be safely ignored.","type":"string","format":"uuid"},"contact_external_uid":{"title":"Contact External User Identifier","description":"Unique external identifier of the contact.","type":"string"},"contact_version":{"title":"Contact Version","description":"Contact version; every time the contact details are updated, a new version is registered.","type":"integer","readOnly":true,"default":1,"multipleOf":1},"contact_number":{"title":"Contact Number","description":"Number of the contact.","type":"string","maxLength":50},"contact_type":{"$ref":"#/components/schemas/ContactType"},"contact_title":{"title":"Contact Title","description":"Title prefix of the contact (Mister / Miss / Misses etc).","type":"string"},"contact_name_first":{"title":"Contact First Name","description":"First name of the contact.","type":"string","maxLength":255},"contact_name_last":{"title":"Contact Last Name","description":"Surname of the contact. If you only have the fullname, we recommend sending it as `contact_name_last` and leaving the `contact_name_first` blank.","type":"string","maxLength":255},"contact_email":{"title":"Contact Email","description":"Email address of the contact.","type":"string","format":"email"},"contact_phone":{"title":"Contact Phone","description":"Must be a valid E.164 spec compliant phone number.","type":"string","format":"phone"},"contact_mobile":{"title":"Contact Phone","description":"Must be a valid E.164 spec compliant phone number.","type":"string","format":"phone"},"contact_language":{"title":"Contact Language","type":"string","description":"Language and culture code of the contact preferred language ([ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1))."},"contact_nationality":{"title":"Contact Nationality","description":"Country code of the contact ([ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)).","type":"string"},"contact_flight_number":{"title":"Contact Flight Number","description":"Contact Flight Number.","type":"string"},"contact_loyalty_number":{"title":"Contact Loyalty Number","description":"Contact Loyalty Number.","type":"string"},"contact_birth_place":{"title":"Contact Birth Place","description":"Place of birth.","type":"string"},"contact_birth_date":{"title":"Contact Birth Date","description":"Date of birth.","type":"string","format":"date"},"contact_passport":{"title":"Contact Passport","description":"Passport details of the contact.","type":"string"},"contact_gender":{"title":"Contact Gender","description":"Gender of the contact.","type":"string","enum":["MALE","FEMALE","OTHER"]},"contact_age":{"title":"Contact Age","description":"Age of the contact.","type":"integer","maximum":150},"contact_room_number":{"title":"Contact Room Number","description":"Contact room number.","type":"string"},"contact_website":{"title":"Contact Website","description":"Contact website.","type":"string","format":"URI"},"contact_company":{"$ref":"#/components/schemas/ContactCompany"},"contact_classification":{"$ref":"#/components/schemas/ContactClassification"},"contact_address":{"$ref":"#/components/schemas/AddressModel"},"contact_notes":{"title":"Contact Notes","description":"Contact notes.","type":"array","items":{"$ref":"#/components/schemas/Note"}},"contact_custom_fields":{"title":"Contact Custom Fields","description":"Freeform entry of any key-value pair.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"contact_created":{"title":"Contact Created","description":"Creation date and time of the contact.","type":"string","format":"date-time","readOnly":true},"contact_modified":{"title":"Contact Modified","description":"Last update date and time of the contact.","type":"string","format":"date-time","readOnly":true}},"required":["contact_created","contact_modified"]},"ContactType":{"title":"Contact Type","description":"Type of contact.\n\nSome supplier systems do not support multiple contacts per orders. In that case we have the following policy:\n1. If set, we sent `contact_type:BOOKER`.\n2. Otherwise, if set, we sent the first `contact_type:CONTACT`.\n3. If both are not set, we sent the first contact in the array.\n\n<details>\n  <summary>**Contact Types**</summary>\n\n* `BOOKER` - Main Booker details (End-consumer). Only a single main booker is recommended. \n  \n  This is the most common type of contact, as it contains information about the person / entity who made the booking.\n  \n  > Any automated emails such as order confirmations will be sent to this contact type. \n\n* `CONTACT` - General, non-specific contact. \n\n  Only use this type if a more specific classification is unknown.\n\n* `GUEST` - Guest / End-consumer / Passenger linked to the booking.\n\n  Defining the guests per booking allows for advanced functionality such as Check-In and passenger management.\n\n* `PARTNER` - Partner details.\n* `STAFF` - General staff.\n* `CASHIER` - Cashier performing the sales.\n* `PAYMENT` - Billing / Financial contact. \n\n  > Payment emails will be sent to this contact type by default.\n\n* `AGENT` - Agent details.\n* `EMERGENCY` - Emergency contact (Guest, host, family member etc.).\n* `GUIDE` - Teacher / Instructor / Guide details.\n* `SUPPLIER` - Supplier details.\n* `VENUE` - Venue details.\n* `HOST` - Host details.\n* `COMPANY` - (Guest) company details.\n* `DELIVERY` - (Guest) Delivery / Shipping contact / address details.\n* `MANAGER` - (UPCOMING) Manager contact.\n* `SUPPORT` - (UPCOMING) Support contact.\n* `INSTRUCTOR` - (UPCOMING) Instructor contact.\n* `OTHER` - Other type of contact, not mentioned above.\n</details>","type":"string","default":"CONTACT","enum":["BOOKER","CONTACT","GUEST","PARTNER","STAFF","CASHIER","PAYMENT","AGENT","EMERGENCY","GUIDE","SUPPLIER","VENUE","HOST","COMPANY","DELIVERY","OTHER"]},"ContactCompany":{"title":"Contact Company","description":"Contact company details.","type":"object","properties":{"company_name":{"title":"Company Name","description":"Company name.","type":"string"},"company_registration_number":{"title":"Company Registration Number","description":"Company registration number.","type":"string"},"company_tax_number":{"title":"Company Tax Number","description":"Company tax number.","type":"string"}}},"ContactClassification":{"title":"Contact Classification","description":"Contact classification.","type":"string","enum":["IMPORTANT","VERY_IMPORTANT","PROBLEMATIC","DISABLED_PERSON","TOP_MANAGEMENT","STAFF","LOYALTY_PROGRAM","MEDIA","FRIEND_OR_FAMILY","RETURNING","PERSONAL","BUSINESS"]},"Note":{"title":"Note","description":"Details on the note.","type":"object","properties":{"note_value":{"title":"Note Value","description":"Note value.","type":"string"},"note_created":{"title":"Note Date","description":"Creation / Modification date of the note.","type":"string","format":"date-time","readOnly":true},"note_recipients":{"title":"Note Recipients","description":"List of accounts that are able to view the note.","type":"array","items":{"title":"Note Recipient","type":"string","description":"Account type of the users receiving / being able to view the note. \n\nFor example when sending a note from the distributor to the supplier, this will indicate the recipient (supplier).\n<details>\n  <summary>**Account Types**</summary>\n  \n  * `GUEST` - Note visible to the guest.\n  \n  * `PARTNER` - Note visible to the partner.\n\n  * `SUPPLIER` - Note visible to the supplier.\n  \n  * `RESELLER` - Note visible to the reseller / supplier admin.\n  \n  * `DISTRIBUTOR` - Note visible to the distributor.\n  \n</details>\n","enum":["GUEST","PARTNER","SUPPLIER","RESELLER","DISTRIBUTOR"]}},"note_creator_account_type":{"title":"Note Creator Account Type","type":"string","description":"Account type of the user who created the note. \n\nFor example when sending a note from the distributor to the supplier, this will indicate the sender (e.g distributor).\n<details>\n  <summary>**Account Types**</summary>\n\n  * `GUEST` - Note created by the guest.\n  \n  * `PARTNER` - Note created by the partner.\n\n  * `SUPPLIER` - Note created by the supplier.\n  \n  * `DISTRIBUTOR` - Note created by the distributor.\n  \n  * `RESELLER` - Note created by the reseller / supplier admin.\n  \n  * `PLATFORM_ADMIN` - Note created by the platform-admin.\n  \n  * `SUPER_ADMIN` - Note created by the super-admin.\n\n</details>\n","enum":["GUEST","PARTNER","SUPPLIER","RESELLER","DISTRIBUTOR"]},"note_creator_user_name":{"title":"Note Creator User Name","type":"string","description":"Name of the user that created this note.","readOnly":true},"note_creator_user_email":{"title":"Note Creator User Email","type":"string","description":"Email of the user that created this note.","readOnly":true},"note_creator_user_role":{"title":"Note Creator User Role","type":"string","description":"Userrole (name) of the user that created this note.","readOnly":true}},"required":["note_value","note_recipients"]},"CustomField":{"title":"Custom Field","type":"object","description":"Custom Fields allow you to store and list any arbitrary value in the system.\n\nThis metadata are data elements that you create yourself. When you add metadata to your request, they are echoed in the response so that you can connect the transaction to your metadata. For example, to add a shift number and an employee ID to a transaction. You are free to create metadata fields, even encoded, as long as the datatype is a string.","properties":{"custom_field_name":{"title":"Custom Field Name","type":"string","description":"Unique Name / Identifier for this field."},"custom_field_value":{"title":"Custom Field Value","type":"string","description":"Freeform value of this field."},"custom_field_type":{"$ref":"#/components/schemas/CustomFieldType"}}},"CustomFieldType":{"title":"Custom Field Type","type":"string","deprecated":true,"description":"Custom Field Type:\n  * `SYSTEM` - This field is only stored and returned in the API. Only visible to the system.\n  * `USER` - This value is stored and visualized, can be shown in a customized fashion in other modules.","enum":["SYSTEM","USER"]},"OpeningTimes":{"title":"Opening Times","description":"Opening times.","type":"object","additionalProperties":false,"properties":{"opening_time_valid_from":{"title":"Opening Time Valid From","description":"Opening time valid from.","type":"string","format":"date"},"opening_time_valid_till":{"title":"Opening Time Valid Till","description":"Opening time valid till.","type":"string","format":"date"},"opening_time_details":{"title":"Opening Time Details","description":"Opening Time Details, based on the days of the week. If unset, the product / venue can be deemed unavailable / closed.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimeDetail"}}},"required":["opening_time_details"]},"OpeningTimeDetail":{"title":"Opening Time Detail","description":"Opening time details.","type":"object","additionalProperties":false,"properties":{"opening_time_day":{"$ref":"#/components/schemas/DayOfTheWeek"},"opening_time_start":{"title":"Opening Time Start","description":"Starting time of a venue for a particular day.","type":"string","format":"time"},"opening_time_end":{"title":"Opening Time End","description":"Closing time of a venue for a particular day.","type":"string","format":"time"}},"required":["opening_time_day"]},"DayOfTheWeek":{"title":"Day Of The Week","description":"Day of the a week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/locations":{"get":{"description":"Retrieve a list of all available product locations linked to your account. \n\nLocations represent physical or virtual places where products (such as tickets or experiences) are offered. These can include cities, landmarks, or specific venues, and help in organizing and filtering products geographically.","summary":"List Product Locations","tags":["Products"],"operationId":"getProductLocations","parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"$ref":"#/components/parameters/ProductID"},{"$ref":"#/components/parameters/ItemsPerPage"},{"$ref":"#/components/parameters/StartIndex"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Location List Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationListResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```

## List Product Destinations

> Retrieve a list of all available product destinations linked to your account. \
> \
> Destinations are high-level geographic or thematic groupings, such as cities, regions, or popular areas, used to categorize and organize products. They help users discover experiences based on broader travel intents or well-known travel hubs.

```json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"ItemsPerPage":{"name":"items_per_page","in":"query","required":false,"description":"[PAGING] Items Per Page - Allows user's to configure the `items_per_page` value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.  \n\nThis parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.  \n\nClients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the `items_per_page` response element in calculating actual page size.","schema":{"type":"integer","minimum":1,"maximum":200,"default":10}},"StartIndex":{"name":"start_index","in":"query","required":false,"description":"[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.","schema":{"type":"integer","minimum":1,"default":1,"maximum":10000}},"Page":{"name":"page","in":"query","required":false,"description":"[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items. \nThis is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The `page_index` and `total_pages` properties are used for this style of paging.","schema":{"type":"integer","minimum":1,"default":1}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"ProductDestinationsResponse":{"title":"Product Destination Response","type":"object","description":"Product destination list response.","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/ProductDestinationsResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"ProductDestinationsResponseData":{"title":"Product Destinations Response Data","description":"Product destinations response data.","type":"object","allOf":[{"$ref":"#/components/schemas/ReservedPaginationData"},{"type":"object","properties":{"items":{"title":"Destinations","type":"array","items":{"$ref":"#/components/schemas/ProductDestinationModel"}}},"required":["total_items","items"]}]},"ReservedPaginationData":{"title":"Reserved Pagination Data","type":"object","description":"The following properties are located in the data object, and help page through a list of items.\nThe paging properties below allow for various styles of paging, including:\n+ Previous/Next paging - Allows user's to move forward and backward through a list, one page at a time. The nextLink and previousLink properties (described in the \"Reserved Property Names for Links\" section below) are used for this style of paging.\n+ Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?startIndex=200.\n+ Page-based paging - Allows user's to jump directly to a specific page within the items. \n\n  This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The pageIndex and totalPages properties are used for this style of paging.","required":["kind","current_item_count","items_per_page","start_index","total_items","page_index","total_pages"],"properties":{"kind":{"$ref":"#/components/schemas/Kind"},"current_item_count":{"title":"Current Item Count","type":"integer","maximum":500,"minimum":0,"description":"The number of items in this result set. Should be equivalent to items.length, and is provided as a convenience property. For example, suppose a developer requests a set of search items, and asks for 10 items per page. The total set of that search has 14 total items. The first page of items will have 10 items in it, so both `items_per_page` and `current_item_count` will equal \"10\". The next page of items will have the remaining 4 items; `items_per_page` will still be \"10\", but `current_item_count` will be \"4\"."},"items_per_page":{"title":"Items Per Page","type":"integer","minimum":0,"maximum":200,"description":"The number of items in the result. This is not necessarily the size of the data.items array; if we are viewing the last page of items, the size of data.items may be less than `items_per_page`. However the size of data.items should not exceed `items_per_page`."},"start_index":{"title":"Start Index","type":"integer","minimum":1,"description":"The index of the first item in data.items. For consistency, `start_index` should be 1-based. For example, the first item in the first set of items should have a `start_index` of 1. If the user requests the next set of data, the `start_index` may be 10."},"total_items":{"title":"Total Items","type":"integer","readOnly":true,"description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0},"page_index":{"title":"Page Index","type":"integer","minimum":1,"description":"The index of the current page of items. For consistency, `page_index` should be 1-based. For example, the first page of items has a `page_index` of 1. `page_index` can also be calculated from the item-based paging properties: `page_index` = floor(`start_index` / `items_per_page`) + 1."},"total_pages":{"title":"Total Pages","type":"integer","minimum":0,"readOnly":true,"description":"The total number of pages in the result set. `total_pages` can also be calculated from the item-based paging properties above: `total_pages` = ceiling(`total_items` / `items_per_page`)"}}},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"ProductDestinationModel":{"title":"Destination","description":"Destination details.","type":"object","additionalProperties":false,"properties":{"destination_id":{"title":"Destination ID","description":"Unique destination identifier.","type":"string","readOnly":true},"destination_parent_id":{"title":"Destination Parent ID","description":"Unique destination parent identifier.","type":"string","readOnly":true},"destination_name":{"title":"Destination Name","description":"Destination name.","type":"string"},"destination_slug":{"title":"Destination Slug","description":"SEO friendly slug which can be used during URL building.","type":"string"},"destination_description":{"title":"Destination Description","description":"Destination description.","type":"string"},"destination_images":{"title":"Destination Images","description":"It contains images related to the destination.","type":"array","items":{"$ref":"#/components/schemas/Image"}},"destination_products":{"title":"Destination Products.","description":"The products available in this destination.","type":"array","items":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string","readOnly":true}}},"required":["destination_id","destination_name","destination_images","destination_products"]},"Image":{"title":"Image","description":"Details on the image.","type":"object","additionalProperties":false,"properties":{"image_type":{"title":"Product Image Type","description":"Product image type.","type":"string","enum":["BANNER","MAIN","DETAIL","THUMBNAIL"]},"image_url":{"title":"Image URL","description":"Image URL.","type":"string","format":"uri"}},"required":["image_type","image_url"]},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/destinations":{"get":{"description":"Retrieve a list of all available product destinations linked to your account. \n\nDestinations are high-level geographic or thematic groupings, such as cities, regions, or popular areas, used to categorize and organize products. They help users discover experiences based on broader travel intents or well-known travel hubs.","summary":"List Product Destinations","tags":["Products"],"operationId":"getProductDestinations","parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"name":"destination_id","in":"query","explode":false,"style":"form","required":false,"description":"[FILTER] on destination (`destination_id`).","schema":{"title":"Destination IDs","description":"Destination IDs.","type":"array","items":{"title":"Destination ID","description":"Destination ID.","type":"string"}}},{"$ref":"#/components/parameters/ItemsPerPage"},{"$ref":"#/components/parameters/StartIndex"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product Destination Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDestinationsResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```

## List Product Categories

> Retrieve a list of all available product categories associated with your account. \
> \
> \
> Categories represent thematic groupings, such as "Museums", "Tours", or "Outdoor Activities", used to classify products based on the type of experience they offer. They support intuitive browsing, filtering, and product discovery.

```json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"DistributorProductCategoriesResponse":{"title":"Product Categories Response","type":"object","description":"Product category list response.","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/DistributorProductCategoriesResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"DistributorProductCategoriesResponseData":{"title":"Distributor Product Categories Response Data","description":"Distributor product categories response data.","type":"object","properties":{"kind":{"$ref":"#/components/schemas/Kind"},"total_items":{"$ref":"#/components/schemas/TotalItems"},"items":{"title":"Categories","type":"array","items":{"$ref":"#/components/schemas/CategoryModel"}}},"required":["kind","total_items","items"]},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"TotalItems":{"title":"Total Items","type":"integer","description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0,"maximum":500,"readOnly":true},"CategoryModel":{"title":"Category","description":"Category details.","type":"object","additionalProperties":false,"properties":{"category_id":{"title":"Category ID","description":"Unique category identifier.","type":"string","readOnly":true},"category_name":{"title":"Category Name","description":"Category name.","type":"string"},"category_description":{"title":"Category Description","description":"Category description.","type":"string"},"category_parent_id":{"title":"Category Parent ID","description":"Optional parent category.","type":"string"},"category_type":{"title":"Category Type","description":"Category type.","type":"string","enum":["SYSTEM","RESELLER","MERCHANDISE"]},"category_slug":{"title":"Category Slug","description":"SEO friendly slug which can be used during URL building.","type":"string"},"category_icon":{"title":"Category Icon","description":"URL which points to category icon.","type":"string","format":"uri"},"category_images":{"title":"Category Images","description":"It contains images related to the category.","type":"array","items":{"$ref":"#/components/schemas/Image"}},"category_products":{"title":"Category Products.","description":"The products available in this category.","type":"array","items":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string","readOnly":true}}},"required":["category_id","category_name","category_type"]},"Image":{"title":"Image","description":"Details on the image.","type":"object","additionalProperties":false,"properties":{"image_type":{"title":"Product Image Type","description":"Product image type.","type":"string","enum":["BANNER","MAIN","DETAIL","THUMBNAIL"]},"image_url":{"title":"Image URL","description":"Image URL.","type":"string","format":"uri"}},"required":["image_type","image_url"]},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/categories":{"get":{"description":"Retrieve a list of all available product categories associated with your account. \n\n\nCategories represent thematic groupings, such as \"Museums\", \"Tours\", or \"Outdoor Activities\", used to classify products based on the type of experience they offer. They support intuitive browsing, filtering, and product discovery.","summary":"List Product Categories","tags":["Products"],"operationId":"getProductCategories","parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"name":"category_id","in":"query","explode":false,"style":"form","required":false,"description":"[FILTER] on categories (`category_id`).","schema":{"title":"Category IDs","description":"Category IDs.","type":"array","items":{"title":"Category ID","description":"Category ID.","type":"string"}}},{"name":"category_type","in":"query","required":false,"style":"form","explode":false,"description":"[FILTER] on Category Type (`category_type`).","schema":{"title":"Category Types","description":"Category types.","type":"array","items":{"title":"Category Type","description":"Category type.","type":"string","enum":["SYSTEM","RESELLER","MERCHANDISE"]}}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product Category Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributorProductCategoriesResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```

## List Product Recommendations

> Retrieve product recommendations tailored to enhance user experience. \
> \
> Recommendations help suggest related or popular products, often based on business rules, location, or user behavior.

```json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"DistributorProductRecommendationsResponse":{"title":"Product Recommendations Response","type":"object","description":"Product recommendations list response.","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/DistributorProductRecommendationsResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"DistributorProductRecommendationsResponseData":{"title":"Distributor Product Recommendations Response Data","description":"Distributor product recommendations response data.","type":"object","properties":{"kind":{"$ref":"#/components/schemas/Kind"},"total_items":{"$ref":"#/components/schemas/TotalItems"},"items":{"title":"Categories","type":"array","items":{"$ref":"#/components/schemas/RecommendationModel"}}},"required":["kind","total_items","items"]},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"TotalItems":{"title":"Total Items","type":"integer","description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0,"maximum":500,"readOnly":true},"RecommendationModel":{"title":"Recommendation","description":"Recommendation details.","type":"object","additionalProperties":false,"properties":{"recommendation_id":{"title":"Recommendation ID","description":"Unique recommendation identifier.","type":"string","readOnly":true},"recommendation_title":{"title":"Recommendation Title","description":"Recommendation name.","type":"string"},"recommendation_description":{"title":"Recommendation Description","description":"Recommendation description.","type":"string"},"recommendation_start_date":{"title":"Recommendation Start Date","description":"Start date on which this recommendation becomes visible.","type":"string","format":"date-time"},"recommendation_end_date":{"title":"Recommendation End Date","description":"End date for this recommendation.","type":"string","format":"date-time"},"recommendation_products":{"title":"Recommendation Products.","description":"The products available in this recommendation.","type":"array","items":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string","readOnly":true}}},"required":["recommendation_id","recommendation_name","recommendation_products"]},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/recommendations":{"get":{"description":"Retrieve product recommendations tailored to enhance user experience. \n\nRecommendations help suggest related or popular products, often based on business rules, location, or user behavior.","summary":"List Product Recommendations","tags":["Products"],"operationId":"getProductRecommendations","parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product Recommendation Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributorProductRecommendationsResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```

## List Product Routes

> Retrieve all available routes associated with your account. \
> \
> Routes define the transportation or itinerary structure of a product, typically used in activities like hop-on hop-off buses, boat tours, or guided trips with fixed paths.

```json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"ProductID":{"name":"product_id","in":"query","required":false,"description":"[FILTER] on `product_id`.","schema":{"type":"string"}},"ItemsPerPage":{"name":"items_per_page","in":"query","required":false,"description":"[PAGING] Items Per Page - Allows user's to configure the `items_per_page` value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.  \n\nThis parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.  \n\nClients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the `items_per_page` response element in calculating actual page size.","schema":{"type":"integer","minimum":1,"maximum":200,"default":10}},"StartIndex":{"name":"start_index","in":"query","required":false,"description":"[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.","schema":{"type":"integer","minimum":1,"default":1,"maximum":10000}},"Page":{"name":"page","in":"query","required":false,"description":"[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items. \nThis is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The `page_index` and `total_pages` properties are used for this style of paging.","schema":{"type":"integer","minimum":1,"default":1}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"RoutesListResponse":{"title":"Routes List Response","type":"object","description":"Routes list response.","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/RoutesListResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"RoutesListResponseData":{"title":"Routes List Response Data","description":"Routes list response data.","type":"object","allOf":[{"$ref":"#/components/schemas/ReservedPaginationData"},{"type":"object","properties":{"items":{"title":"Routes","description":"Routes.","type":"array","items":{"$ref":"#/components/schemas/RouteModel"}}},"required":["total_items","items"]}]},"ReservedPaginationData":{"title":"Reserved Pagination Data","type":"object","description":"The following properties are located in the data object, and help page through a list of items.\nThe paging properties below allow for various styles of paging, including:\n+ Previous/Next paging - Allows user's to move forward and backward through a list, one page at a time. The nextLink and previousLink properties (described in the \"Reserved Property Names for Links\" section below) are used for this style of paging.\n+ Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?startIndex=200.\n+ Page-based paging - Allows user's to jump directly to a specific page within the items. \n\n  This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The pageIndex and totalPages properties are used for this style of paging.","required":["kind","current_item_count","items_per_page","start_index","total_items","page_index","total_pages"],"properties":{"kind":{"$ref":"#/components/schemas/Kind"},"current_item_count":{"title":"Current Item Count","type":"integer","maximum":500,"minimum":0,"description":"The number of items in this result set. Should be equivalent to items.length, and is provided as a convenience property. For example, suppose a developer requests a set of search items, and asks for 10 items per page. The total set of that search has 14 total items. The first page of items will have 10 items in it, so both `items_per_page` and `current_item_count` will equal \"10\". The next page of items will have the remaining 4 items; `items_per_page` will still be \"10\", but `current_item_count` will be \"4\"."},"items_per_page":{"title":"Items Per Page","type":"integer","minimum":0,"maximum":200,"description":"The number of items in the result. This is not necessarily the size of the data.items array; if we are viewing the last page of items, the size of data.items may be less than `items_per_page`. However the size of data.items should not exceed `items_per_page`."},"start_index":{"title":"Start Index","type":"integer","minimum":1,"description":"The index of the first item in data.items. For consistency, `start_index` should be 1-based. For example, the first item in the first set of items should have a `start_index` of 1. If the user requests the next set of data, the `start_index` may be 10."},"total_items":{"title":"Total Items","type":"integer","readOnly":true,"description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0},"page_index":{"title":"Page Index","type":"integer","minimum":1,"description":"The index of the current page of items. For consistency, `page_index` should be 1-based. For example, the first page of items has a `page_index` of 1. `page_index` can also be calculated from the item-based paging properties: `page_index` = floor(`start_index` / `items_per_page`) + 1."},"total_pages":{"title":"Total Pages","type":"integer","minimum":0,"readOnly":true,"description":"The total number of pages in the result set. `total_pages` can also be calculated from the item-based paging properties above: `total_pages` = ceiling(`total_items` / `items_per_page`)"}}},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"RouteModel":{"title":"Route Model","type":"object","additionalProperties":false,"properties":{"route_active":{"title":"Route Active","type":"boolean","default":true,"description":"Whether this route should be shown."},"route_id":{"title":"Route ID","type":"string","description":"Unique identifier of this route."},"route_name":{"title":"Route Name","description":"Returns route name.","type":"string"},"route_description":{"title":"Route Description","type":"string","description":"Description of the route."},"route_color":{"title":"Route Color","description":"Returns the color of this route. (HEX)","type":"string"},"route_type":{"title":"Route Type","description":"The type of route.","type":"string","enum":["DRIVING","WALKING","BICYCLING","TRANSIT","BOAT","OTHER"]},"route_start_time":{"title":"Route Start Time","type":"string","description":"The starting time of the route."},"route_end_time":{"title":"Route End Time","type":"string","description":"The end time of the route."},"route_duration":{"title":"Route Duration","description":"The duration of the route (in minutes).","type":"integer"},"route_frequency":{"title":"Route Frequency","description":"Returns the \"loop\" frequency of this route.","type":"integer"},"route_audio_languages":{"title":"Route Audio Languages","description":"The audio languages available on this route. Language is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","type":"array","items":{"title":"Route Audio Language","type":"string"}},"route_live_languages":{"title":"Route Live Languages","description":"The guide languages available on this route. Language is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","type":"array","items":{"title":"Route Live Language","type":"string"}},"route_products":{"title":"Route Products","description":"List of applicable products on this route.","type":"array","items":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string","readOnly":true}},"route_locations":{"title":"Route Locations","type":"array","description":"Specifies an array of directional waypoints. Waypoints alter a route by routing it through the specified location(s).","items":{"$ref":"#/components/schemas/RouteLocation"}}},"required":["route_id","route_active","route_name"]},"RouteLocation":{"title":"Route Location","type":"object","additionalProperties":false,"properties":{"route_location_active":{"title":"Route Location Active","type":"boolean","description":"Whether this location is active."},"route_location_id":{"title":"Route Location ID","type":"string","description":"The unique location ID."},"route_location_name":{"title":"Route Location Name","type":"string","description":"The name of the location."},"route_location_description":{"title":"Route Location Description","type":"string","description":"The description of the location."},"route_location_url":{"title":"Route Location URL","type":"string","format":"uri","description":"Additional information about this location."},"route_location_latitude":{"title":"Route Location Latitude","description":"Route location latitude.","type":"string"},"route_location_longitude":{"title":"Route Location Longitude","description":"Route location longitude.","type":"string"},"route_location_stopover":{"title":"Route Location Stopover","type":"boolean","description":"A boolean which indicates that the waypoint is a stop on the route, which has the effect of showing it as a destination."}},"required":["route_location_id","route_location_active","route_location_name"]},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/routes":{"get":{"description":"Retrieve all available routes associated with your account. \n\nRoutes define the transportation or itinerary structure of a product, typically used in activities like hop-on hop-off buses, boat tours, or guided trips with fixed paths.","summary":"List Product Routes","tags":["Products"],"operationId":"getProductRoutes","parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"$ref":"#/components/parameters/ProductID"},{"$ref":"#/components/parameters/ItemsPerPage"},{"$ref":"#/components/parameters/StartIndex"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product Routes Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutesListResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```

## List Product Currency Rates

> This API returns all the currency rates on a daily basis.

```json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"DistributorCurrencyRatesResponse":{"title":"Currency Rates Response","type":"object","description":"Product currency list response.","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/DistributorCurrencyRatesResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"DistributorCurrencyRatesResponseData":{"title":"Currency Rates Response Data","description":"Currency rates response data.","type":"object","properties":{"kind":{"$ref":"#/components/schemas/Kind"},"total_items":{"$ref":"#/components/schemas/TotalItems"},"items":{"title":"Currency Rates","type":"array","items":{"$ref":"#/components/schemas/CurrencyConversion"}}},"required":["kind","total_items","items"]},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"TotalItems":{"title":"Total Items","type":"integer","description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0,"maximum":500,"readOnly":true},"CurrencyConversion":{"title":"Currency Conversion","description":"Conversion rates for a specific currency.","type":"object","required":["curreny_base","currency_date","currency_rates"],"properties":{"currency_base":{"title":"Currency Base","type":"string","description":"Currency base code, according to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217)."},"currency_date":{"title":"Currency Date","type":"string","format":"date","description":"Applicable date for these rates."},"currency_rates":{"title":"Currency Rates","type":"object","description":"Conversion rate for each foreign currency.","additionalProperties":{"title":"Currency Rate","type":"string","description":"Conversion rate for this foreign currency."}}}},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/currency_rates":{"get":{"description":"This API returns all the currency rates on a daily basis.","summary":"List Product Currency Rates","tags":["Products"],"operationId":"getCurrencyRates","parameters":[{"name":"currency_date","in":"query","required":true,"description":"[FILTER] on `currency_date`.","schema":{"type":"string","format":"date"}},{"name":"currency_base","in":"query","required":false,"description":"[FILTER] on `currency_base`.","schema":{"title":"Currency Base Code","description":"Currency Base Code, according to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","type":"string"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product Currency Rates Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributorCurrencyRatesResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```

## List Product Taxes

> Retrieve tax configurations applicable to your products. \
> \
> Taxes can be region-specific and vary by product type, helping ensure accurate pricing and compliance.

```json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"ProductID":{"name":"product_id","in":"query","required":false,"description":"[FILTER] on `product_id`.","schema":{"type":"string"}},"ItemsPerPage":{"name":"items_per_page","in":"query","required":false,"description":"[PAGING] Items Per Page - Allows user's to configure the `items_per_page` value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.  \n\nThis parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.  \n\nClients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the `items_per_page` response element in calculating actual page size.","schema":{"type":"integer","minimum":1,"maximum":200,"default":10}},"StartIndex":{"name":"start_index","in":"query","required":false,"description":"[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.","schema":{"type":"integer","minimum":1,"default":1,"maximum":10000}},"Page":{"name":"page","in":"query","required":false,"description":"[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items. \nThis is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The `page_index` and `total_pages` properties are used for this style of paging.","schema":{"type":"integer","minimum":1,"default":1}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"DistributorProductTaxesResponse":{"title":"Product Taxes Response","type":"object","description":"Product tax list response.","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/DistributorProductTaxesResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"DistributorProductTaxesResponseData":{"title":"Distributor Product Taxes Response Data","description":"Distributor product taxes response data.","type":"object","allOf":[{"$ref":"#/components/schemas/ReservedPaginationData"},{"type":"object","properties":{"items":{"title":"Product Taxes","type":"array","items":{"$ref":"#/components/schemas/ProductTaxDetail"}}}}]},"ReservedPaginationData":{"title":"Reserved Pagination Data","type":"object","description":"The following properties are located in the data object, and help page through a list of items.\nThe paging properties below allow for various styles of paging, including:\n+ Previous/Next paging - Allows user's to move forward and backward through a list, one page at a time. The nextLink and previousLink properties (described in the \"Reserved Property Names for Links\" section below) are used for this style of paging.\n+ Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?startIndex=200.\n+ Page-based paging - Allows user's to jump directly to a specific page within the items. \n\n  This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The pageIndex and totalPages properties are used for this style of paging.","required":["kind","current_item_count","items_per_page","start_index","total_items","page_index","total_pages"],"properties":{"kind":{"$ref":"#/components/schemas/Kind"},"current_item_count":{"title":"Current Item Count","type":"integer","maximum":500,"minimum":0,"description":"The number of items in this result set. Should be equivalent to items.length, and is provided as a convenience property. For example, suppose a developer requests a set of search items, and asks for 10 items per page. The total set of that search has 14 total items. The first page of items will have 10 items in it, so both `items_per_page` and `current_item_count` will equal \"10\". The next page of items will have the remaining 4 items; `items_per_page` will still be \"10\", but `current_item_count` will be \"4\"."},"items_per_page":{"title":"Items Per Page","type":"integer","minimum":0,"maximum":200,"description":"The number of items in the result. This is not necessarily the size of the data.items array; if we are viewing the last page of items, the size of data.items may be less than `items_per_page`. However the size of data.items should not exceed `items_per_page`."},"start_index":{"title":"Start Index","type":"integer","minimum":1,"description":"The index of the first item in data.items. For consistency, `start_index` should be 1-based. For example, the first item in the first set of items should have a `start_index` of 1. If the user requests the next set of data, the `start_index` may be 10."},"total_items":{"title":"Total Items","type":"integer","readOnly":true,"description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0},"page_index":{"title":"Page Index","type":"integer","minimum":1,"description":"The index of the current page of items. For consistency, `page_index` should be 1-based. For example, the first page of items has a `page_index` of 1. `page_index` can also be calculated from the item-based paging properties: `page_index` = floor(`start_index` / `items_per_page`) + 1."},"total_pages":{"title":"Total Pages","type":"integer","minimum":0,"readOnly":true,"description":"The total number of pages in the result set. `total_pages` can also be calculated from the item-based paging properties above: `total_pages` = ceiling(`total_items` / `items_per_page`)"}}},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"ProductTaxDetail":{"title":"Product Tax Detail","description":"Product Tax Detail.","type":"object","readOnly":true,"required":["tax_id","tax_name","tax_type","tax_rate"],"properties":{"tax_id":{"title":"Tax ID","type":"string","description":"Unique identifier of this tax configuration.","readOnly":true},"tax_name":{"title":"Tax Name","description":"Name of the tax.","type":"string","readOnly":true},"tax_type":{"title":"Tax Type","description":"Tax abbreviation.","type":"string","readOnly":true},"tax_rate":{"title":"Tax Rate","description":"Tax rate (percentage).","type":"string","readOnly":true},"tax_region":{"title":"Tax Region","description":"Country or State of the related tax authority.","type":"string","readOnly":true},"tax_lines":{"$ref":"#/components/schemas/TaxLines"}}},"TaxLines":{"title":"Tax Lines","type":"object","description":"Additional tax lines.","properties":{"tax_lines_id":{"title":"Tax Lines ID","description":"Tax lines ID.","type":"string"},"tax_line_name":{"title":"Tax Line Name","description":"Name of the tax line.","type":"string"},"tax_line_type":{"title":"Tax Line Type","type":"string","description":"Tax abbreviation."},"tax_line_rate":{"title":"Tax Line Rate","type":"string","description":"Tax rate (percentage)."},"tax_line_region":{"title":"Tax Line Region","description":"Country or State of the related tax authority.","type":"string"}}},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/taxes":{"get":{"description":"Retrieve tax configurations applicable to your products. \n\nTaxes can be region-specific and vary by product type, helping ensure accurate pricing and compliance.","summary":"List Product Taxes","tags":["Products"],"operationId":"getProductTaxes","parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"$ref":"#/components/parameters/ProductID"},{"name":"tax_region","in":"query","required":false,"description":"[FILTER] on `tax_region`.","schema":{"title":"Tax Region","description":"Country or State of the related tax authority.","type":"string"}},{"$ref":"#/components/parameters/ItemsPerPage"},{"$ref":"#/components/parameters/StartIndex"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product Tax Rates Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributorProductTaxesResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```

## List Products

> Retrieve a comprehensive list of all products available via your distributor account. Each product includes core metadata like title, description, availability, and configuration details.\
> Extensive filtering is available but do note that certain filters might affect performance.\
> \> By default only the latest revision will be returned.

````json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"ItemsPerPage":{"name":"items_per_page","in":"query","required":false,"description":"[PAGING] Items Per Page - Allows user's to configure the `items_per_page` value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.  \n\nThis parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.  \n\nClients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the `items_per_page` response element in calculating actual page size.","schema":{"type":"integer","minimum":1,"maximum":200,"default":10}},"StartIndex":{"name":"start_index","in":"query","required":false,"description":"[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.","schema":{"type":"integer","minimum":1,"default":1,"maximum":10000}},"Page":{"name":"page","in":"query","required":false,"description":"[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items. \nThis is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The `page_index` and `total_pages` properties are used for this style of paging.","schema":{"type":"integer","minimum":1,"default":1}},"Cache":{"name":"cache","in":"query","required":false,"description":"[CACHE] Whether the results should be loaded from the caching server. This will significantly improve performance and disabling this functionality is not recommended.","schema":{"title":"Cache","type":"boolean","default":true}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"schemas":{"CustomField":{"title":"Custom Field","type":"object","description":"Custom Fields allow you to store and list any arbitrary value in the system.\n\nThis metadata are data elements that you create yourself. When you add metadata to your request, they are echoed in the response so that you can connect the transaction to your metadata. For example, to add a shift number and an employee ID to a transaction. You are free to create metadata fields, even encoded, as long as the datatype is a string.","properties":{"custom_field_name":{"title":"Custom Field Name","type":"string","description":"Unique Name / Identifier for this field."},"custom_field_value":{"title":"Custom Field Value","type":"string","description":"Freeform value of this field."},"custom_field_type":{"$ref":"#/components/schemas/CustomFieldType"}}},"CustomFieldType":{"title":"Custom Field Type","type":"string","deprecated":true,"description":"Custom Field Type:\n  * `SYSTEM` - This field is only stored and returned in the API. Only visible to the system.\n  * `USER` - This value is stored and visualized, can be shown in a customized fashion in other modules.","enum":["SYSTEM","USER"]},"ProductListResponse":{"title":"Product List Response","description":"Product list response.","type":"object","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/ProductListResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"ProductListResponseData":{"title":"Product List Response Data","description":"Product list response data.","allOf":[{"$ref":"#/components/schemas/ReservedPaginationData"},{"type":"object","properties":{"items":{"title":"Products","description":"Returns a list of all products.","type":"array","items":{"$ref":"#/components/schemas/ProductModel"}}},"required":["items"]}]},"ReservedPaginationData":{"title":"Reserved Pagination Data","type":"object","description":"The following properties are located in the data object, and help page through a list of items.\nThe paging properties below allow for various styles of paging, including:\n+ Previous/Next paging - Allows user's to move forward and backward through a list, one page at a time. The nextLink and previousLink properties (described in the \"Reserved Property Names for Links\" section below) are used for this style of paging.\n+ Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?startIndex=200.\n+ Page-based paging - Allows user's to jump directly to a specific page within the items. \n\n  This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The pageIndex and totalPages properties are used for this style of paging.","required":["kind","current_item_count","items_per_page","start_index","total_items","page_index","total_pages"],"properties":{"kind":{"$ref":"#/components/schemas/Kind"},"current_item_count":{"title":"Current Item Count","type":"integer","maximum":500,"minimum":0,"description":"The number of items in this result set. Should be equivalent to items.length, and is provided as a convenience property. For example, suppose a developer requests a set of search items, and asks for 10 items per page. The total set of that search has 14 total items. The first page of items will have 10 items in it, so both `items_per_page` and `current_item_count` will equal \"10\". The next page of items will have the remaining 4 items; `items_per_page` will still be \"10\", but `current_item_count` will be \"4\"."},"items_per_page":{"title":"Items Per Page","type":"integer","minimum":0,"maximum":200,"description":"The number of items in the result. This is not necessarily the size of the data.items array; if we are viewing the last page of items, the size of data.items may be less than `items_per_page`. However the size of data.items should not exceed `items_per_page`."},"start_index":{"title":"Start Index","type":"integer","minimum":1,"description":"The index of the first item in data.items. For consistency, `start_index` should be 1-based. For example, the first item in the first set of items should have a `start_index` of 1. If the user requests the next set of data, the `start_index` may be 10."},"total_items":{"title":"Total Items","type":"integer","readOnly":true,"description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0},"page_index":{"title":"Page Index","type":"integer","minimum":1,"description":"The index of the current page of items. For consistency, `page_index` should be 1-based. For example, the first page of items has a `page_index` of 1. `page_index` can also be calculated from the item-based paging properties: `page_index` = floor(`start_index` / `items_per_page`) + 1."},"total_pages":{"title":"Total Pages","type":"integer","minimum":0,"readOnly":true,"description":"The total number of pages in the result set. `total_pages` can also be calculated from the item-based paging properties above: `total_pages` = ceiling(`total_items` / `items_per_page`)"}}},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"ProductModel":{"title":"Product Model","description":"Product model.","type":"object","additionalProperties":false,"properties":{"product_id":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string","readOnly":true},"product_external_id":{"title":"Product External ID","description":"Unique identifier for the product assigned by the third party.","type":"string"},"product_internal_reference":{"title":"Product Internal Reference","description":"Internal Reference / SKU for the product.","type":"string"},"product_platform_id":{"title":"Product Platform ID","description":"Unique identifier of the platform.","type":"string","deprecated":true,"readOnly":true},"product_platform_name":{"title":"Product Platform Name","description":"Name of the platform.","type":"string","deprecated":true,"readOnly":true},"product_distributor_id":{"title":"Product Distributor ID","description":"Unique identifier for the distributor.","type":"string","readOnly":true},"product_distributor_name":{"title":"Product Distributor Name","description":"Name of the distributor.","type":"string","readOnly":true},"product_reseller_id":{"title":"Product Reseller ID.","description":"Unique identifier of the reseller.","type":"string","readOnly":true},"product_reseller_name":{"title":"Product Reseller Name","description":"Name of the reseller.","type":"string","readOnly":true},"product_market_admin_id":{"title":"Product Market Admin ID","description":"Unique identifier for the market admin.","type":"string","readOnly":true},"product_market_admin_name":{"title":"Product Market Admin Name","description":"Name of the market admin.","type":"string","readOnly":true},"product_supplier_admin_id":{"title":"Product Supplier Admin ID","description":"Unique identifier for the supplier admin.","type":"string","readOnly":true},"product_supplier_admin_name":{"title":"Product Supplier Admin Name","description":"Name of the supplier admin.","type":"string","readOnly":true},"product_supplier_id":{"title":"Product Supplier ID","description":"Unique identifier for supplier.","type":"string"},"product_source_id":{"title":"Product Source ID","type":"string","description":"Unique ID of the product source.","readOnly":true},"product_source_name":{"title":"Product Source Name","type":"string","description":"Source of the product. \n\nEither PrioTicket or the name of the other reservation system e.g. CSS.","readOnly":true},"product_contract_source_id":{"title":"Product Contract Source ID","type":"string","description":"Contract source id."},"product_contract_source_name":{"title":"Product Contract Source Name","type":"string","description":"Contract source of the product. \n\nEither PrioTicket or the name of the contracting party."},"product_default_language":{"title":"Product Default Language","description":"Default Supplier Language. \n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","type":"string","default":"en"},"product_version":{"title":"Product Version","description":"Product version.","type":"integer"},"product_color":{"title":"Product Color","description":"Color of the product. (HEX)","type":"string"},"product_slug":{"title":"Product Slug","description":"SEO friendly slug which can be used during URL building.","type":"string"},"product_supplier_url":{"title":"Product Supplier URL","type":"string","format":"uri","readOnly":true},"product_supplier_key_public":{"title":"Product Supplier Public Key","description":"Supplier public key (Internal use only).","type":"string"},"product_from_price":{"title":"Product From Price","description":"Static from price which can be shown on the main product tile. (Usually regular Adult including discount and season independent).","type":"string"},"product_start_date":{"title":"Product Start Date","description":"Starting date of product.","type":"string","format":"date-time"},"product_end_date":{"title":"Product End date","description":"End date of the product.","type":"string","format":"date-time"},"product_booking_start_date":{"title":"Product Booking Start Date","description":"The earliest date on which the product is available for sale. This can be earlier than the `product_start_date`.","type":"string","format":"date-time"},"product_booking_end_date":{"title":"Product Booking End Date","description":"The date on which the product is no longer available for sale. This can be earlier than the `product_end_date`.","type":"string","format":"date-time","deprecated":true},"product_booking_advance_time_min":{"title":"Product Booking Advance Time Min","type":"integer","description":"The minimum amount of minutes you are required to book in advance to the selected travel date (`booking_travel_date`) or availability slot (`availability_from_date_time`)."},"product_booking_advance_time_max":{"title":"Product Booking Advance Time Max","type":"integer","description":"The maximum amount of minutes you are allowed to book in advance to the selected travel date (`booking_travel_date`) or availability slot (`availability_from_date_time`)."},"product_booking_advance_time_min_type":{"title":"Product Booking Advance Time Min Type","type":"string","readOnly":true,"enum":["TIMESLOT_START_TIME","TIMESLOT_END_TIME","VENUE_OPENING_TIME","VENUE_CLOSING_TIME","TRAVEL_START_DATE"]},"product_booking_advance_time_max_type":{"title":"Product Booking Advance Time Max Type","type":"string","readOnly":true,"enum":["TIMESLOT_START_TIME","TIMESLOT_END_TIME","TRAVEL_START_DATE"]},"product_booking_quantity_min":{"title":"Product Booking Quantity Max","description":"The minimum amount of available seats/spot/places/services required per product booking. ","type":"integer","multipleOf":1},"product_booking_quantity_max":{"title":"Product Booking Quantity Max","description":"The maximum amount of available seats/spots/places/services allowed per product booking.","type":"integer","multipleOf":1,"maximum":500},"product_turnout_time":{"title":"Product Turnout Time","description":"The amount of minutes at which guests should arrive prior to the start time of the reservation.\n\nFor example: You need to be at the meeting point 15 minutes in advance.","type":"integer"},"product_duration":{"title":"Product Duration","description":"Duration of product / tour/ service in minutes.","type":"integer"},"product_show_capacity_count":{"title":"Product Show Capacity Count","description":"The value from which the current capacity should be shown to the customer.\n\nOnly applicable if `product_capacity:true`.","type":"integer"},"product_third_party":{"title":"Product Third Party","description":"Whether the product is from a third party.","type":"boolean","default":false},"product_seasonal_pricing":{"title":"Product Seasonal Pricing","description":"Whether pricing can differentiate between specific date ranges (Product types can be returned more than once with different settings).","type":"boolean","default":false,"readOnly":true},"product_quantity_pricing":{"title":"Product Quantity Pricing","description":"Different pricing based on the booking quantity.","type":"boolean","default":false,"readOnly":true},"product_daily_pricing":{"title":"Product Daily Pricing","description":"Whether pricing can differentiate between specific days.","type":"boolean","default":false,"readOnly":true},"product_dynamic_pricing":{"title":"Product Dynamic Pricing","description":"Whether pricing can differentiate between specific availability slots (e.g. Peakhours).","type":"boolean","default":false,"readOnly":true},"product_relation_details_visible":{"title":"Product Relation Details Visible","type":"boolean","default":false,"description":"Whether you should show the underlying details of the linked sub-products. Only applicable if either `product_class:CLUSTER`, `product_class:COMBI` or `product_addon:true`."},"product_timepicker_visible":{"title":"Product Timepicker Visible","type":"boolean","default":true,"description":"Whether you should show the timepicker during booking."},"product_cluster":{"title":"Product Has Cluster","description":"Product is a cluster-product. In case this value is indicated as `true`, this product is the main cluster product and is not bookable. One of the sub-products linked to this cluster should be booked instead. These products are listed inside `product_cluster_details`.","type":"boolean","readOnly":true,"default":false},"product_combi":{"title":"Product Has Combi","description":"Product is a combi-product. In case this value is indicated as `true`, this product is the main combi product and is not bookable on its own. All of the sub-products linked to this combi should be booked as well. These products are listed inside `product_combi_details`.","type":"boolean","readOnly":true,"default":false},"product_bundle":{"title":"Product Has Bundle","description":"Product is a bundle-product. In case this value is indicated as `true`, this product is the main bundle product and is not bookable on its own. All of the sub-products linked to this bundle should be booked as well. These products are listed inside `product_bundle_details`.","type":"boolean","readOnly":true,"default":false},"product_addon":{"title":"Product Has Addon","description":"Product has one or more addon-products. In case this value is indicated as `true`, this product has one or more optional addons. All of the optional addons are listed inside `product_addon_details`.","type":"boolean","readOnly":true,"default":false},"product_availability":{"title":"Product Has Availability","type":"boolean","description":"Whether it is required to select an availability slot to make a booking request. \n\nIn case (`product_class:CLUSTER` or `product_class:COMBI`) and `product_availability:true` then the product has shared capacity (`product_capacity_type:SHARED`) across the sub-products. \n\nIf `product_availability:false` then this main cluster/combi product does not have shared capacity across the sub-products and therefore those should be checked individually. \n\nCheck `product_admission_type` for more details.","default":true},"product_availability_assigned":{"title":"Product Has Assigned Availability","type":"boolean","description":"Whether availability slots are assigned to a specific `spot`. In case `product_availability_assigned:true` assigned 'spots' will be returned once a booking is confirmed (using a best available seat algorithm).\n\nOptionally, if seatmaps are being supported, you are able to send your own selected seats.","default":false,"readOnly":true},"product_capacity":{"title":"Product Has Limited Capacity","type":"boolean","description":"Whether this product has managed (limited) capacity. \n\nCheck `product_capacity_type` for more details.","default":true},"product_traveldate_required":{"title":"Product Traveldate Required","type":"boolean","description":"Whether a traveldate is required upon booking. \nRedundant if availability is selected.","default":false},"product_cancellation_allowed":{"title":"Product Cancellation Allowed","type":"boolean","description":"Whether it is allowed to cancel this product. \n\nNote that even if a product can be cancelled, cancellation fees might still apply.\nPlease check `product_cancellation_policies` for more details.","default":true,"readOnly":true},"product_overbooking_allowed":{"title":"Product Overbooking Allowed","description":"Whether it is allowed to overbook. Not appplicable to third party products.","type":"boolean","default":false,"readOnly":true},"product_past_date_booking_allowed":{"title":"Product Past Date Booking Allowed","type":"boolean","description":"Whether it is allowed to select a date in the past.","default":false,"readOnly":true},"product_capacity_id":{"title":"Product Capacity ID","description":"Product capacity identifier. ","type":"string","readOnly":true},"product_capacity_shared_id":{"title":"Product Shared Capacity ID","description":"Shared availability / Capacity identifier. \n\nOnly applicable if `capacity_type:SHARED / COMBINED`.","type":"string","readOnly":true},"product_capacity_type":{"$ref":"#/components/schemas/CapacityType"},"product_admission_type":{"$ref":"#/components/schemas/ProductAdmissionType"},"product_status":{"$ref":"#/components/schemas/ProductStatus"},"product_catalogue_status":{"$ref":"#/components/schemas/ProductCatalogueStatus"},"product_class":{"$ref":"#/components/schemas/ProductClass"},"product_service_type":{"$ref":"#/components/schemas/ProductServiceType"},"product_seating_type":{"$ref":"#/components/schemas/ProductSeatingType"},"product_pickup_point":{"title":"Product Pickup","description":"Whether its required to set a pickup point for this product. Details on the available locations are inside `product_locations`.","type":"string","readOnly":true,"enum":["MANDATORY","OPTIONAL","NOT_SET"]},"product_pickup_point_details":{"title":"Product Pickup Points","description":"If `product_pickup_point:MANDATORY/OPTIONAL`, then `pickup_point_details` are required.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/PickupPoint"}},"product_content":{"$ref":"#/components/schemas/ProductContent"},"product_redemption_rules":{"$ref":"#/components/schemas/ProductRedemptionRules"},"product_code_settings":{"$ref":"#/components/schemas/ProductCodeSettings"},"product_payment_detail":{"$ref":"#/components/schemas/ProductPaymentDetails"},"product_type_seasons":{"title":"Product Type Seasons","description":"Product types per season. \nNot returned in case of bundle products.","type":"array","items":{"$ref":"#/components/schemas/ProductTypeSeason"}},"product_options":{"title":"Product Options","description":"General product options.","type":"array","items":{"$ref":"#/components/schemas/ExtraOptions"}},"product_cancellation_policies":{"title":"Product Cancellation Policies","description":"Sometimes a product has a cancellation fee. In that case the order amount might not be refunded in full. If no cancellation policies are set and `product_cancellation_allowed:true` then you can always cancel products until they are redeemed.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/CancellationPolicy"}},"product_opening_times":{"title":"Product Opening Times","description":"Opening times of the product / venue.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimes"}},"product_flags":{"title":"Product Flags","description":"Product flags.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Flag"}},"product_locations":{"title":"Product Locations","description":"Venues / Locations of interested for this product.","type":"array","items":{"$ref":"#/components/schemas/ProductLocation"}},"product_cluster_details":{"title":"Product Clusters","description":"In case `product_class:CLUSTER` the following array will be populated. This array contains all linked cluster-products to this main cluster-product. One of these should be booked instead of the main-product. Depending on the configuration, details and availability might be shared across these products.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductRelationDetails"}},"product_combi_details":{"title":"Product Combi's","description":"The List Products API lists all available product configurations enabled for the distributor.\nIf you have a combination (combi-product) of (Product A + Product B) a third product (Product C) will be created. \n\nThe API will return the following:\n```\nArray [\n   Product A Details {\n    `product_id`:'PRODUCT_ID_A'\n    `product_combi:false`,\n    `product_combi_details`:[])\n   }\n   \n   Product B Details {\n    `product_id`:'PRODUCT_ID_B',\n    `product_combi:false`,\n    `product_combi_details`:[])\n   }\n   \n   Product C Details { \n     `product_id`:'PRODUCT_ID_C'\n     `product_combi:true`, \n     `product_combi_details`:['PRODUCT_ID_A', 'PRODUCT_ID_B')\n   }\n]\n```\nEvery product has a unique ID and acts as a separate entity. Therefore there is no need to handle this logic on your side and you could handle them as separate products. \nIn case `product_class:COMBI` the following array will be populated. This array contains all linked combi-products to this main combi-product. Depending on the configuration, details and availability might be shared across these products.\n* To make a combination booking ALL combi sub-products MUST be set in the booking request as well as the main combi-product itself. Failing to do so will cause an invalid response.\n* All sub-products must be set in the `product_combi_details` object of the main combi-product booking object, else the products will be set as individual bookings. (Some sub-products can be booked as separate products as well)\n* All sub-products will inherited the `product_type_details` configuration of the main combi-product and therefore should not be set.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductRelationDetails"}},"product_bundle_details":{"title":"Product Bundle","description":"In case `product_class:BUNDLE` the following array will be populated. This array contains all linked bundle-products to this main product. All of these should be booked in addition to the main product. ","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductRelationDetails"}},"product_addon_details":{"title":"Product Addons","description":"In case `product_addon:true` the following array will be populated. This array contains all linked addon-products to this main product. One or more of these could be booked in addition to the main product. ","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductRelationDetails"}},"product_categories":{"title":"Product Categories","description":"The categories the product belongs to.","type":"array","items":{"title":"Category","description":"Category.","type":"string"}},"product_recommendations":{"title":"Product Recommendations","description":"The recommendations the product has applied.","type":"array","items":{"title":"Recommendation","description":"Recommendations ID","type":"string"}},"product_destinations":{"title":"Product Destinations","description":"The destinations the product belongs to.","type":"array","readOnly":true,"items":{"title":"Destination","description":"Destination.","type":"string"}},"product_languages":{"title":"Product Languages","description":"Language codes for the available languages of the product, e.g. Shows are available in English and Spanish. \n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","type":"array","items":{"title":"Product Language","description":"Product language.","type":"string"}},"product_content_languages":{"title":"Product Content Languages","description":"Language Codes of the languages for which the product data is available. \n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. This field can be used to show multilingual content on your website.","type":"array","items":{"title":"Content Language Code","type":"string"}},"product_guide_languages":{"title":"Product Guide Languages","description":"Language codes of the available guides.\n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/GuideLanguage"}},"product_routes":{"title":"Product Routes","description":"Array of routes linked to this product.","type":"array","readOnly":true,"items":{"title":"Route ID","type":"string"}},"product_notes":{"title":"Product Notes","description":"Optional notes on this product.","type":"array","items":{"$ref":"#/components/schemas/Note"}},"product_google_categories":{"title":"Product Google Categories","type":"string","readOnly":true,"description":"Comma-separated list of attached Google categories (https://developers.google.com/travel/things-to-do/reference/feed-spec/product-category)."},"product_custom_fields":{"title":"Product Custom Fields","description":"Freeform entry of any key-value pair.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"product_created":{"title":"Product Created","description":"The date on which the product has been created.","type":"string","format":"date-time","readOnly":true},"product_created_name":{"title":"Product Created Name","description":"User who created the product.","type":"string","format":"email","readOnly":true},"product_created_email":{"title":"Product Created Email","description":"Username that created the product.","type":"string","format":"email","readOnly":true},"product_modified":{"title":"Product Modified","description":"The date on which the product has been last modified.","type":"string","format":"date-time","readOnly":true},"product_modified_name":{"title":"Product Modified Name","description":"User who modified the product.","type":"string","format":"email","readOnly":true},"product_modified_email":{"title":"Product Created Email","description":"Username that modified the product.","type":"string","format":"email","readOnly":true},"product_view_type":{"$ref":"#/components/schemas/AccountType"}},"required":["product_id","product_supplier_id","product_market_admin_id","product_market_admin_name","product_source_id","product_source_name","product_start_date","product_booking_start_date","product_default_language","product_admission_type","product_third_party","product_seasonal_pricing","product_quantity_pricing","product_daily_pricing","product_dynamic_pricing","product_relation_details_visible","product_addon","product_availability","product_availability_assigned","product_overbooking_allowed","product_past_date_booking_allowed","product_capacity","product_service_type","product_capacity_type","product_traveldate_required","product_cancellation_allowed","product_content","product_redemption_rules","product_code_settings","product_currency","product_pickup_point","product_content_languages","product_created","product_created_name","product_created_email","product_modified","product_modified_name","product_modified_email","product_view_type"]},"CapacityType":{"title":"Capacity Type","description":"Type of capacity.\n\n<details>\n  <summary>**Capacity Types**</summary>\n\n* `OWN` - This product has his own capacity.\n \n* `SHARED` - This product does not have it's own capacity, instead it uses shared capacity from other products.\n* `COMBINED` - This product has his own capacity combined with the capacity of other products.\n* `NOT_SET` - This product does not have capacity.\n</details>\n","type":"string","readOnly":true,"enum":["OWN","SHARED","COMBINED","NOT_SET"]},"ProductAdmissionType":{"title":"Product Admission Types","type":"string","readOnly":true,"enum":["TIME_PERIOD","TIME_DATE","TIME_POINT","TIME_SLOT","TIME_OPEN"],"description":"<details>\n  <summary>**Product Admission Types**</summary>\n  \n* `TIME_PERIOD` - Customers can arrive at any time between the start (`availability_from_date_time`) and end time (`availability_to_date_time`) of the availability slot. Multiple periods in a single day should be expected.\n  Therefore a date- and timepicker should be shown.\n\n* `TIME_DATE` - Variation on `TIME_PERIOD`, whereas only a single period exists in a day. It is not required to choose between different times within a day, therefore only a datepicker is required.\n  Note that in case the slot includes midnight (two or more days), the day from which the `availability_from_date_time` originated should take precedence.\n\n* `TIME_POINT` - Customers are required to be present at the start time of the availability slot but can leave any time they want.\n* `TIME_OPEN` - Customers can arrive at any time. Availablity is not applicable.\n* `TIME_SLOT` - Customers are required to be present at the start time of the availability slot, and the service is expected to finish at the end time of the slot. </details>\n"},"ProductStatus":{"title":"Product Status","description":"Status of the product.\n> A product can only be sold if the status is `ACTIVE` or `TEST`.\n\n<details>\n  <summary>**Product Statuses**</summary>\n\nProduct Status:\n* `DRAFT` - Product is a draft. \n\n  The product is a draft.\n\n* `REVIEW` - Product is in review. \n\n  The product is in review.\n \n* `ACTIVE` - Product is active.\n\n  The product is fully configured and ready to sell using any linked catalogue (See Product Catalogue Status).\n\n* `EXPIRED` - Product is expired.\n\n  The product configured availability expired and this product is no longer available for sales. \n\n* `ARCHIVED` - Product is archived. \n\n  The product is archived. It can return to `ACTIVE` by unarchiving it.\n\n* `INACTIVE` - Product is inactive.\n\n  The product is set inactive. It should not be visible on any channel and cannot be sold until set to `ACTIVE` again.\n\n* `TEST` - Product is in test.\n\n  The product is fully configured and ready to sell. Similar to `ACTIVE`, but only meant for internal testing purposes. This product should not be exposed to end-consumers.\n\n* `UNAVAILABLE` - Product is unavailable.\n\n  The product is automatically set as unavailable due to an error or misconfiguration. This product requires attention.\n\n* `SUSPENDED` - Product is suspended.\n\n  The product is suspended due to Terms of Service violation.\n\n* `DELETED` - Product is deleted.\n\n  The product is permanently deleted.\n  \n* `PREVIEW` - Product is in preview.\n    \n  The product is visible but cannot be booked yet. Generally used during pre-sales. This state is automatically set if the product is `ACTIVE` but did not yet reach the `product_booking_start_date`.\n\n</details>","type":"string","deprecated":true,"enum":["DRAFT","REVIEW","ACTIVE","EXPIRED","ARCHIVED","INACTIVE","TEST","UNAVAILABLE","SUSPENDED","DELETED","PREVIEW"]},"ProductCatalogueStatus":{"title":"Product Catalogue Status","description":"[FILTER] on Product Catalogue Status (`product_catalogue_status`)..\n<details>\n  <summary>**Product Catalogue Statuses**</summary>\n\nProduct Catalogue Status:\n* `PENDING` - Product is pending to be assigned to a catalogue.\n* `INACTIVE` - Product is assigned and inactive on the catalogue.\n* `ACTIVE` - Product is assigned and active on the catalogue.\n</details>","type":"string","enum":["PENDING","INACTIVE","ACTIVE"]},"ProductClass":{"title":"Product Class","type":"string","readOnly":true,"description":"<details>\n  <summary>**Product Classes**</summary>\n  \n  * `STANDARD` - Product types in the standard class are the most common and are supported by almost all systems.\n  \n  * `COMBI` - Product is a combi-product. This product is the main combi product and is not bookable on its own. All of the sub-products linked to this combi should be booked as well. These products are listed inside `product_combi_details`.\n  \n  * `CLUSTER` - Product is a cluster-product. This product is the main cluster product and is not bookable. One of the sub-products linked to this cluster should be booked instead. These products are listed inside `product_cluster_details`.\n  \n  * `MERCHANDISE` - \n  \n  * `BUNDLE` - Product is a bundle-product. This product is the main bundle product and is not bookable on its own. All of the sub-products linked to this bundle should be booked as well. These products are listed inside `product_bundle_details`.\n  \n  * `ADDON` - \n  \n  * `OTHER` - Products in the other/custom class are completely dynamic.\n\n</details>\n","enum":["STANDARD","COMBI","CLUSTER","MERCHANDISE","BUNDLE","ADDON","OTHER"]},"ProductServiceType":{"title":"Product Service Type","description":"Type of service this product offers.","type":"string","readOnly":true,"deprecated":true,"enum":["ATTRACTION","EVENT","SEATING","RIDE","DINING","FOOD","DELIVERY","MOBILITY","ITINERARY","MERCHANDISE","FLIGHT","HOTEL","TOURS","UNSPECIFIED"]},"ProductSeatingType":{"title":"Product Seating Type","description":"Whether this is a seating-type product and the corresponding seating logic.","type":"string","readOnly":true,"enum":["NONE","BEST_AVAILABLE","SEAT_MAP"]},"PickupPoint":{"title":"Pickup Point","description":"Information on a pickup point.","type":"object","properties":{"pickup_point_id":{"title":"Pickup Point ID","description":"Pickup point ID.","type":"string"},"pickup_point_name":{"title":"Pickup Point Name","description":"Pickup point name / label.","type":"string","readOnly":true},"pickup_point_type":{"$ref":"#/components/schemas/PickupPointType"},"pickup_point_description":{"title":"Pickup Point Description","description":"Pickup point description.","type":"string","readOnly":true},"pickup_point_location":{"title":"Pickup Point Location","description":"Reference to the location details.","type":"string","readOnly":true},"pickup_point_time":{"title":"Pickup Point Time","description":"Time of pickup.","type":"string","format":"time"},"pickup_point_times":{"title":"Pickup Point Times","description":"Times available to select for this pickup point.","type":"array","items":{"title":"Pickup Point Time","description":"Time of pickup.","type":"string","format":"time"}},"pickup_point_duration":{"title":"Pickup Point Duration","description":"Duration of the pickup in minutes.","type":"integer","readOnly":true},"pickup_point_availability_dependency":{"title":"Pickup Point Availability Dependency","description":"Dependency on the selected `availability_slot`.\n\nThe selected (`pickup_point_time` + `pickup_point_duration`) is not allowed to exceed the selected `availability_from_date_time` and therefore only a limited amount of `pickup_point_times` should be shown.","type":"boolean","readOnly":true}},"required":["pickup_point_id","pickup_point_name"]},"PickupPointType":{"title":"Pickup Point Type","description":"Type of pickup point.\n\nPickup Point Type:\n  * `FIXED` - Fixed, pre-defined pickup point.\n   \n  * `CUSTOM` - Custom pickup point.","type":"string","enum":["FIXED","CUSTOM"]},"ProductContent":{"title":"Product Content","description":"All translatable product content.","type":"object","properties":{"product_title":{"title":"Product Title.","description":"The title of product.","type":"string"},"product_supplier_name":{"title":"Product Supplier Name","description":"Name of the supplier which offers the product(s).","type":"string","readOnly":true},"product_duration_text":{"title":"Product Duration Text","description":"Duration of product as contextial representation.","type":"string"},"product_short_description":{"title":"Product Short Description","description":"The short description of product.","type":"string"},"product_long_description":{"title":"Product Long Description","description":"The long description of product.","type":"string"},"product_additional_information":{"title":"Product Additional Information","description":"Additional information shown on the website and voucher.","type":"string"},"product_entry_notes":{"title":"Product Entry Notes","description":"Product entry information. (Know before you go).\nThe user-visible list of important notes, use for details such as age-restrictions or other conditions that make this service unsuitable.\n","type":"string"},"product_booking_url":{"title":"Product Booking URL","description":"Booking URL for this product. The page should include a button to start the booking / checkout flow.","type":"string","format":"URI"},"product_landing_page_view_url":{"title":"Product Landing Page View URL","description":"Product landing page for this product. Link to a list view at a higher level of available tickets and tours, prominently showing this option possibly among other options.","type":"string","format":"URI"},"product_favorite":{"title":"Product Favorite","description":"Indicator that this product is marked as a favorite.","type":"boolean"},"product_highlights":{"title":"Product Highlights","description":"Product highlights.","type":"array","items":{"$ref":"#/components/schemas/Highlight"}},"product_includes":{"title":"Product Includes","description":"Product includes.","type":"array","items":{"$ref":"#/components/schemas/ProductInclude"}},"product_excludes":{"title":"Product Excludes","description":"Product excludes.","type":"array","items":{"$ref":"#/components/schemas/ProductExclude"}},"product_images":{"title":"Product Images","description":"It contains images related to the product.","type":"array","items":{"$ref":"#/components/schemas/Image"}}},"required":["product_title","product_supplier_name","product_short_description","product_long_description"]},"Highlight":{"title":"Product Highlight","description":"Product highlight.","type":"object","additionalProperties":false,"properties":{"highlight_description":{"title":"Highlight Description","description":"Description of the highlight.","type":"string"}}},"ProductInclude":{"title":"Product Include","description":"Product include.","type":"object","additionalProperties":false,"properties":{"include_description":{"title":"Include Description","description":"More detail on the included product.","type":"string"}}},"ProductExclude":{"title":"Product Exclude","description":"Product exclude.","type":"object","additionalProperties":false,"properties":{"exclude_description":{"title":"Exclude Description","description":"More detail on the excluded product.","type":"string"}}},"Image":{"title":"Image","description":"Details on the image.","type":"object","additionalProperties":false,"properties":{"image_type":{"title":"Product Image Type","description":"Product image type.","type":"string","enum":["BANNER","MAIN","DETAIL","THUMBNAIL"]},"image_url":{"title":"Image URL","description":"Image URL.","type":"string","format":"uri"}},"required":["image_type","image_url"]},"ProductRedemptionRules":{"title":"Product Redemption Rules","description":"Rules on the product redemption.","type":"object","readOnly":true,"required":["redemption_has_duration","redemption_count_type"],"properties":{"redemption_has_duration":{"title":"Redemption has duration","description":"In case this product has a fixed duration a countdown will be started based on the `redemption_duration_type`.","type":"boolean","default":false},"redemption_duration_time":{"title":"Redemption Duration Time","description":"The total amount of time in seconds that the pass is supposed to be valid. Only applicable if `redemption_has_duration:true`.","type":"integer"},"redemption_duration_type":{"$ref":"#/components/schemas/RedemptionDurationType"},"redemption_count_type":{"$ref":"#/components/schemas/RedemptionCountType"},"redemption_count_value":{"title":"Redemption Count Value","description":"The amount of times this product can be redeemed. \n\nOnly applicable if `redemption_count_type:LIMITED`.","type":"integer","default":1}}},"RedemptionDurationType":{"title":"Redemption Duration Type","type":"string","default":"SCAN","description":"When the actual countdown starts.\n\nOnly applicable if `redemption_has_duration:true`.\n* `TRAVEL_DATE` - This product countdown starts on the selected traveldate (`booking_travel_date` or `availability_from_date_time`)\n* `BOOKING_DATE` - This product countdown starts on the booking date (directly after purchase).\n* `SCAN` - This product countdown starts after the first scan.\n* `CONVERSION` - This product countdown starts after converting the voucher into a pass.\n","enum":["TRAVEL_DATE","BOOKING_DATE","SCAN","CONVERSION"]},"RedemptionCountType":{"title":"Redemption Count Type","description":"The amount of allowed redemptions for this product.\n\nIf `redemption_has_duration:true`, then this value is ONLY applicable during an active countdown. Otherwise it is a general admission counter.\n* `UNLIMITED` - This product can be redeemed an unlimited amount of times (during the redeem duration).\n* `LIMITED` - This product can be redeemed a limited amount of times (during the redeem duration).\n","type":"string","default":"LIMITED","enum":["UNLIMITED","LIMITED"]},"ProductCodeSettings":{"title":"Product Code Settings","description":"Information on how the product codes are being provided.","readOnly":true,"type":"object","required":["product_code_format","product_code_source","product_code_type","product_group_code","product_combi_code","product_voucher_settings","product_voucher_release_type"],"properties":{"product_code_format":{"$ref":"#/components/schemas/ProductCodeFormat"},"product_code_source":{"$ref":"#/components/schemas/ProductCodeSource"},"product_group_code":{"title":"Product Group Code","description":"Whether this product supports a group code. In this case a code (`product_code`) is returned which is valid for all `product_type`s. This code can be used to allow entry to all persons within that booking without using an individual `product_type_code`.","type":"boolean","default":false},"product_combi_code":{"title":"Product Combi Code","description":"Whether this product supports a combi code. In this case a code (`product_code`) is returned which is valid for all products within a package. This code allows admission to all supplier venues. This is only applicable to combi-products (`product_class:COMBI`).","type":"boolean","default":false},"product_city_card":{"title":"Product City Card","description":"Product is a city card.","type":"boolean","default":false},"product_voucher_settings":{"$ref":"#/components/schemas/ProductVoucherSettings"},"product_code_release_date":{"title":"Product Code Release Date","description":"If `product_code_release_details:DATE_ALLOCATION`, this field will indicate the date on which the voucher codes will be available. Note that if there are multiple voucher release requirements, all must be met prior to this date, otherwise the voucher will be released as soon as the last requirement is fullfilled.\n\nIn case you are subscribed to the Order Notification Event, a webhook will be triggered on this date as well.","type":"string","format":"date-time","deprecated":true},"product_code_release_details":{"title":"Product Code Release Details","description":"Requirements for the voucher codes to be released. All requirements must be met for the voucher to be released.\n\nBy default the vouchers will be released on Order Confirmation. Be aware that if additional requirements are set, the voucher codes might not immediately be released upon Create Booking.\n\nAdditional requirements are only applicable to a very small subset of products.","type":"array","items":{"$ref":"#/components/schemas/VoucherReleaseType"}}}},"ProductCodeFormat":{"title":"Product Code Format","description":"Indicates how the product code should be rendered on the customer voucher.\n\nCode Formats:\n  * `BAR_CODE`\n  * `BAR_CODE_E128`\n  * `BAR_CODE_C128`\n  * `BAR_CODE_C39`\n  * `AZTEC`\n  * `PDF`\n  * `PDF417`\n  * `QR_CODE`\n  * `QR_CODE_WITH_LINK`\n  * `LINK`\n  * `IMAGE`","type":"string","readOnly":true,"enum":["BAR_CODE","BAR_CODE_E128","BAR_CODE_C128","BAR_CODE_C39","AZTEC","PDF","PDF417","QR_CODE","QR_CODE_WITH_LINK","LINK","IMAGE","NONE","OTHER"]},"ProductCodeSource":{"title":"Product Code Source","description":"Indicates the origin of the code.","type":"string","readOnly":true,"enum":["PRIO","EXTERNAL","MANUAL"]},"ProductVoucherSettings":{"title":"Product Voucher Settings","description":"Details on how the voucher should be printed / presented.","type":"string","default":"SINGLE","enum":["PER_PERSON","PER_SUPPLIER","SINGLE"]},"VoucherReleaseType":{"title":"Voucher Release Type","description":"Requirement on when the voucher code will be released.\n> Any additional requirement besides `ORDER_CONFIRMATION` will indicate that you might not receive the voucher codes directly upon \"Create Booking\".\n\nVoucher Release Types:\n * `ORDER_CONFIRMATION` (string) - The order must be confirmed before the vouchers are released.\n \n    This is the most common scenario and in case no other requirements are set the voucher codes can be expected directly upon booking confirmation.\n * `PAYMENT_CONFIRMATION` (string) - The order must be paid before the vouchers are released.\n \n    In case payment is done prior to confirming the booking, the voucher codes can be expected directly upon booking confirmation.\n    \n    This requirement could be applicable on:\n    \n      * `SettlementType:INVOICE`, Upfront payment by invoice.\n      \n      * `SettlementType:VENUE`, Payment is made at venue (`VENUE_ALLOCATION` will likely be returned as well).\n      \n      * `SettlementType:DIRECT`, Payment (-Authorization) is made directly at booking. Note that this indicator is redundant as voucher codes can still be expected directly upon booking confirmation.\n    \n    > Only applicable to Guest Payment. Not applicable to B2B resellers / purchases (Indirect sales / `SettlementType:EXTERNAL`).\n * `SUPPLIER_ALLOCATION` (string) - The vouchers must be (manually) allocated by the supplier before the vouchers are released. Vouchers are not returned directly upon booking confirmation.\n \n    This value will only be returned in case manual supplier allocation is required or if the third-party sub-system is unable to directly allocate the vouchers.\n    \n    Additional work is required to receive the vouchers after the supplier has allocated the vouchers.\n    In most cases the order status will remain `PENDING`.\n * `DATE_ALLOCATION` (string) - The vouchers will be provided at a set date. The date is provided as `product_code_release_date`.\n * `VENUE_ALLOCATION` (string) - The vouchers will be provided at the venue.\n * `MANUAL_ALLOCATION` (string) - The vouchers will be provided manually, outside of the API environment.\n * `NO_ALLOCATION` (string) - The vouchers are not provided nor generated, entry is managed by the venue itself. For example on booking name.","type":"string","default":"ORDER_CONFIRMATION","deprecated":true,"enum":["ORDER_CONFIRMATION","PAYMENT_CONFIRMATION","SUPPLIER_ALLOCATION","DATE_ALLOCATION","MANUAL_ALLOCATION","VENUE_ALLOCATION","NO_ALLOCATION"]},"ProductPaymentDetails":{"title":"Product Payment Details","description":"Details on the payment details for this product.","type":"object","readOnly":true,"properties":{"product_payment_type":{"title":"Product Payment Type","description":"Indicates how the product will be purchased.\n\nPayment Types:\n   * `REQUIRED` (string) - The user has to pay this service at the booking time.\n   * `OPTIONAL` (string) - The user can choose to pre-pay this service at the booking time or later, but it is not required in order to book.\n   * `NOT_SUPPORTED` (string) - Payment is not supported for this service.","type":"string","deprecated":true,"enum":["REQUIRED","OPTIONAL","NOT_SUPPORTED"]},"product_payment_currency":{"$ref":"#/components/schemas/Currency"}}},"Currency":{"title":"Currency Information","description":"The currency information for product prices. According to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","type":"object","additionalProperties":false,"properties":{"currency_code":{"title":"Currency Code","description":"Currency Code, according to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","type":"string"},"currency_language_code":{"title":"Currency Language Code","description":"Currency language code.","deprecated":true,"type":"string"},"currency_region_code":{"title":"Currency Region Code","description":"Currency region code.","type":"string","deprecated":true},"currency_symbol":{"title":"Currency Symbol","description":"Currency symbol.","deprecated":true,"type":"string"},"currency_symbol_position":{"$ref":"#/components/schemas/CurrencySymbolPosition"},"currency_decimal_digits":{"title":"Currency Decimal Digits","description":"Currency decimal digits.","deprecated":true,"type":"integer"},"currency_decimal_delimiter":{"title":"Currency Decimal Delimiter","description":"Currency decimal delimiter.","deprecated":true,"type":"string"},"currency_thousand_delimiter":{"title":"Currency Thousand Delimiter","description":"Currency thousand delimiter.","deprecated":true,"type":"string"},"currency_space_between_amount_and_symbol":{"title":"Currency Space Between Amount and Symbol","description":"Currency space between amount and symbol.","deprecated":true,"type":"boolean","default":true}}},"CurrencySymbolPosition":{"title":"Currency Symbol Position","description":"Currency symbol position.","deprecated":true,"type":"string","enum":["LEFT","RIGHT"]},"ProductTypeSeason":{"title":"Product Type Season","description":"Details on a single product type season.","type":"object","properties":{"product_type_season_label":{"title":"Product Type Season Label","type":"string","description":"Optional label for this season. Only applicable if set and `product_seasonal_pricing:true."},"product_type_season_start_date":{"title":"Product Type Season Start Date","description":"Start date of this season.","format":"date-time","type":"string"},"product_type_season_end_date":{"title":"Product Type Season End Date","description":"End date of this season.","type":"string","format":"date-time"},"product_type_season_details":{"title":"Product Type Season Details","description":"Contains information related to the different product type versions in this season.","type":"array","items":{"$ref":"#/components/schemas/ProductTypeDetails"}}},"required":["product_type_season_start_date","product_type_season_details"]},"ProductTypeDetails":{"title":"Product Type Details","description":"Details on a single product type.","type":"object","properties":{"product_type":{"$ref":"#/components/schemas/ProductType"},"product_type_class":{"$ref":"#/components/schemas/ProductTypeClass"},"product_type_variant_id":{"title":"Product Type Variant ID","description":"Unique identifier for this product type variant.","type":"string","deprecated":true,"readOnly":true},"product_type_id":{"title":"Product Type ID","type":"string","readOnly":true},"product_parent_type_id":{"title":"Product Parent Type ID","description":"In case of bundle products, this field indicated the related parent type ID. This can be used to simplify the booking process by bundling the product type selection.","type":"string"},"product_type_label":{"title":"Product Type Label","description":"(Translatable) The actual label to show on your front-end.","type":"string"},"product_type_description":{"title":"Product Type Description","type":"string","description":"(Translatable) Optional description of this product type. If provided, it is highly recommended to show it on your front-end as it might contain important information about the eligibility."},"product_type_age_from":{"title":"Product Type Age From","description":"The starting age for age group.","readOnly":true,"type":"integer","multipleOf":1},"product_type_age_to":{"title":"Product Type Age To","description":"The ending age for age group.  If both `product_type_age_from` and `product_type_age_to` are empty no age-restrictions should be shown. If only `product_type_age_to` is empty, then it is advised to show the age-restriction as e.g. \"22+\".\n","type":"integer","readOnly":true,"multipleOf":1},"product_type_pax":{"title":"Product Type Pax","description":"Number of persons that should be counted in the reporting.","type":"integer","readOnly":true,"minimum":0,"multipleOf":1,"default":1},"product_type_capacity":{"title":"Product Type Capacity","type":"integer","readOnly":true,"minimum":0,"multipleOf":1,"default":1,"description":"Capacity that should be counted / blocked in the system.\n\nFor example:\n\nIf a single table with six seats is booked by two persons, the setup would be as follows:\n\n  ```\n  \"product_type_count\": 1,\n  \"product_type_pax\": 2,\n  \"product_type_capacity\": 6\n  ```\n"},"product_type_quantity_min":{"title":"Product Type Quantity Min","description":"The minimum required quantity to be selected. The `product_type_count` must be equal or higher.","type":"integer","multipleOf":1,"readOnly":true},"product_type_quantity_max":{"title":"Product Type Quantity Max","description":"The maximum allowed quantity to be selected. The `product_type_count` must be equal or lower.","maximum":500,"type":"integer","multipleOf":1,"readOnly":true},"product_type_price_tax_id":{"title":"Product Type Price Tax ID","description":"Tax ID for this product type. Tax information can be retrieved from the Tax API.","type":"string","readOnly":true},"product_type_price_type":{"title":"Product Type Price Type","description":"Whether the price is applicable per individual or fixed for the whole group. \nPrice Type:\n     * `INDIVIDUAL` - Depending on the booking quantity, the price increases.\n     * `GROUP` - The price for this product type is fixed regardless of how many are booked.","type":"string","readOnly":true,"enum":["INDIVIDUAL","GROUP"]},"product_type_pricing":{"$ref":"#/components/schemas/ProductTypePricingExtended"},"product_type_taxes":{"title":"Product Type Taxes","description":"List of taxes. Some tax types are only visible for certain users.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductTax"}},"product_type_fees":{"title":"Product Type Fees","description":"List of fees. Some fee types are only visible for certain users.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Fee"}},"product_type_quantity_variations":{"title":"Product Type Quantity Variations","description":"Only set if `product_quantity_pricing:true`.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductTypeQuantityVariation"}},"product_type_daily_variations":{"title":"Product Type Daily Variations","description":"Only set if `product_daily_pricing:true`. As an alternative to implementing these prices statically (Content API), they could also be retrieved from the Availability API (`availability_pricing`).","type":"array","items":{"$ref":"#/components/schemas/ProductTypeDailyVariation"}}},"required":["product_type","product_type_id","product_type_pricing"]},"ProductType":{"title":"Product Type","type":"string","description":"Each product contains product types. These product types can offer aged based ticketing (such as Adult and Child), but also provide a variety of other flexible product variations such as group pricing, business and economy seating or different car configurations.\n\nBecause some products might behave different from others, each product type is categorized within a product class; a group of products that behaves similarly.\n<details>\n  <summary>**Product Types**</summary>\n\n  * Class Standard:\n    \n    Product types in the standard class are the most common and are supported by almost all systems. These types will always be age-restricted.\n    \n    Tour and experience providers have the flexibility to vary prices and apply different rules based on the age of their customers. This means they can charge full ticket prices for adults while offering discounted rates for children, or they may have specific requirements such as requiring at least one adult for every group of children booking a tour.\n    \n    During the process of checking prices and proceeding to checkout, customers should be able to select the number of individuals from each available age group for their booking.\n  \n    * `ADULT` - Adult.\n    \n    * `CHILD` - Child.\n    \n    * `SENIOR` - Senior.\n    \n    * `YOUTH` - Youth.\n        \n    * `INFANT` - Infant.\n    \n  * Class Individual:\n  \n    Product types in the individual class are less common and therefore have fewer supported systems. These types will never be age-restricted.\n    \n    * `PERSON` - Person.\n    \n    * `STUDENT` - Student.\n    \n    * `RESIDENT` - Resident.\n    \n    * `MILITARY` - Military.\n    \n    * `IMPAIRED` - Impaired.\n  \n  * Class Item:\n  \n    Product types in the item class do not refer to actual persons, instead they could, for example, be packages (Regular, Silver, Diamond), objects (Merchandise, private tours), a type of event, class identifier (Economy, Business) and much more.\n  \n    * `ITEM` - Item.\n    \n  * Class Group:\n   \n    Product types in the group class always consist of multiple persons. It can, for example, be a family of 2 Adults and 2 Childs.\n    \n    * `GROUP` - Group.\n    \n    * `FAMILY` - Family.\n    \n  * Class Custom:\n  \n    Product types in the custom class are completely dynamic and therefore require explicit mapping with external systems. They do not return as `CUSTOM`, instead they can take any form.\n    \n    * `CUSTOM` - Custom.\n    \n</details>\n","enum":["ADULT","CHILD","SENIOR","YOUTH","INFANT","PERSON","STUDENT","RESIDENT","MILITARY","IMPAIRED","ITEM","GROUP","FAMILY","CUSTOM"]},"ProductTypeClass":{"title":"Product Type Class","type":"string","readOnly":true,"description":"<details>\n  <summary>**Product Type Classes**</summary>\n  \n  * `STANDARD` - Product types in the standard class are the most common and are supported by almost all systems. These types will always be age-restricted.\n  \n  * `INDIVIDUAL` - Product types in the individual class are less common and therefore have fewer supported systems. These types will never be age-restricted.\n  \n  * `ITEM` - Product types in the item class do not refer to actual persons, instead they could, for example, be packages (Regular, Silver, Diamond), objects (Merchandise, private tours), a type of event, class identifier (Economy, Business) and much more.\n  \n  * `GROUP` - Product types in the group class always consist of multiple persons. It can, for example, be a family of 2 Adults and 2 Childs.\n  \n  * `CUSTOM` - Product types in the custom class are completely dynamic and therefore require explicit mapping with external systems. They do not return as CUSTOM, instead they can take any form.\n\n</details>\n","enum":["STANDARD","INDIVIDUAL","ITEM","GROUP","CUSTOM"]},"ProductTypePricingExtended":{"title":"Product Type Pricing","description":"Product Type specific pricing.","type":"object","properties":{"product_type_list_price":{"title":"Product Type List Price","description":"Recommended retail price (RRP). Standard price before discount for the end customer of this product type set by the supplier.","type":"string"},"product_type_discount":{"title":"Product Type Discount","description":"Strike-through discount applicable to `product_type_list_price`.","type":"string","nullable":true,"readOnly":true},"product_type_discount_percentage":{"title":"Product Type Discount Percentage","description":"Strike-through discount percentage. If blank then the Strike-through discount is not based on percentages.","type":"string","readOnly":true},"product_type_sales_price":{"title":"Product Type Sales Price","description":"Standard price after discount for the end-customer set by the reseller. (`product_type_list_price` - `product_type_discount` == `product_type_sales_price`).","type":"string","readOnly":true},"product_type_distributor_price":{"title":"Product Type Resale Price","description":"Price paid by the distributor to the reseller.","type":"string","readOnly":true},"product_type_reseller_price":{"title":"Product Type Reseller price","description":"Price the reseller pays to the market administrator.","type":"string"},"product_type_market_price":{"title":"Product Type Market Price","description":"Price paid by the market admin to the supplier.","type":"string"},"product_type_supplier_price":{"title":"Product Type Supplier Price","type":"string","description":"Optional internal benchmark cost defined by supplier.","readOnly":true},"product_type_display_price":{"title":"Product Type Display Price","type":"boolean","readOnly":true,"description":"The display price is used to show an indicative price for this specific product configuration on your user interface. This price can be used to show the guest a common or marketing related price without requiring further details such as timeslot, pieces, age etc. which would alter the final price. Each individual season can have one or more display prices."}},"required":["product_type_list_price","product_type_sales_price","product_type_display_price"]},"ProductTax":{"title":"Product Tax","description":"Applied tax.","type":"object","readOnly":true,"required":["tax_id","tax_name","tax_amount"],"properties":{"tax_id":{"title":"Tax ID","type":"string","description":"Unique identifier of this tax configuration.","readOnly":true},"tax_name":{"title":"Tax Name","description":"Name of the tax.","type":"string","readOnly":true},"tax_price_type":{"title":"Tax Price Type","description":"Price level for which this tax is applicable.","type":"string","enum":["LIST_PRICE","SALES_PRICE","DISTRIBUTOR_PRICE","RESELLER_PRICE","MARKET_PRICE","SUPPLIER_PRICE"]},"tax_amount":{"title":"Tax Amount","description":"Amount of tax.","type":"string","readOnly":true},"tax_rate":{"title":"Tax Rate","description":"Tax rate (percentage).","type":"string","readOnly":true},"tax_lines":{"$ref":"#/components/schemas/TaxLines"}}},"TaxLines":{"title":"Tax Lines","type":"object","description":"Additional tax lines.","properties":{"tax_lines_id":{"title":"Tax Lines ID","description":"Tax lines ID.","type":"string"},"tax_line_name":{"title":"Tax Line Name","description":"Name of the tax line.","type":"string"},"tax_line_type":{"title":"Tax Line Type","type":"string","description":"Tax abbreviation."},"tax_line_rate":{"title":"Tax Line Rate","type":"string","description":"Tax rate (percentage)."},"tax_line_region":{"title":"Tax Line Region","description":"Country or State of the related tax authority.","type":"string"}}},"Fee":{"title":"Fee","description":"Fee details.","type":"object","readOnly":true,"required":["fee_type","fee_amount","fee_tax_id","fee_tax_amount","fee_included","fee_refundable"],"properties":{"fee_type":{"$ref":"#/components/schemas/FeeType"},"fee_amount":{"title":"Fee Amount","description":"The applicable fee amount, can either be a surcharge or discount.","type":"string","readOnly":true},"fee_percentage":{"title":"Fee Percentage","description":"Fee percentage.","type":"string"},"fee_tax_amount":{"title":"Fee Tax Amount","description":"Amount of tax.","type":"string","readOnly":true},"fee_included":{"title":"Fee Included","description":"Whether this is an additional fee that should be listed separately and included in the `price_total` or is part of a calculation, e.g. margin breakdown (informational only). ","type":"boolean","readOnly":true}}},"FeeType":{"title":"Fee Type","readOnly":true,"description":"Type of fee.\n\nFee Type:\n  * `SERVICE` - The service fee or margin for this transaction or product.\n  * `PARTNER` - The partner fee or margin for this transaction or product.\n  * `DISTRIBUTOR` - The distributor fee or margin for this transaction or product.\n  * `AFFILIATE` - The affiliate fee or margin for this transaction or product.\n  * `RESELLER` - The reseller fee or margin for this transaction or product.\n  * `MARKET_ADMIN` - The market admin fee or margin for this transaction or product.\n  * `PLATFORM` - The platform fee or margin for this transaction or product.\n  * `PAYMENT` - The payment fee for this transaction or product.\n  * `INSURANCE` - The insurance fee for this transaction or product.\n  * `CUSTOM` - Custom fee for this transaction, product or order.","type":"string","enum":["SERVICE","PARTNER","DISTRIBUTOR","AFFILIATE","RESELLER","MARKET_ADMIN","PLATFORM","PAYMENT","INSURANCE","CUSTOM"]},"ProductTypeQuantityVariation":{"title":"Product Type Quantity Variation","description":"Product type quantity variation per piece.","type":"object","properties":{"product_type_quantity_variation_min":{"title":"Product Type Quantity Variation Min","description":"If `product_quantity_pricing:true`; The minimum booking quantity of this type required for this pricing configuration. This value has `product_type_quantity_min` as an absolute minimum.","type":"integer","minimum":1},"product_type_quantity_variation_max":{"title":"Product Type Quantity Variation Max","description":"If `product_quantity_pricing:true`; The maximum booking quantity allowed for this pricing configuration. This value will never exceed `product_type_quantity_max`.","type":"integer","minimum":1},"product_type_quantity_variation_discount":{"title":"Product Type Quantity Variation Discount","description":"Quantity related discount (per piece) applicable to the product type sales price.","type":"string"},"product_type_quantity_variation_amount":{"title":"Product Type Quantity Variation Amount","description":"Quantity related price change (per piece) applicable to the product type sales price.","type":"string"},"product_type_quantity_variation_price_type":{"$ref":"#/components/schemas/PriceVariationPriceType"},"product_type_quantity_variation_fees":{"title":"Product Type Quantity Variation Fees","description":"List of fees. Some fee types are only visible for certain users.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Fee"}}},"required":["product_type_quantity_variation_min","product_type_quantity_variation_amount","product_type_quantity_variation_price_type"]},"PriceVariationPriceType":{"title":"Price Variation Price Type","description":"Whether this price variation applies to the sales or resale price.","type":"string","default":"SALES_PRICE","enum":["SALES_PRICE","RESALE_PRICE"]},"ProductTypeDailyVariation":{"title":"Product Type Daily Variation","description":"Product type daily variation.","type":"object","properties":{"product_type_daily_variation_label":{"title":"Product Type Daily Variation Label","description":"Product type daily variation label.","type":"string"},"product_type_daily_variation_start_date":{"title":"Product Type Daily Variation Start Date","description":"Product type daily variation start date.","type":"string","format":"date-time"},"product_type_daily_variation_end_date":{"title":"Product Type Daily Variation End date","description":"Product type daily variation end date.","type":"string","format":"date-time"},"product_type_daily_variation_start_time":{"title":"Product Type Daily Variation Start Time","description":"Product type daily variation start time.","type":"string","format":"time"},"product_type_daily_variation_end_time":{"title":"Product Type Daily Variation End Time","description":"Product type daily variation end time.","type":"string","format":"time"},"product_type_daily_variation_price_type":{"$ref":"#/components/schemas/PriceVariationPriceType"},"product_type_daily_variation_details":{"title":"Product Type Daily Variation Details","description":"Product type daily variation details.","type":"array","items":{"$ref":"#/components/schemas/ProductTypeDailyVariationDetail"}}},"required":["product_type_daily_variation_start_date","product_type_daily_variation_details"]},"ProductTypeDailyVariationDetail":{"title":"Product Type Daily Variation Detail","description":"If `product_type_daily_variation_day` is empty, then the variation is applicable to the whole week. Otherwise each applicable individual day of the week will be returned. Days cannot be repeated within the same variation.","type":"object","properties":{"product_type_daily_variation_amount":{"title":"Product Type Daily Variation Amount","description":"Product type daily variation amount.","type":"string"},"product_type_daily_variation_day":{"$ref":"#/components/schemas/DayOfTheWeek"},"product_type_daily_variation_fees":{"title":"Product Type Daily Variation Fees","description":"List of fees. Some fee types are only visible for certain users.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Fee"}}},"required":["product_type_daily_variation_amount"]},"DayOfTheWeek":{"title":"Day Of The Week","description":"Day of the a week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"ExtraOptions":{"title":"Product Options","description":"Product options.","type":"object","properties":{"option_id":{"title":"Option ID","description":"Option ID.","type":"string"},"option_name":{"title":"Option Name","description":"(Translatable) Option name.","type":"string","readOnly":true},"option_description":{"title":"Option Description","description":"(Translatable) Option description.","type":"string","readOnly":true},"option_type":{"title":"Extra Option Type","type":"string","readOnly":true,"description":"* `SINGLE` - Single option value is available.\n* `RADIO` - Customer can select only one out of multiple option values.\n* `CHECKBOX` - Customers can select one or more option values.\n* `SHORT_ANSWER` - A one-line input field for text. (UPCOMING)\n* `PARAGRAPH` - A multi-line input field for text. (UPCOMING)\n* `DROPDOWN` - A selection from a dropdown. (UPCOMING)\n* `BOOLEAN` - A yes/no button. (UPCOMING)\n* `DATE` - A date. (UPCOMING)\n* `TIME` - A time. (UPCOMING)\n* `DATETIME` - A date and time. (UPCOMING)\n* `NUMBER` - A number. (UPCOMING)\n* `LOCATION_SEARCH` - A search widget that supports finding matched location given user input from provided location list. (UPCOMING)\n","enum":["SINGLE","RADIO","CHECKBOX","SHORT_ANSWER","PARAGRAPH","DROPDOWN","BOOLEAN","DATE","TIME","DATETIME","NUMBER","LOCATION_SEARCH"]},"option_selection_type":{"title":"Option Selection Type","type":"string","readOnly":true,"description":"* `MANUAL` - Whether the guest is able to select the options himself.\n* `AUTO` - **(ADVANCED)** Whether the option is automatically added to the cart. This only applies to `option_count_type:RESTRICTED`. Only available for `option_type:SINGLE`.\n","enum":["MANUAL","AUTO"]},"option_count_type":{"title":"Option Count Type","type":"string","readOnly":true,"description":"* `FLEXIBLE` - The sum of `option_values.value_count` is not restricted to the `booking quantity` (Product Option) or `product_type_count` (Product Type Option). Do note that it should still adhere to `option_quantity_min` and `option_quantity_max`.\n* `RESTRICTED` - The sum of `option_values.value_count` must be equal to the `booking quantity` (Product Option) or `product_type_count` (Product Type Option).\n","enum":["FLEXIBLE","RESTRICTED"]},"option_count_visible":{"title":"Option Count Visible","description":"Whether the selected quantity should be visible in the cart or shown as combined single price.","type":"boolean"},"option_list_type":{"title":"Option List Type","type":"string","readOnly":true,"description":"Whether to show this option on product level (once on the page), or repeat the option for each selected `product_type` / Person / PAX.\n* `PRODUCT` - Show the option once on product level.\n* `PRODUCT_TYPE` - Show the option for each selected `product_type`.\n","enum":["PRODUCT","PRODUCT_TYPE"]},"option_price_type":{"title":"Option Price Type","type":"string","readOnly":true,"description":"Whether this option has individual pricing for each `product_type` or a fixed amount. If `PRODUCT_TYPE` then the prices will be returned per `value_product_type_id` regardless of whether this is a Product- or Product Type Option.\n* `PRODUCT` - Prices are equal regardless of the selected `product_type`'s. Price is still increased based on the selected quantity.\n* `PRODUCT_TYPE` - Prices are different per `product_type`. For `product_options` this will always be in combination with `option_count_type:RESTRICTED` (as you are unable to determine how many options should be charged for which `product_type`).\n* `INCLUDED` - Prices are already included in the sales price of the product itself. Amounts are shown for informational purposes only.\n","enum":["PRODUCT","PRODUCT_TYPE"]},"option_booking_quantity_min":{"title":"Option Booking Quantity Minimum","type":"integer","readOnly":true,"description":"The minimum booking quantity required for this option to be applicable. The booking quantity is a sum of all values of `product_type_count`."},"option_booking_quantity_max":{"title":"Option Booking Quantity Maximum","type":"integer","readOnly":true,"description":"The maximum booking quantity allowed for this option to be applicable The booking quantity is a sum of all values of `product_type_count`."},"option_quantity_min":{"title":"Option Quantity Minimum","description":"The minimum option count required.  If `option_mandatory:true` and `option_quantity_min` is not set then option count should be equal to `product_type_count`.\n  Option count is a sum of all values of `option_values.value_count`.","type":"integer","default":0,"readOnly":true},"option_quantity_max":{"title":"Option Quantity Maximum","description":"The maximum option count allowed.  If `option_mandatory:true` and `option_quantity_max` is not set then option count should be equal to `product_type_count`.\n  Option count is a sum of all values of `option_values.value_count`.","type":"integer","default":0,"readOnly":true},"option_discount_applicable":{"title":"Option Discount Applicable","description":"Whether any cart or promotional discounts apply on this option.","type":"boolean"},"option_mandatory":{"title":"Option Mandatory","description":"Whether it is mandatory to set this option.","default":false,"type":"boolean","readOnly":true},"option_values":{"title":"Option Values","description":"Option values.","type":"array","items":{"$ref":"#/components/schemas/ExtraOptionValueDetails"}}},"required":["option_id","option_name","option_type","option_selection_type","option_count_type","option_price_type","option_mandatory"]},"ExtraOptionValueDetails":{"title":"Extra Option Value Detail","description":"Extra option value detail.","type":"object","allOf":[{"$ref":"#/components/schemas/ExtraOptionValue"},{"type":"object","properties":{"value_quantity_min":{"title":"Value Quantity Min","description":"Minimum quantity required for this value.","type":"integer","readOnly":true},"value_quantity_max":{"title":"Value Quantity Max","description":"Maximum quantity allowed for this value, can never exceed `option_quantity_max'.","type":"integer","readOnly":true}}}]},"ExtraOptionValue":{"title":"Extra Option Value","description":"Extra option value.","type":"object","properties":{"value_id":{"title":"Value ID","description":"Value ID.","type":"string"},"value_name":{"title":"Value Name","description":"(Translatable) Value name.","type":"string","readOnly":true},"value_price":{"title":"Value Price","description":"The price of this value. In case `option_price_type:PRODUCT_TYPE` then this field will be undefined on `product_options` level.","type":"string","readOnly":true},"value_cost_price":{"title":"Value Cost Price","description":"The cost price of this value.","type":"string","readOnly":true},"value_percentage":{"title":"Value Percentage","description":"Optionally returned if `value_price` is percentage based.","type":"string","readOnly":true},"value_price_tax_id":{"title":"Value Price Tax ID","description":"Tax ID for this product option value. Tax information can be retrieved from the Tax API.","type":"string","readOnly":true},"value_price_tax_amount":{"title":"Value Price Tax Amount","description":"Amount of tax applied for this product option value. Additional tax information can be retrieved from the Tax API.","type":"string","readOnly":true},"value_price_tax_rate":{"title":"Value Price Tax Rate","description":"Tax rate applied for this product option value. Additional tax information can be retrieved from the Tax API.","type":"string","readOnly":true},"value_product_type_id":{"title":"Value Product Type ID","description":"Returned in case this value / option is only applicable to a specific product type (`option_price_type:PRODUCT_TYPE`).","type":"string","readOnly":true}},"required":["value_id"]},"CancellationPolicy":{"title":"Cancellation Policy","description":"Optional fee that may be charged if a cancellation is requested. Either a fixed amount or a set percentage should be charged.","type":"object","additionalProperties":false,"properties":{"cancellation_description":{"title":"Cancellation description","description":"Description of this cancellation policy.","type":"string"},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"cancellation_fee_threshold":{"title":"Cancellation Fee Threshold","type":"integer","description":"The amount of minutes before / after the traveldate / booking date for which this policy is applicable."},"cancellation_fee_percentage":{"title":"Cancellation Fee Percentage","type":"number","format":"double","description":"Percentage of the total booking value that should be charged."},"cancellation_fee_amount":{"title":"Cancellation Fee Amount","description":"Fixed amount that should be charged.","type":"string"}},"required":["cancellation_type"]},"CancellationType":{"title":"Cancellation Type","type":"string","description":"Whether the `cancellation_fee_threshold` is based on the travel date or booking date.","enum":["TRAVEL_DATE","BOOKING_DATE"]},"OpeningTimes":{"title":"Opening Times","description":"Opening times.","type":"object","additionalProperties":false,"properties":{"opening_time_valid_from":{"title":"Opening Time Valid From","description":"Opening time valid from.","type":"string","format":"date"},"opening_time_valid_till":{"title":"Opening Time Valid Till","description":"Opening time valid till.","type":"string","format":"date"},"opening_time_details":{"title":"Opening Time Details","description":"Opening Time Details, based on the days of the week. If unset, the product / venue can be deemed unavailable / closed.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimeDetail"}}},"required":["opening_time_details"]},"OpeningTimeDetail":{"title":"Opening Time Detail","description":"Opening time details.","type":"object","additionalProperties":false,"properties":{"opening_time_day":{"$ref":"#/components/schemas/DayOfTheWeek"},"opening_time_start":{"title":"Opening Time Start","description":"Starting time of a venue for a particular day.","type":"string","format":"time"},"opening_time_end":{"title":"Opening Time End","description":"Closing time of a venue for a particular day.","type":"string","format":"time"}},"required":["opening_time_day"]},"Flag":{"title":"Flag","description":"Flag details. This object will not be returned directly upon booking.","type":"object","required":["flag_id","flag_name","flag_value"],"properties":{"flag_id":{"title":"Flag ID","description":"Flag identifier.","type":"string"},"flag_name":{"title":"Flag Name","description":"Flag name.","type":"string"},"flag_type":{"title":"Flag Type","description":"Type of flag.","type":"string","enum":["TAG","FLAG","CONTENT_LABEL","PARTNER_LABEL","MARKETING_LABEL","FINANCIAL_LABEL","PROMOTION_LABEL"]},"flag_value_id":{"title":"Flag Value ID","description":"Flag value identifier.","type":"string"},"flag_value":{"title":"Flag Value","description":"Flag value.","type":"string"}}},"ProductLocation":{"title":"Product Location","description":"Product location.","allOf":[{"$ref":"#/components/schemas/LocationModel"},{"type":"object","properties":{"location_pickup_point":{"title":"Location Has Pickup Point","type":"boolean","default":false,"description":"Whether this location is a pickup point."}},"required":["location_pickup_point"]}]},"LocationModel":{"title":"Location Model","description":"Location model.","type":"object","additionalProperties":false,"properties":{"location_id":{"title":"Location ID","description":"Unique identifier of this location.","type":"string","readOnly":true},"location_label":{"title":"Location Label","description":"The label for this location.","type":"string"},"location_name":{"title":"Location Name","description":"Returns location name.","type":"string"},"location_description":{"title":"Location Description","description":"Optional description of the location.","type":"string"},"location_url":{"title":"Location URL","description":"The location URL.\n\nCan contain additional information about the location, or for example, show a link to an online video-conference.\n","type":"string","format":"URI"},"location_type":{"$ref":"#/components/schemas/LocationType"},"location_address":{"$ref":"#/components/schemas/AddressModel"},"location_contacts":{"title":"Location Contacts","description":"Location contacts.","type":"array","items":{"$ref":"#/components/schemas/ContactDetails"}},"location_opening_times":{"title":"Location Opening Times","description":"Opening times of this location.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimes"}},"location_custom_fields":{"title":"Location Custom Fields","description":"Freeform entry of any key-value pair.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}}},"required":["location_id","location_name","location_type"]},"LocationType":{"title":"Location Type","description":"Type of location.\n\n <details>\n  <summary>**Location Types**</summary>\n\n  * `SHOP` - Location where tickets can be purchased. Generally also offers the ability for customers to get support.\n  * `COMPANY` - Headquarters or similar location. \n  * `PICKUP` - Location where passengers can be picked-up, tour starts or vouchers can be retrieved.\n  * `POI` - Arbitrary Point-of-Interest.\n  * `VENUE` - Venue of the supplier.\n  * `DEPARTURE` - Departure location.\n  * `START` - Starting point of the product / tour.\n  * `END` - Ending point of the product / tour.\n  * `ENTRY` - Entrance of the venue. Generally for large venues which have multiple entrances.\n  * `DESTINATION` - In case of tours or transport.\n  * `MEETING` - Meeting point.\n  * `INFO` - Generally a location where customers can retrieve more information / support.\n  * `STOP` - In case of tours or transport.\n  * `ONLINE` - (UPCOMING) Activity or information is available online. A `location_url` is likely provided.\n  * `STEP` - A step in a certain tour or transport.\n  * `OTHER` - Any type not listed above.\n  * `UNKNOWN` - Type unknown / not set.\n  \n  </details>","type":"string","default":"VENUE","readOnly":true,"enum":["SHOP","COMPANY","PICKUP","POI","VENUE","DEPARTURE","START","END","ENTRY","DESTINATION","MEETING","INFO","STOP","ONLINE","STEP","OTHER","UNKNOWN"]},"AddressModel":{"title":"Address Model","type":"object","description":"Address details.","properties":{"id":{"title":"Address ID","type":"string","format":"uuid","deprecated":true,"readOnly":true,"description":"Unique address identifier."},"name":{"title":"Address Name","description":"Name / Label of this address / addressee.","type":"string"},"street":{"title":"Address Street","description":"Address line 1 / Street.","type":"string"},"addition":{"title":"Address Addition","description":"Additional address line 2.","type":"string"},"city":{"title":"Address City","description":"Town / City / Village.","type":"string"},"postal_code":{"title":"Address Postal Code","description":"Address postal code.","type":"string"},"region":{"title":"Address Region","description":"State / Province / Region.","type":"string"},"country":{"title":"Address Country","description":"Address country.","type":"string"},"country_code":{"title":"Address Country Code","description":"Returns country code of the product ( [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))","type":"string"},"place_id":{"title":"Address Google Place ID","description":"Google Place ID","type":"string"},"latitude":{"title":"Address Latitude","description":"Address latitude.","type":"string"},"longitude":{"title":"Address Longitude","description":"Address longitude.","type":"string"},"notes":{"title":"Address Note","description":"Address note.","type":"string"}}},"ContactDetails":{"title":"Contact Details","description":"Information on the contact.","type":"object","properties":{"contact_uid":{"title":"Contact User Identifier","description":"A unique contact identifier created by Prio. \n\nIn case this field is left blank, a new contact will be created in the system. If you pass an already existing `contact_uid`, those contact details will be  used and linked to the current/future order. In this case all other fields will be ignored.\n> Only applicable for partners using the Contacts Module (Returning guests). For regular transactions this parameter can be safely ignored.","type":"string","format":"uuid"},"contact_external_uid":{"title":"Contact External User Identifier","description":"Unique external identifier of the contact.","type":"string"},"contact_version":{"title":"Contact Version","description":"Contact version; every time the contact details are updated, a new version is registered.","type":"integer","readOnly":true,"default":1,"multipleOf":1},"contact_number":{"title":"Contact Number","description":"Number of the contact.","type":"string","maxLength":50},"contact_type":{"$ref":"#/components/schemas/ContactType"},"contact_title":{"title":"Contact Title","description":"Title prefix of the contact (Mister / Miss / Misses etc).","type":"string"},"contact_name_first":{"title":"Contact First Name","description":"First name of the contact.","type":"string","maxLength":255},"contact_name_last":{"title":"Contact Last Name","description":"Surname of the contact. If you only have the fullname, we recommend sending it as `contact_name_last` and leaving the `contact_name_first` blank.","type":"string","maxLength":255},"contact_email":{"title":"Contact Email","description":"Email address of the contact.","type":"string","format":"email"},"contact_phone":{"title":"Contact Phone","description":"Must be a valid E.164 spec compliant phone number.","type":"string","format":"phone"},"contact_mobile":{"title":"Contact Phone","description":"Must be a valid E.164 spec compliant phone number.","type":"string","format":"phone"},"contact_language":{"title":"Contact Language","type":"string","description":"Language and culture code of the contact preferred language ([ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1))."},"contact_nationality":{"title":"Contact Nationality","description":"Country code of the contact ([ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)).","type":"string"},"contact_flight_number":{"title":"Contact Flight Number","description":"Contact Flight Number.","type":"string"},"contact_loyalty_number":{"title":"Contact Loyalty Number","description":"Contact Loyalty Number.","type":"string"},"contact_birth_place":{"title":"Contact Birth Place","description":"Place of birth.","type":"string"},"contact_birth_date":{"title":"Contact Birth Date","description":"Date of birth.","type":"string","format":"date"},"contact_passport":{"title":"Contact Passport","description":"Passport details of the contact.","type":"string"},"contact_gender":{"title":"Contact Gender","description":"Gender of the contact.","type":"string","enum":["MALE","FEMALE","OTHER"]},"contact_age":{"title":"Contact Age","description":"Age of the contact.","type":"integer","maximum":150},"contact_room_number":{"title":"Contact Room Number","description":"Contact room number.","type":"string"},"contact_website":{"title":"Contact Website","description":"Contact website.","type":"string","format":"URI"},"contact_company":{"$ref":"#/components/schemas/ContactCompany"},"contact_classification":{"$ref":"#/components/schemas/ContactClassification"},"contact_address":{"$ref":"#/components/schemas/AddressModel"},"contact_notes":{"title":"Contact Notes","description":"Contact notes.","type":"array","items":{"$ref":"#/components/schemas/Note"}},"contact_custom_fields":{"title":"Contact Custom Fields","description":"Freeform entry of any key-value pair.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"contact_created":{"title":"Contact Created","description":"Creation date and time of the contact.","type":"string","format":"date-time","readOnly":true},"contact_modified":{"title":"Contact Modified","description":"Last update date and time of the contact.","type":"string","format":"date-time","readOnly":true}},"required":["contact_created","contact_modified"]},"ContactType":{"title":"Contact Type","description":"Type of contact.\n\nSome supplier systems do not support multiple contacts per orders. In that case we have the following policy:\n1. If set, we sent `contact_type:BOOKER`.\n2. Otherwise, if set, we sent the first `contact_type:CONTACT`.\n3. If both are not set, we sent the first contact in the array.\n\n<details>\n  <summary>**Contact Types**</summary>\n\n* `BOOKER` - Main Booker details (End-consumer). Only a single main booker is recommended. \n  \n  This is the most common type of contact, as it contains information about the person / entity who made the booking.\n  \n  > Any automated emails such as order confirmations will be sent to this contact type. \n\n* `CONTACT` - General, non-specific contact. \n\n  Only use this type if a more specific classification is unknown.\n\n* `GUEST` - Guest / End-consumer / Passenger linked to the booking.\n\n  Defining the guests per booking allows for advanced functionality such as Check-In and passenger management.\n\n* `PARTNER` - Partner details.\n* `STAFF` - General staff.\n* `CASHIER` - Cashier performing the sales.\n* `PAYMENT` - Billing / Financial contact. \n\n  > Payment emails will be sent to this contact type by default.\n\n* `AGENT` - Agent details.\n* `EMERGENCY` - Emergency contact (Guest, host, family member etc.).\n* `GUIDE` - Teacher / Instructor / Guide details.\n* `SUPPLIER` - Supplier details.\n* `VENUE` - Venue details.\n* `HOST` - Host details.\n* `COMPANY` - (Guest) company details.\n* `DELIVERY` - (Guest) Delivery / Shipping contact / address details.\n* `MANAGER` - (UPCOMING) Manager contact.\n* `SUPPORT` - (UPCOMING) Support contact.\n* `INSTRUCTOR` - (UPCOMING) Instructor contact.\n* `OTHER` - Other type of contact, not mentioned above.\n</details>","type":"string","default":"CONTACT","enum":["BOOKER","CONTACT","GUEST","PARTNER","STAFF","CASHIER","PAYMENT","AGENT","EMERGENCY","GUIDE","SUPPLIER","VENUE","HOST","COMPANY","DELIVERY","OTHER"]},"ContactCompany":{"title":"Contact Company","description":"Contact company details.","type":"object","properties":{"company_name":{"title":"Company Name","description":"Company name.","type":"string"},"company_registration_number":{"title":"Company Registration Number","description":"Company registration number.","type":"string"},"company_tax_number":{"title":"Company Tax Number","description":"Company tax number.","type":"string"}}},"ContactClassification":{"title":"Contact Classification","description":"Contact classification.","type":"string","enum":["IMPORTANT","VERY_IMPORTANT","PROBLEMATIC","DISABLED_PERSON","TOP_MANAGEMENT","STAFF","LOYALTY_PROGRAM","MEDIA","FRIEND_OR_FAMILY","RETURNING","PERSONAL","BUSINESS"]},"Note":{"title":"Note","description":"Details on the note.","type":"object","properties":{"note_value":{"title":"Note Value","description":"Note value.","type":"string"},"note_created":{"title":"Note Date","description":"Creation / Modification date of the note.","type":"string","format":"date-time","readOnly":true},"note_recipients":{"title":"Note Recipients","description":"List of accounts that are able to view the note.","type":"array","items":{"title":"Note Recipient","type":"string","description":"Account type of the users receiving / being able to view the note. \n\nFor example when sending a note from the distributor to the supplier, this will indicate the recipient (supplier).\n<details>\n  <summary>**Account Types**</summary>\n  \n  * `GUEST` - Note visible to the guest.\n  \n  * `PARTNER` - Note visible to the partner.\n\n  * `SUPPLIER` - Note visible to the supplier.\n  \n  * `RESELLER` - Note visible to the reseller / supplier admin.\n  \n  * `DISTRIBUTOR` - Note visible to the distributor.\n  \n</details>\n","enum":["GUEST","PARTNER","SUPPLIER","RESELLER","DISTRIBUTOR"]}},"note_creator_account_type":{"title":"Note Creator Account Type","type":"string","description":"Account type of the user who created the note. \n\nFor example when sending a note from the distributor to the supplier, this will indicate the sender (e.g distributor).\n<details>\n  <summary>**Account Types**</summary>\n\n  * `GUEST` - Note created by the guest.\n  \n  * `PARTNER` - Note created by the partner.\n\n  * `SUPPLIER` - Note created by the supplier.\n  \n  * `DISTRIBUTOR` - Note created by the distributor.\n  \n  * `RESELLER` - Note created by the reseller / supplier admin.\n  \n  * `PLATFORM_ADMIN` - Note created by the platform-admin.\n  \n  * `SUPER_ADMIN` - Note created by the super-admin.\n\n</details>\n","enum":["GUEST","PARTNER","SUPPLIER","RESELLER","DISTRIBUTOR"]},"note_creator_user_name":{"title":"Note Creator User Name","type":"string","description":"Name of the user that created this note.","readOnly":true},"note_creator_user_email":{"title":"Note Creator User Email","type":"string","description":"Email of the user that created this note.","readOnly":true},"note_creator_user_role":{"title":"Note Creator User Role","type":"string","description":"Userrole (name) of the user that created this note.","readOnly":true}},"required":["note_value","note_recipients"]},"ProductRelationDetails":{"title":"Product Relation","description":"Details on the Product Relation (sub-products).","type":"object","properties":{"product_id":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string"},"product_parent_id":{"title":"Product Parent ID","description":"Unique identifier for the parent product assigned by Prio.","type":"string","readOnly":true},"product_supplier_id":{"title":"Product Supplier ID","description":"Unique identifier for supplier.","type":"string","readOnly":true},"product_supplier_name":{"title":"Product Supplier Name","description":"Name of the supplier which offers the product(s).","type":"string","readOnly":true},"product_title":{"title":"Product Title","description":"The title of product.","type":"string"},"product_from_price":{"title":"Product From Price","description":"Static From price which can be shown. (Usually regular Adult including discount). Also used for price filtering.","type":"string"},"product_currency_code":{"title":"Product Currency Code","description":"Product Currency Code, according to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","type":"string","readOnly":true},"product_start_date":{"title":"Product Start Date","description":"Starting date of the product.","type":"string","format":"date-time"},"product_end_date":{"title":"Product End Date","description":"End date of the product.","type":"string","format":"date-time"},"product_timepicker_visible":{"title":"Product Timepicker Visible","type":"boolean","default":true,"description":"Whether you should show the timepicker during booking."},"product_traveldate_dependency":{"title":"Product Traveldate Dependency","description":"This addon should be booked on the same date as the main booking.","type":"boolean","default":true},"product_recommended":{"title":"Product Recommended","description":"Whether this product is marked as recommended.","type":"boolean","default":false},"product_booking_window_product_id":{"title":"Product Booking Window Product ID","description":"The booking window dependant product, also called dependencies, indicates the restrictions on sub-ticket bookings in regards to the selected travel-date of another product. This means that some products can only be bought between a fixed booking window relative to another product (booking). This is mainly used in itenaries and tours where external factors such as travel time restrict a guest to book multiple attractions in a short period.\n\nThis dependancy can be set for another (previous) sub-product in this array or the main product of this booking.\n\nOnly applicable if `product_class:COMBI` or `product_addon:true`.","type":"string"},"product_booking_window_start_time":{"title":"Product Booking Window Start Time","type":"integer","description":"The minimum amount of minutes passed after the selected travel date (`booking_travel_date`) or availability slot (`availability_from_date_time`) of the `product_booking_window_product_id`.\n\nOnly applicable if `product_class:COMBI` or `product_addon:true`."},"product_booking_window_end_time":{"title":"Product Booking Window End Time","type":"integer","description":"The maximum amount of minutes allowed after the previously selected travel date (`booking_travel_date`) or availability slot (`availability_from_date_time`) of the `product_booking_window_product_id`.\n\nOnly applicable if `product_class:COMBI` or `product_addon:true`."},"product_class":{"$ref":"#/components/schemas/ProductClass"},"product_admission_type":{"$ref":"#/components/schemas/ProductAdmissionType"},"product_images":{"title":"Product Images","description":"It contains images related to the product.","type":"array","items":{"$ref":"#/components/schemas/Image"}},"product_type_seasons":{"title":"Product Type Seasons","description":"Product types per season.","type":"array","items":{"$ref":"#/components/schemas/ProductTypeSeason"}}},"required":["product_parent_id","product_id","product_supplier_id","product_supplier_name","product_title","product_admission_type","product_currency_code"]},"GuideLanguage":{"title":"Guide Language","type":"object","description":"Language code of the available guide.\n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","required":["language_codes","language_type"],"properties":{"language_codes":{"title":"Language Codes","description":"Language codes.","type":"array","items":{"title":"Language Code","type":"string"}},"language_type":{"title":"Language Type","type":"string","description":"Type of language.","enum":["GUIDE_LIVE","GUIDE_AUDIO","GUIDE_READING"]}}},"AccountType":{"title":"Account Type","description":"Based on the type of account / user role, different details are returned. \n\nThis value defaults and is limited to the scope of your credentials.\n\n <details>\n  <summary>**Account Types**</summary>\n\n  * `GUEST` - Details visible to the guest.\n    \n  * `PARTNER` - Details visible to the partner.\n\n  * `DISTRIBUTOR` - Details visible to the distributor.\n  \n  * `RESELLER` - Details visible to the reseller.\n  \n  * `PLATFORM` - Details visible to the platform.\n  \n  * `SUPER_ADMIN` - Details visible to the super admin.\n  \n  * `MARKET_ADMIN` - Details visible to the market admin.\n  \n  * `SUPPLIER_ADMIN` - Details visible to the supplier admin.\n  \n  * `SUPPLIER` - Details visible to the supplier.\n</details>","type":"string","deprecated":true,"enum":["GUEST","PARTNER","DISTRIBUTOR","RESELLER","PLATFORM","SUPER_ADMIN","MARKET_ADMIN","SUPPLIER_ADMIN","SUPPLIER"]},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products":{"get":{"description":"Retrieve a comprehensive list of all products available via your distributor account. Each product includes core metadata like title, description, availability, and configuration details.\nExtensive filtering is available but do note that certain filters might affect performance.\n> By default only the latest revision will be returned.","summary":"List Products","tags":["Products"],"operationId":"getProducts","parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"name":"product_content_language","in":"query","required":false,"description":"[CONFIG] content language to return in the response. \n\nLanguages are defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. If the defined language is not available, the product will be returned in the `product_default_language`.","schema":{"type":"string"}},{"name":"product_content","in":"query","required":false,"description":"[FILTER] on product content.\n\nSearches the fields:\n  + `product_id`(Upcoming)\n  + `product_title`\n  + `product_short_description`\n  + `product_long_description`\n  + `product_supplier_name`\n  + `product_highlights`\n  + `product_includes`\n  \nRegex used: '(?is)^(?=.*\\\\b(query1.*)\\\\b)(?=.*\\\\b(query2.*)\\\\b).*'\n\n  + Case insensitive.\n  + Positive lookaheads and word boundaries to make word order not matter and to recognize word spacing.","schema":{"title":"Content Search String","type":"string"}},{"name":"product_start_date","in":"query","required":false,"description":"[FILTER] on `product_start_date`.","schema":{"type":"string","format":"date"}},{"name":"product_end_date","in":"query","required":false,"description":"[FILTER] on `product_end_date`.","schema":{"type":"string","format":"date"}},{"name":"product_duration","in":"query","required":false,"description":"[FILTER] on `product_duration`. (Minutes)","schema":{"type":"integer"}},{"name":"product_booking_quantity_min","in":"query","required":false,"description":"[FILTER] on `product_booking_quantity_min`.","schema":{"type":"integer"}},{"name":"product_booking_quantity_max","in":"query","required":false,"description":"[FILTER] on `product_booking_quantity_max`.","schema":{"type":"integer"}},{"name":"product_id","in":"query","required":false,"explode":false,"style":"form","description":"[FILTER] on `product_id`.","schema":{"title":"Product IDs","type":"array","items":{"title":"Product ID","type":"string"}}},{"name":"product_supplier","in":"query","required":false,"explode":false,"style":"form","description":"[FILTER] on `product_supplier_id`.","schema":{"title":"Product Supplier IDs","type":"array","items":{"title":"Product Supplier ID","type":"string"}}},{"name":"product_reseller_id","in":"query","description":"[FILTER] on `product_reseller_id`.","deprecated":true,"required":false,"explode":false,"style":"form","schema":{"title":"Product Reseller IDs","type":"array","items":{"title":"Product Reseller ID","type":"string"}}},{"name":"product_category","in":"query","required":false,"explode":false,"style":"form","description":"[FILTER] on categories (`category_id`).","schema":{"title":"Product Category IDs","type":"array","items":{"title":"Product Category ID","type":"string"}}},{"name":"product_destination","in":"query","required":false,"explode":false,"style":"form","description":"[FILTER] on destinations (`destination_id`).","schema":{"title":"Product Destination IDs","type":"array","items":{"title":"Product Destination ID","type":"string"}}},{"name":"product_tag","in":"query","required":false,"description":"[FILTER] on Tag. \n\nCombination of `product_tag_id`, `product_tag_description` and `product_tag_group`.","explode":false,"style":"form","schema":{"title":"Product Tags","type":"array","items":{"title":"Product Tag","type":"string"}}},{"name":"product_language","in":"query","required":false,"description":"[FILTER] on available product languages. \n\nLanguages are defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. \n\nProducts without a language value will not be returned.","explode":false,"style":"form","schema":{"title":"Product Language Codes","type":"array","items":{"title":"Product Language Code","type":"string"}}},{"name":"product_location_id","in":"query","explode":false,"style":"form","required":false,"description":"[FILTER] on `location_id`.","schema":{"title":"Product Location IDs","type":"array","items":{"title":"Location ID","type":"string"}}},{"name":"product_location_country_code","in":"query","required":false,"explode":false,"style":"form","description":"[FILTER] on country ( [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).","schema":{"title":"Product Location Country Codes","type":"array","items":{"title":"Product Location Country Code","type":"string"}}},{"name":"product_currency_code","in":"query","deprecated":true,"required":false,"explode":false,"style":"form","description":"[FILTER] on Product Currency Code, according to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","schema":{"title":"Product Currency Codes","type":"array","items":{"title":"Product Currency Code","description":"Product Currency Code, according to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","type":"string"}}},{"name":"product_custom_field","in":"query","required":false,"description":"[FILTER] on `product_custom_fields`.","explode":false,"style":"form","schema":{"title":"Product Custom Fields","type":"array","items":{"$ref":"#/components/schemas/CustomField"}}},{"name":"product_type","in":"query","style":"form","explode":false,"required":false,"description":"[FILTER] on Product Type (`product_type`).","schema":{"title":"Product Types","type":"array","items":{"title":"Product Type","type":"string","enum":["ADULT","CHILD","SENIOR","YOUTH","INFANT","PERSON","STUDENT","RESIDENT","MILITARY","IMPAIRED","ITEM","GROUP","FAMILY","CUSTOM"]}}},{"name":"product_status","in":"query","style":"form","explode":false,"required":false,"deprecated":true,"description":"[FILTER] on Product Status (`product_status`).\n> A product can only be sold if the status is `ACTIVE` or `TEST`.\n\n<details>\n  <summary>**Product Statuses**</summary>\n\nProduct Status:\n* `DRAFT` - Product is a draft. \n\n  The product is a draft.\n\n* `REVIEW` - Product is in review. \n\n  The product is in review.\n \n* `ACTIVE` - Product is active.\n\n  The product is fully configured and ready to sell using any linked catalogue (See Product Catalogue Status).\n\n* `EXPIRED` - Product is expired.\n\n  The product configured availability expired and this product is no longer available for sales. \n\n* `ARCHIVED` - Product is archived. \n\n  The product is archived. It can return to `ACTIVE` by unarchiving it.\n\n* `INACTIVE` - Product is inactive.\n\n  The product is set inactive. It should not be visible on any channel and cannot be sold until set to `ACTIVE` again.\n\n* `TEST` - Product is in test.\n\n  The product is fully configured and ready to sell. Similar to `ACTIVE`, but only meant for internal testing purposes. This product should not be exposed to end-consumers.\n\n* `UNAVAILABLE` - Product is unavailable.\n\n  The product is automatically set as unavailable due to an error or misconfiguration. This product requires attention.\n\n* `SUSPENDED` - Product is suspended.\n\n  The product is suspended due to Terms of Service violation.\n\n* `DELETED` - Product is deleted.\n\n  The product is permanently deleted.\n  \n* `PREVIEW` - Product is in preview.\n\n  The product is visible but cannot be booked yet. Generally used during pre-sales. This state is automatically set if the product is `ACTIVE` but did not yet reach the `product_booking_start_date`.\n\n</details>","schema":{"title":"Product Status","type":"array","default":["ACTIVE"],"items":{"title":"Product Status","type":"string","default":"ACTIVE","enum":["DRAFT","REVIEW","ACTIVE","EXPIRED","ARCHIVED","INACTIVE","TEST","UNAVAILABLE","SUSPENDED","DELETED","PREVIEW"]}}},{"name":"product_class","in":"query","style":"form","explode":false,"required":false,"description":"[FILTER] on Product Class (`product_class`).\n<details>\n  <summary>**Product Classes**</summary>\n  \n  * `STANDARD` - Product types in the standard class are the most common and are supported by almost all systems.\n  \n  * `COMBI` - Product is a combi-product. This product is the main combi product and is not bookable on its own. All of the sub-products linked to this combi should be booked as well. These products are listed inside `product_combi_details`.\n  \n  * `CLUSTER` - Product is a cluster-product. This product is the main cluster product and is not bookable. One of the sub-products linked to this cluster should be booked instead. These products are listed inside `product_cluster_details`.\n  \n  * `MERCHANDISE` - \n  \n  * `BUNDLE` - Product is a bundle-product. This product is the main bundle product and is not bookable on its own. All of the sub-products linked to this bundle should be booked as well. These products are listed inside `product_bundle_details`.\n  \n  * `OTHER` - Products in the other/custom class are completely dynamic.\n\n</details>","schema":{"title":"Product Class","type":"array","items":{"title":"Product Class","type":"string","enum":["STANDARD","COMBI","CLUSTER","MERCHANDISE","BUNDLE","OTHER"]}}},{"name":"product_catalogue_status","in":"query","style":"form","explode":false,"required":false,"description":"[FILTER] on Product Catalogue Status (`product_catalogue_status`).\n<details>\n  <summary>**Product Catalogue Statuses**</summary>\n\nProduct Catalogue Status:\n* `PENDING` - Product is pending to be assigned to a catalogue.\n* `INACTIVE` - Product is assigned and inactive on the catalogue.\n* `ACTIVE` - Product is assigned and active on the catalogue.\n</details>","schema":{"title":"Product Catalogue Status","type":"array","items":{"title":"Product Catalogue Status","type":"string","enum":["PENDING","INACTIVE","ACTIVE"]}}},{"name":"product_availability","in":"query","required":false,"description":"[FILTER] Include products with capacity (`product_availability:true`).","schema":{"default":true,"type":"boolean"}},{"name":"product_favorite","in":"query","required":false,"schema":{"type":"boolean"},"description":"[FILTER] Return `product_favorite:true` only."},{"name":"product_planet","in":"query","required":false,"description":"[FILTER] on an astronomical body. *(Reserved for future use)*","schema":{"type":"string","enum":["EARTH","MARS","JUPITER"]}},{"name":"product_modified","in":"query","required":false,"description":"[FILTER] on products modified after the given date. \n\n* This includes newly created products.\n* Deleted products are ignored and should be handled manually.\n\nFor caching purposes we recommend using the `If-Modified-Since` header instead.","schema":{"title":"Product Modified","type":"string","format":"date-time"}},{"name":"product_search_query","in":"query","description":"[SEARCH] on keywords. \n\nThis API provides full-text (wildcard) search capabilities. \n\nOnly results linked to your account will be returned and searching is only available in case cache is enabled (`cache:true`)","schema":{"title":"Search Query","type":"string"}},{"name":"product_view_type","in":"query","required":false,"description":"[CONFIG] **(ADVANCED)** account view type.\n\nThis value defaults and is limited to the scope of your credentials.","schema":{"title":"Account Type","type":"string","enum":["GUEST","PARTNER","DISTRIBUTOR","RESELLER","PLATFORM","SUPER_ADMIN","MARKET_ADMIN","SUPPLIER_ADMIN","SUPPLIER"]}},{"name":"product_sort_by","in":"query","required":false,"description":"[SORT] method.\n<details>\n  <summary>**Sort Methods**</summary>\n\nSort Methods:\n* `PRODUCT_CREATED` - Sort on `product_created`.\n* `PRODUCT_MODIFIED` - Sort on `product_modified`.\n* `PRODUCT_TITLE_A_Z` - Sort on `product_title`.\n* `SUPPLIER_NAME_A_Z` - Sort on `product_supplier_name`.\n* `LOCATION_NAME_A_Z` - Sort on `location_name`.\n* `PRICE_VALUE` - Sort on `product_from_price`.\n\n  Price is sorted based on the current season.\n\n* `DISCOUNT_VALUE` - (Upcoming)\n* `SEARCH_RELEVANCE` - Search results are sorted on match relevance. \n\n  This sorting method should only be used during wildcard (`product_search_query`) searches.\n  \n  If `product_search_query` is empty, it will fallback to `CUSTOM`.\n\n* `CUSTOM` - Custom sort as defined in the catalogues.\n\n  If no custom sorting has been configured it will fallback to `PRODUCT_MODIFIED`.\n\n</details>","schema":{"title":"Product Sort By","description":"Method of sorting.","type":"string","default":"PRODUCT_MODIFIED","enum":["PRODUCT_CREATED","PRODUCT_MODIFIED","PRODUCT_TITLE_A_Z","SUPPLIER_NAME_A_Z","LOCATION_NAME_A_Z","PRICE_VALUE","DISCOUNT_VALUE","SEARCH_RELEVANCE","CUSTOM"]}},{"name":"product_sort_order","in":"query","required":false,"description":"[SORT] keyword used to sort result sets in either ascending or descending order.","schema":{"title":"Product Sort Order","description":"Order of sorting.","type":"string","default":"DESC","enum":["ASC","DESC"]}},{"$ref":"#/components/parameters/ItemsPerPage"},{"$ref":"#/components/parameters/StartIndex"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/Cache"},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product List Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
````

## List Product Details

> This API provides all the product information that is available in the Prio system for the requested product (\`product\_id\`).

````json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"Cache":{"name":"cache","in":"query","required":false,"description":"[CACHE] Whether the results should be loaded from the caching server. This will significantly improve performance and disabling this functionality is not recommended.","schema":{"title":"Cache","type":"boolean","default":true}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"ProductDetailResponse":{"title":"Product Detail Response","description":"Product detail response.","type":"object","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/ProductDetailData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"ProductDetailData":{"title":"Product Detail Data","description":"Product detail data.","type":"object","properties":{"kind":{"$ref":"#/components/schemas/Kind"},"product":{"$ref":"#/components/schemas/ProductModel"}},"required":["kind","product"]},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"ProductModel":{"title":"Product Model","description":"Product model.","type":"object","additionalProperties":false,"properties":{"product_id":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string","readOnly":true},"product_external_id":{"title":"Product External ID","description":"Unique identifier for the product assigned by the third party.","type":"string"},"product_internal_reference":{"title":"Product Internal Reference","description":"Internal Reference / SKU for the product.","type":"string"},"product_platform_id":{"title":"Product Platform ID","description":"Unique identifier of the platform.","type":"string","deprecated":true,"readOnly":true},"product_platform_name":{"title":"Product Platform Name","description":"Name of the platform.","type":"string","deprecated":true,"readOnly":true},"product_distributor_id":{"title":"Product Distributor ID","description":"Unique identifier for the distributor.","type":"string","readOnly":true},"product_distributor_name":{"title":"Product Distributor Name","description":"Name of the distributor.","type":"string","readOnly":true},"product_reseller_id":{"title":"Product Reseller ID.","description":"Unique identifier of the reseller.","type":"string","readOnly":true},"product_reseller_name":{"title":"Product Reseller Name","description":"Name of the reseller.","type":"string","readOnly":true},"product_market_admin_id":{"title":"Product Market Admin ID","description":"Unique identifier for the market admin.","type":"string","readOnly":true},"product_market_admin_name":{"title":"Product Market Admin Name","description":"Name of the market admin.","type":"string","readOnly":true},"product_supplier_admin_id":{"title":"Product Supplier Admin ID","description":"Unique identifier for the supplier admin.","type":"string","readOnly":true},"product_supplier_admin_name":{"title":"Product Supplier Admin Name","description":"Name of the supplier admin.","type":"string","readOnly":true},"product_supplier_id":{"title":"Product Supplier ID","description":"Unique identifier for supplier.","type":"string"},"product_source_id":{"title":"Product Source ID","type":"string","description":"Unique ID of the product source.","readOnly":true},"product_source_name":{"title":"Product Source Name","type":"string","description":"Source of the product. \n\nEither PrioTicket or the name of the other reservation system e.g. CSS.","readOnly":true},"product_contract_source_id":{"title":"Product Contract Source ID","type":"string","description":"Contract source id."},"product_contract_source_name":{"title":"Product Contract Source Name","type":"string","description":"Contract source of the product. \n\nEither PrioTicket or the name of the contracting party."},"product_default_language":{"title":"Product Default Language","description":"Default Supplier Language. \n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","type":"string","default":"en"},"product_version":{"title":"Product Version","description":"Product version.","type":"integer"},"product_color":{"title":"Product Color","description":"Color of the product. (HEX)","type":"string"},"product_slug":{"title":"Product Slug","description":"SEO friendly slug which can be used during URL building.","type":"string"},"product_supplier_url":{"title":"Product Supplier URL","type":"string","format":"uri","readOnly":true},"product_supplier_key_public":{"title":"Product Supplier Public Key","description":"Supplier public key (Internal use only).","type":"string"},"product_from_price":{"title":"Product From Price","description":"Static from price which can be shown on the main product tile. (Usually regular Adult including discount and season independent).","type":"string"},"product_start_date":{"title":"Product Start Date","description":"Starting date of product.","type":"string","format":"date-time"},"product_end_date":{"title":"Product End date","description":"End date of the product.","type":"string","format":"date-time"},"product_booking_start_date":{"title":"Product Booking Start Date","description":"The earliest date on which the product is available for sale. This can be earlier than the `product_start_date`.","type":"string","format":"date-time"},"product_booking_end_date":{"title":"Product Booking End Date","description":"The date on which the product is no longer available for sale. This can be earlier than the `product_end_date`.","type":"string","format":"date-time","deprecated":true},"product_booking_advance_time_min":{"title":"Product Booking Advance Time Min","type":"integer","description":"The minimum amount of minutes you are required to book in advance to the selected travel date (`booking_travel_date`) or availability slot (`availability_from_date_time`)."},"product_booking_advance_time_max":{"title":"Product Booking Advance Time Max","type":"integer","description":"The maximum amount of minutes you are allowed to book in advance to the selected travel date (`booking_travel_date`) or availability slot (`availability_from_date_time`)."},"product_booking_advance_time_min_type":{"title":"Product Booking Advance Time Min Type","type":"string","readOnly":true,"enum":["TIMESLOT_START_TIME","TIMESLOT_END_TIME","VENUE_OPENING_TIME","VENUE_CLOSING_TIME","TRAVEL_START_DATE"]},"product_booking_advance_time_max_type":{"title":"Product Booking Advance Time Max Type","type":"string","readOnly":true,"enum":["TIMESLOT_START_TIME","TIMESLOT_END_TIME","TRAVEL_START_DATE"]},"product_booking_quantity_min":{"title":"Product Booking Quantity Max","description":"The minimum amount of available seats/spot/places/services required per product booking. ","type":"integer","multipleOf":1},"product_booking_quantity_max":{"title":"Product Booking Quantity Max","description":"The maximum amount of available seats/spots/places/services allowed per product booking.","type":"integer","multipleOf":1,"maximum":500},"product_turnout_time":{"title":"Product Turnout Time","description":"The amount of minutes at which guests should arrive prior to the start time of the reservation.\n\nFor example: You need to be at the meeting point 15 minutes in advance.","type":"integer"},"product_duration":{"title":"Product Duration","description":"Duration of product / tour/ service in minutes.","type":"integer"},"product_show_capacity_count":{"title":"Product Show Capacity Count","description":"The value from which the current capacity should be shown to the customer.\n\nOnly applicable if `product_capacity:true`.","type":"integer"},"product_third_party":{"title":"Product Third Party","description":"Whether the product is from a third party.","type":"boolean","default":false},"product_seasonal_pricing":{"title":"Product Seasonal Pricing","description":"Whether pricing can differentiate between specific date ranges (Product types can be returned more than once with different settings).","type":"boolean","default":false,"readOnly":true},"product_quantity_pricing":{"title":"Product Quantity Pricing","description":"Different pricing based on the booking quantity.","type":"boolean","default":false,"readOnly":true},"product_daily_pricing":{"title":"Product Daily Pricing","description":"Whether pricing can differentiate between specific days.","type":"boolean","default":false,"readOnly":true},"product_dynamic_pricing":{"title":"Product Dynamic Pricing","description":"Whether pricing can differentiate between specific availability slots (e.g. Peakhours).","type":"boolean","default":false,"readOnly":true},"product_relation_details_visible":{"title":"Product Relation Details Visible","type":"boolean","default":false,"description":"Whether you should show the underlying details of the linked sub-products. Only applicable if either `product_class:CLUSTER`, `product_class:COMBI` or `product_addon:true`."},"product_timepicker_visible":{"title":"Product Timepicker Visible","type":"boolean","default":true,"description":"Whether you should show the timepicker during booking."},"product_cluster":{"title":"Product Has Cluster","description":"Product is a cluster-product. In case this value is indicated as `true`, this product is the main cluster product and is not bookable. One of the sub-products linked to this cluster should be booked instead. These products are listed inside `product_cluster_details`.","type":"boolean","readOnly":true,"default":false},"product_combi":{"title":"Product Has Combi","description":"Product is a combi-product. In case this value is indicated as `true`, this product is the main combi product and is not bookable on its own. All of the sub-products linked to this combi should be booked as well. These products are listed inside `product_combi_details`.","type":"boolean","readOnly":true,"default":false},"product_bundle":{"title":"Product Has Bundle","description":"Product is a bundle-product. In case this value is indicated as `true`, this product is the main bundle product and is not bookable on its own. All of the sub-products linked to this bundle should be booked as well. These products are listed inside `product_bundle_details`.","type":"boolean","readOnly":true,"default":false},"product_addon":{"title":"Product Has Addon","description":"Product has one or more addon-products. In case this value is indicated as `true`, this product has one or more optional addons. All of the optional addons are listed inside `product_addon_details`.","type":"boolean","readOnly":true,"default":false},"product_availability":{"title":"Product Has Availability","type":"boolean","description":"Whether it is required to select an availability slot to make a booking request. \n\nIn case (`product_class:CLUSTER` or `product_class:COMBI`) and `product_availability:true` then the product has shared capacity (`product_capacity_type:SHARED`) across the sub-products. \n\nIf `product_availability:false` then this main cluster/combi product does not have shared capacity across the sub-products and therefore those should be checked individually. \n\nCheck `product_admission_type` for more details.","default":true},"product_availability_assigned":{"title":"Product Has Assigned Availability","type":"boolean","description":"Whether availability slots are assigned to a specific `spot`. In case `product_availability_assigned:true` assigned 'spots' will be returned once a booking is confirmed (using a best available seat algorithm).\n\nOptionally, if seatmaps are being supported, you are able to send your own selected seats.","default":false,"readOnly":true},"product_capacity":{"title":"Product Has Limited Capacity","type":"boolean","description":"Whether this product has managed (limited) capacity. \n\nCheck `product_capacity_type` for more details.","default":true},"product_traveldate_required":{"title":"Product Traveldate Required","type":"boolean","description":"Whether a traveldate is required upon booking. \nRedundant if availability is selected.","default":false},"product_cancellation_allowed":{"title":"Product Cancellation Allowed","type":"boolean","description":"Whether it is allowed to cancel this product. \n\nNote that even if a product can be cancelled, cancellation fees might still apply.\nPlease check `product_cancellation_policies` for more details.","default":true,"readOnly":true},"product_overbooking_allowed":{"title":"Product Overbooking Allowed","description":"Whether it is allowed to overbook. Not appplicable to third party products.","type":"boolean","default":false,"readOnly":true},"product_past_date_booking_allowed":{"title":"Product Past Date Booking Allowed","type":"boolean","description":"Whether it is allowed to select a date in the past.","default":false,"readOnly":true},"product_capacity_id":{"title":"Product Capacity ID","description":"Product capacity identifier. ","type":"string","readOnly":true},"product_capacity_shared_id":{"title":"Product Shared Capacity ID","description":"Shared availability / Capacity identifier. \n\nOnly applicable if `capacity_type:SHARED / COMBINED`.","type":"string","readOnly":true},"product_capacity_type":{"$ref":"#/components/schemas/CapacityType"},"product_admission_type":{"$ref":"#/components/schemas/ProductAdmissionType"},"product_status":{"$ref":"#/components/schemas/ProductStatus"},"product_catalogue_status":{"$ref":"#/components/schemas/ProductCatalogueStatus"},"product_class":{"$ref":"#/components/schemas/ProductClass"},"product_service_type":{"$ref":"#/components/schemas/ProductServiceType"},"product_seating_type":{"$ref":"#/components/schemas/ProductSeatingType"},"product_pickup_point":{"title":"Product Pickup","description":"Whether its required to set a pickup point for this product. Details on the available locations are inside `product_locations`.","type":"string","readOnly":true,"enum":["MANDATORY","OPTIONAL","NOT_SET"]},"product_pickup_point_details":{"title":"Product Pickup Points","description":"If `product_pickup_point:MANDATORY/OPTIONAL`, then `pickup_point_details` are required.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/PickupPoint"}},"product_content":{"$ref":"#/components/schemas/ProductContent"},"product_redemption_rules":{"$ref":"#/components/schemas/ProductRedemptionRules"},"product_code_settings":{"$ref":"#/components/schemas/ProductCodeSettings"},"product_payment_detail":{"$ref":"#/components/schemas/ProductPaymentDetails"},"product_type_seasons":{"title":"Product Type Seasons","description":"Product types per season. \nNot returned in case of bundle products.","type":"array","items":{"$ref":"#/components/schemas/ProductTypeSeason"}},"product_options":{"title":"Product Options","description":"General product options.","type":"array","items":{"$ref":"#/components/schemas/ExtraOptions"}},"product_cancellation_policies":{"title":"Product Cancellation Policies","description":"Sometimes a product has a cancellation fee. In that case the order amount might not be refunded in full. If no cancellation policies are set and `product_cancellation_allowed:true` then you can always cancel products until they are redeemed.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/CancellationPolicy"}},"product_opening_times":{"title":"Product Opening Times","description":"Opening times of the product / venue.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimes"}},"product_flags":{"title":"Product Flags","description":"Product flags.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Flag"}},"product_locations":{"title":"Product Locations","description":"Venues / Locations of interested for this product.","type":"array","items":{"$ref":"#/components/schemas/ProductLocation"}},"product_cluster_details":{"title":"Product Clusters","description":"In case `product_class:CLUSTER` the following array will be populated. This array contains all linked cluster-products to this main cluster-product. One of these should be booked instead of the main-product. Depending on the configuration, details and availability might be shared across these products.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductRelationDetails"}},"product_combi_details":{"title":"Product Combi's","description":"The List Products API lists all available product configurations enabled for the distributor.\nIf you have a combination (combi-product) of (Product A + Product B) a third product (Product C) will be created. \n\nThe API will return the following:\n```\nArray [\n   Product A Details {\n    `product_id`:'PRODUCT_ID_A'\n    `product_combi:false`,\n    `product_combi_details`:[])\n   }\n   \n   Product B Details {\n    `product_id`:'PRODUCT_ID_B',\n    `product_combi:false`,\n    `product_combi_details`:[])\n   }\n   \n   Product C Details { \n     `product_id`:'PRODUCT_ID_C'\n     `product_combi:true`, \n     `product_combi_details`:['PRODUCT_ID_A', 'PRODUCT_ID_B')\n   }\n]\n```\nEvery product has a unique ID and acts as a separate entity. Therefore there is no need to handle this logic on your side and you could handle them as separate products. \nIn case `product_class:COMBI` the following array will be populated. This array contains all linked combi-products to this main combi-product. Depending on the configuration, details and availability might be shared across these products.\n* To make a combination booking ALL combi sub-products MUST be set in the booking request as well as the main combi-product itself. Failing to do so will cause an invalid response.\n* All sub-products must be set in the `product_combi_details` object of the main combi-product booking object, else the products will be set as individual bookings. (Some sub-products can be booked as separate products as well)\n* All sub-products will inherited the `product_type_details` configuration of the main combi-product and therefore should not be set.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductRelationDetails"}},"product_bundle_details":{"title":"Product Bundle","description":"In case `product_class:BUNDLE` the following array will be populated. This array contains all linked bundle-products to this main product. All of these should be booked in addition to the main product. ","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductRelationDetails"}},"product_addon_details":{"title":"Product Addons","description":"In case `product_addon:true` the following array will be populated. This array contains all linked addon-products to this main product. One or more of these could be booked in addition to the main product. ","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductRelationDetails"}},"product_categories":{"title":"Product Categories","description":"The categories the product belongs to.","type":"array","items":{"title":"Category","description":"Category.","type":"string"}},"product_recommendations":{"title":"Product Recommendations","description":"The recommendations the product has applied.","type":"array","items":{"title":"Recommendation","description":"Recommendations ID","type":"string"}},"product_destinations":{"title":"Product Destinations","description":"The destinations the product belongs to.","type":"array","readOnly":true,"items":{"title":"Destination","description":"Destination.","type":"string"}},"product_languages":{"title":"Product Languages","description":"Language codes for the available languages of the product, e.g. Shows are available in English and Spanish. \n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","type":"array","items":{"title":"Product Language","description":"Product language.","type":"string"}},"product_content_languages":{"title":"Product Content Languages","description":"Language Codes of the languages for which the product data is available. \n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. This field can be used to show multilingual content on your website.","type":"array","items":{"title":"Content Language Code","type":"string"}},"product_guide_languages":{"title":"Product Guide Languages","description":"Language codes of the available guides.\n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/GuideLanguage"}},"product_routes":{"title":"Product Routes","description":"Array of routes linked to this product.","type":"array","readOnly":true,"items":{"title":"Route ID","type":"string"}},"product_notes":{"title":"Product Notes","description":"Optional notes on this product.","type":"array","items":{"$ref":"#/components/schemas/Note"}},"product_google_categories":{"title":"Product Google Categories","type":"string","readOnly":true,"description":"Comma-separated list of attached Google categories (https://developers.google.com/travel/things-to-do/reference/feed-spec/product-category)."},"product_custom_fields":{"title":"Product Custom Fields","description":"Freeform entry of any key-value pair.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"product_created":{"title":"Product Created","description":"The date on which the product has been created.","type":"string","format":"date-time","readOnly":true},"product_created_name":{"title":"Product Created Name","description":"User who created the product.","type":"string","format":"email","readOnly":true},"product_created_email":{"title":"Product Created Email","description":"Username that created the product.","type":"string","format":"email","readOnly":true},"product_modified":{"title":"Product Modified","description":"The date on which the product has been last modified.","type":"string","format":"date-time","readOnly":true},"product_modified_name":{"title":"Product Modified Name","description":"User who modified the product.","type":"string","format":"email","readOnly":true},"product_modified_email":{"title":"Product Created Email","description":"Username that modified the product.","type":"string","format":"email","readOnly":true},"product_view_type":{"$ref":"#/components/schemas/AccountType"}},"required":["product_id","product_supplier_id","product_market_admin_id","product_market_admin_name","product_source_id","product_source_name","product_start_date","product_booking_start_date","product_default_language","product_admission_type","product_third_party","product_seasonal_pricing","product_quantity_pricing","product_daily_pricing","product_dynamic_pricing","product_relation_details_visible","product_addon","product_availability","product_availability_assigned","product_overbooking_allowed","product_past_date_booking_allowed","product_capacity","product_service_type","product_capacity_type","product_traveldate_required","product_cancellation_allowed","product_content","product_redemption_rules","product_code_settings","product_currency","product_pickup_point","product_content_languages","product_created","product_created_name","product_created_email","product_modified","product_modified_name","product_modified_email","product_view_type"]},"CapacityType":{"title":"Capacity Type","description":"Type of capacity.\n\n<details>\n  <summary>**Capacity Types**</summary>\n\n* `OWN` - This product has his own capacity.\n \n* `SHARED` - This product does not have it's own capacity, instead it uses shared capacity from other products.\n* `COMBINED` - This product has his own capacity combined with the capacity of other products.\n* `NOT_SET` - This product does not have capacity.\n</details>\n","type":"string","readOnly":true,"enum":["OWN","SHARED","COMBINED","NOT_SET"]},"ProductAdmissionType":{"title":"Product Admission Types","type":"string","readOnly":true,"enum":["TIME_PERIOD","TIME_DATE","TIME_POINT","TIME_SLOT","TIME_OPEN"],"description":"<details>\n  <summary>**Product Admission Types**</summary>\n  \n* `TIME_PERIOD` - Customers can arrive at any time between the start (`availability_from_date_time`) and end time (`availability_to_date_time`) of the availability slot. Multiple periods in a single day should be expected.\n  Therefore a date- and timepicker should be shown.\n\n* `TIME_DATE` - Variation on `TIME_PERIOD`, whereas only a single period exists in a day. It is not required to choose between different times within a day, therefore only a datepicker is required.\n  Note that in case the slot includes midnight (two or more days), the day from which the `availability_from_date_time` originated should take precedence.\n\n* `TIME_POINT` - Customers are required to be present at the start time of the availability slot but can leave any time they want.\n* `TIME_OPEN` - Customers can arrive at any time. Availablity is not applicable.\n* `TIME_SLOT` - Customers are required to be present at the start time of the availability slot, and the service is expected to finish at the end time of the slot. </details>\n"},"ProductStatus":{"title":"Product Status","description":"Status of the product.\n> A product can only be sold if the status is `ACTIVE` or `TEST`.\n\n<details>\n  <summary>**Product Statuses**</summary>\n\nProduct Status:\n* `DRAFT` - Product is a draft. \n\n  The product is a draft.\n\n* `REVIEW` - Product is in review. \n\n  The product is in review.\n \n* `ACTIVE` - Product is active.\n\n  The product is fully configured and ready to sell using any linked catalogue (See Product Catalogue Status).\n\n* `EXPIRED` - Product is expired.\n\n  The product configured availability expired and this product is no longer available for sales. \n\n* `ARCHIVED` - Product is archived. \n\n  The product is archived. It can return to `ACTIVE` by unarchiving it.\n\n* `INACTIVE` - Product is inactive.\n\n  The product is set inactive. It should not be visible on any channel and cannot be sold until set to `ACTIVE` again.\n\n* `TEST` - Product is in test.\n\n  The product is fully configured and ready to sell. Similar to `ACTIVE`, but only meant for internal testing purposes. This product should not be exposed to end-consumers.\n\n* `UNAVAILABLE` - Product is unavailable.\n\n  The product is automatically set as unavailable due to an error or misconfiguration. This product requires attention.\n\n* `SUSPENDED` - Product is suspended.\n\n  The product is suspended due to Terms of Service violation.\n\n* `DELETED` - Product is deleted.\n\n  The product is permanently deleted.\n  \n* `PREVIEW` - Product is in preview.\n    \n  The product is visible but cannot be booked yet. Generally used during pre-sales. This state is automatically set if the product is `ACTIVE` but did not yet reach the `product_booking_start_date`.\n\n</details>","type":"string","deprecated":true,"enum":["DRAFT","REVIEW","ACTIVE","EXPIRED","ARCHIVED","INACTIVE","TEST","UNAVAILABLE","SUSPENDED","DELETED","PREVIEW"]},"ProductCatalogueStatus":{"title":"Product Catalogue Status","description":"[FILTER] on Product Catalogue Status (`product_catalogue_status`)..\n<details>\n  <summary>**Product Catalogue Statuses**</summary>\n\nProduct Catalogue Status:\n* `PENDING` - Product is pending to be assigned to a catalogue.\n* `INACTIVE` - Product is assigned and inactive on the catalogue.\n* `ACTIVE` - Product is assigned and active on the catalogue.\n</details>","type":"string","enum":["PENDING","INACTIVE","ACTIVE"]},"ProductClass":{"title":"Product Class","type":"string","readOnly":true,"description":"<details>\n  <summary>**Product Classes**</summary>\n  \n  * `STANDARD` - Product types in the standard class are the most common and are supported by almost all systems.\n  \n  * `COMBI` - Product is a combi-product. This product is the main combi product and is not bookable on its own. All of the sub-products linked to this combi should be booked as well. These products are listed inside `product_combi_details`.\n  \n  * `CLUSTER` - Product is a cluster-product. This product is the main cluster product and is not bookable. One of the sub-products linked to this cluster should be booked instead. These products are listed inside `product_cluster_details`.\n  \n  * `MERCHANDISE` - \n  \n  * `BUNDLE` - Product is a bundle-product. This product is the main bundle product and is not bookable on its own. All of the sub-products linked to this bundle should be booked as well. These products are listed inside `product_bundle_details`.\n  \n  * `ADDON` - \n  \n  * `OTHER` - Products in the other/custom class are completely dynamic.\n\n</details>\n","enum":["STANDARD","COMBI","CLUSTER","MERCHANDISE","BUNDLE","ADDON","OTHER"]},"ProductServiceType":{"title":"Product Service Type","description":"Type of service this product offers.","type":"string","readOnly":true,"deprecated":true,"enum":["ATTRACTION","EVENT","SEATING","RIDE","DINING","FOOD","DELIVERY","MOBILITY","ITINERARY","MERCHANDISE","FLIGHT","HOTEL","TOURS","UNSPECIFIED"]},"ProductSeatingType":{"title":"Product Seating Type","description":"Whether this is a seating-type product and the corresponding seating logic.","type":"string","readOnly":true,"enum":["NONE","BEST_AVAILABLE","SEAT_MAP"]},"PickupPoint":{"title":"Pickup Point","description":"Information on a pickup point.","type":"object","properties":{"pickup_point_id":{"title":"Pickup Point ID","description":"Pickup point ID.","type":"string"},"pickup_point_name":{"title":"Pickup Point Name","description":"Pickup point name / label.","type":"string","readOnly":true},"pickup_point_type":{"$ref":"#/components/schemas/PickupPointType"},"pickup_point_description":{"title":"Pickup Point Description","description":"Pickup point description.","type":"string","readOnly":true},"pickup_point_location":{"title":"Pickup Point Location","description":"Reference to the location details.","type":"string","readOnly":true},"pickup_point_time":{"title":"Pickup Point Time","description":"Time of pickup.","type":"string","format":"time"},"pickup_point_times":{"title":"Pickup Point Times","description":"Times available to select for this pickup point.","type":"array","items":{"title":"Pickup Point Time","description":"Time of pickup.","type":"string","format":"time"}},"pickup_point_duration":{"title":"Pickup Point Duration","description":"Duration of the pickup in minutes.","type":"integer","readOnly":true},"pickup_point_availability_dependency":{"title":"Pickup Point Availability Dependency","description":"Dependency on the selected `availability_slot`.\n\nThe selected (`pickup_point_time` + `pickup_point_duration`) is not allowed to exceed the selected `availability_from_date_time` and therefore only a limited amount of `pickup_point_times` should be shown.","type":"boolean","readOnly":true}},"required":["pickup_point_id","pickup_point_name"]},"PickupPointType":{"title":"Pickup Point Type","description":"Type of pickup point.\n\nPickup Point Type:\n  * `FIXED` - Fixed, pre-defined pickup point.\n   \n  * `CUSTOM` - Custom pickup point.","type":"string","enum":["FIXED","CUSTOM"]},"ProductContent":{"title":"Product Content","description":"All translatable product content.","type":"object","properties":{"product_title":{"title":"Product Title.","description":"The title of product.","type":"string"},"product_supplier_name":{"title":"Product Supplier Name","description":"Name of the supplier which offers the product(s).","type":"string","readOnly":true},"product_duration_text":{"title":"Product Duration Text","description":"Duration of product as contextial representation.","type":"string"},"product_short_description":{"title":"Product Short Description","description":"The short description of product.","type":"string"},"product_long_description":{"title":"Product Long Description","description":"The long description of product.","type":"string"},"product_additional_information":{"title":"Product Additional Information","description":"Additional information shown on the website and voucher.","type":"string"},"product_entry_notes":{"title":"Product Entry Notes","description":"Product entry information. (Know before you go).\nThe user-visible list of important notes, use for details such as age-restrictions or other conditions that make this service unsuitable.\n","type":"string"},"product_booking_url":{"title":"Product Booking URL","description":"Booking URL for this product. The page should include a button to start the booking / checkout flow.","type":"string","format":"URI"},"product_landing_page_view_url":{"title":"Product Landing Page View URL","description":"Product landing page for this product. Link to a list view at a higher level of available tickets and tours, prominently showing this option possibly among other options.","type":"string","format":"URI"},"product_favorite":{"title":"Product Favorite","description":"Indicator that this product is marked as a favorite.","type":"boolean"},"product_highlights":{"title":"Product Highlights","description":"Product highlights.","type":"array","items":{"$ref":"#/components/schemas/Highlight"}},"product_includes":{"title":"Product Includes","description":"Product includes.","type":"array","items":{"$ref":"#/components/schemas/ProductInclude"}},"product_excludes":{"title":"Product Excludes","description":"Product excludes.","type":"array","items":{"$ref":"#/components/schemas/ProductExclude"}},"product_images":{"title":"Product Images","description":"It contains images related to the product.","type":"array","items":{"$ref":"#/components/schemas/Image"}}},"required":["product_title","product_supplier_name","product_short_description","product_long_description"]},"Highlight":{"title":"Product Highlight","description":"Product highlight.","type":"object","additionalProperties":false,"properties":{"highlight_description":{"title":"Highlight Description","description":"Description of the highlight.","type":"string"}}},"ProductInclude":{"title":"Product Include","description":"Product include.","type":"object","additionalProperties":false,"properties":{"include_description":{"title":"Include Description","description":"More detail on the included product.","type":"string"}}},"ProductExclude":{"title":"Product Exclude","description":"Product exclude.","type":"object","additionalProperties":false,"properties":{"exclude_description":{"title":"Exclude Description","description":"More detail on the excluded product.","type":"string"}}},"Image":{"title":"Image","description":"Details on the image.","type":"object","additionalProperties":false,"properties":{"image_type":{"title":"Product Image Type","description":"Product image type.","type":"string","enum":["BANNER","MAIN","DETAIL","THUMBNAIL"]},"image_url":{"title":"Image URL","description":"Image URL.","type":"string","format":"uri"}},"required":["image_type","image_url"]},"ProductRedemptionRules":{"title":"Product Redemption Rules","description":"Rules on the product redemption.","type":"object","readOnly":true,"required":["redemption_has_duration","redemption_count_type"],"properties":{"redemption_has_duration":{"title":"Redemption has duration","description":"In case this product has a fixed duration a countdown will be started based on the `redemption_duration_type`.","type":"boolean","default":false},"redemption_duration_time":{"title":"Redemption Duration Time","description":"The total amount of time in seconds that the pass is supposed to be valid. Only applicable if `redemption_has_duration:true`.","type":"integer"},"redemption_duration_type":{"$ref":"#/components/schemas/RedemptionDurationType"},"redemption_count_type":{"$ref":"#/components/schemas/RedemptionCountType"},"redemption_count_value":{"title":"Redemption Count Value","description":"The amount of times this product can be redeemed. \n\nOnly applicable if `redemption_count_type:LIMITED`.","type":"integer","default":1}}},"RedemptionDurationType":{"title":"Redemption Duration Type","type":"string","default":"SCAN","description":"When the actual countdown starts.\n\nOnly applicable if `redemption_has_duration:true`.\n* `TRAVEL_DATE` - This product countdown starts on the selected traveldate (`booking_travel_date` or `availability_from_date_time`)\n* `BOOKING_DATE` - This product countdown starts on the booking date (directly after purchase).\n* `SCAN` - This product countdown starts after the first scan.\n* `CONVERSION` - This product countdown starts after converting the voucher into a pass.\n","enum":["TRAVEL_DATE","BOOKING_DATE","SCAN","CONVERSION"]},"RedemptionCountType":{"title":"Redemption Count Type","description":"The amount of allowed redemptions for this product.\n\nIf `redemption_has_duration:true`, then this value is ONLY applicable during an active countdown. Otherwise it is a general admission counter.\n* `UNLIMITED` - This product can be redeemed an unlimited amount of times (during the redeem duration).\n* `LIMITED` - This product can be redeemed a limited amount of times (during the redeem duration).\n","type":"string","default":"LIMITED","enum":["UNLIMITED","LIMITED"]},"ProductCodeSettings":{"title":"Product Code Settings","description":"Information on how the product codes are being provided.","readOnly":true,"type":"object","required":["product_code_format","product_code_source","product_code_type","product_group_code","product_combi_code","product_voucher_settings","product_voucher_release_type"],"properties":{"product_code_format":{"$ref":"#/components/schemas/ProductCodeFormat"},"product_code_source":{"$ref":"#/components/schemas/ProductCodeSource"},"product_group_code":{"title":"Product Group Code","description":"Whether this product supports a group code. In this case a code (`product_code`) is returned which is valid for all `product_type`s. This code can be used to allow entry to all persons within that booking without using an individual `product_type_code`.","type":"boolean","default":false},"product_combi_code":{"title":"Product Combi Code","description":"Whether this product supports a combi code. In this case a code (`product_code`) is returned which is valid for all products within a package. This code allows admission to all supplier venues. This is only applicable to combi-products (`product_class:COMBI`).","type":"boolean","default":false},"product_city_card":{"title":"Product City Card","description":"Product is a city card.","type":"boolean","default":false},"product_voucher_settings":{"$ref":"#/components/schemas/ProductVoucherSettings"},"product_code_release_date":{"title":"Product Code Release Date","description":"If `product_code_release_details:DATE_ALLOCATION`, this field will indicate the date on which the voucher codes will be available. Note that if there are multiple voucher release requirements, all must be met prior to this date, otherwise the voucher will be released as soon as the last requirement is fullfilled.\n\nIn case you are subscribed to the Order Notification Event, a webhook will be triggered on this date as well.","type":"string","format":"date-time","deprecated":true},"product_code_release_details":{"title":"Product Code Release Details","description":"Requirements for the voucher codes to be released. All requirements must be met for the voucher to be released.\n\nBy default the vouchers will be released on Order Confirmation. Be aware that if additional requirements are set, the voucher codes might not immediately be released upon Create Booking.\n\nAdditional requirements are only applicable to a very small subset of products.","type":"array","items":{"$ref":"#/components/schemas/VoucherReleaseType"}}}},"ProductCodeFormat":{"title":"Product Code Format","description":"Indicates how the product code should be rendered on the customer voucher.\n\nCode Formats:\n  * `BAR_CODE`\n  * `BAR_CODE_E128`\n  * `BAR_CODE_C128`\n  * `BAR_CODE_C39`\n  * `AZTEC`\n  * `PDF`\n  * `PDF417`\n  * `QR_CODE`\n  * `QR_CODE_WITH_LINK`\n  * `LINK`\n  * `IMAGE`","type":"string","readOnly":true,"enum":["BAR_CODE","BAR_CODE_E128","BAR_CODE_C128","BAR_CODE_C39","AZTEC","PDF","PDF417","QR_CODE","QR_CODE_WITH_LINK","LINK","IMAGE","NONE","OTHER"]},"ProductCodeSource":{"title":"Product Code Source","description":"Indicates the origin of the code.","type":"string","readOnly":true,"enum":["PRIO","EXTERNAL","MANUAL"]},"ProductVoucherSettings":{"title":"Product Voucher Settings","description":"Details on how the voucher should be printed / presented.","type":"string","default":"SINGLE","enum":["PER_PERSON","PER_SUPPLIER","SINGLE"]},"VoucherReleaseType":{"title":"Voucher Release Type","description":"Requirement on when the voucher code will be released.\n> Any additional requirement besides `ORDER_CONFIRMATION` will indicate that you might not receive the voucher codes directly upon \"Create Booking\".\n\nVoucher Release Types:\n * `ORDER_CONFIRMATION` (string) - The order must be confirmed before the vouchers are released.\n \n    This is the most common scenario and in case no other requirements are set the voucher codes can be expected directly upon booking confirmation.\n * `PAYMENT_CONFIRMATION` (string) - The order must be paid before the vouchers are released.\n \n    In case payment is done prior to confirming the booking, the voucher codes can be expected directly upon booking confirmation.\n    \n    This requirement could be applicable on:\n    \n      * `SettlementType:INVOICE`, Upfront payment by invoice.\n      \n      * `SettlementType:VENUE`, Payment is made at venue (`VENUE_ALLOCATION` will likely be returned as well).\n      \n      * `SettlementType:DIRECT`, Payment (-Authorization) is made directly at booking. Note that this indicator is redundant as voucher codes can still be expected directly upon booking confirmation.\n    \n    > Only applicable to Guest Payment. Not applicable to B2B resellers / purchases (Indirect sales / `SettlementType:EXTERNAL`).\n * `SUPPLIER_ALLOCATION` (string) - The vouchers must be (manually) allocated by the supplier before the vouchers are released. Vouchers are not returned directly upon booking confirmation.\n \n    This value will only be returned in case manual supplier allocation is required or if the third-party sub-system is unable to directly allocate the vouchers.\n    \n    Additional work is required to receive the vouchers after the supplier has allocated the vouchers.\n    In most cases the order status will remain `PENDING`.\n * `DATE_ALLOCATION` (string) - The vouchers will be provided at a set date. The date is provided as `product_code_release_date`.\n * `VENUE_ALLOCATION` (string) - The vouchers will be provided at the venue.\n * `MANUAL_ALLOCATION` (string) - The vouchers will be provided manually, outside of the API environment.\n * `NO_ALLOCATION` (string) - The vouchers are not provided nor generated, entry is managed by the venue itself. For example on booking name.","type":"string","default":"ORDER_CONFIRMATION","deprecated":true,"enum":["ORDER_CONFIRMATION","PAYMENT_CONFIRMATION","SUPPLIER_ALLOCATION","DATE_ALLOCATION","MANUAL_ALLOCATION","VENUE_ALLOCATION","NO_ALLOCATION"]},"ProductPaymentDetails":{"title":"Product Payment Details","description":"Details on the payment details for this product.","type":"object","readOnly":true,"properties":{"product_payment_type":{"title":"Product Payment Type","description":"Indicates how the product will be purchased.\n\nPayment Types:\n   * `REQUIRED` (string) - The user has to pay this service at the booking time.\n   * `OPTIONAL` (string) - The user can choose to pre-pay this service at the booking time or later, but it is not required in order to book.\n   * `NOT_SUPPORTED` (string) - Payment is not supported for this service.","type":"string","deprecated":true,"enum":["REQUIRED","OPTIONAL","NOT_SUPPORTED"]},"product_payment_currency":{"$ref":"#/components/schemas/Currency"}}},"Currency":{"title":"Currency Information","description":"The currency information for product prices. According to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","type":"object","additionalProperties":false,"properties":{"currency_code":{"title":"Currency Code","description":"Currency Code, according to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","type":"string"},"currency_language_code":{"title":"Currency Language Code","description":"Currency language code.","deprecated":true,"type":"string"},"currency_region_code":{"title":"Currency Region Code","description":"Currency region code.","type":"string","deprecated":true},"currency_symbol":{"title":"Currency Symbol","description":"Currency symbol.","deprecated":true,"type":"string"},"currency_symbol_position":{"$ref":"#/components/schemas/CurrencySymbolPosition"},"currency_decimal_digits":{"title":"Currency Decimal Digits","description":"Currency decimal digits.","deprecated":true,"type":"integer"},"currency_decimal_delimiter":{"title":"Currency Decimal Delimiter","description":"Currency decimal delimiter.","deprecated":true,"type":"string"},"currency_thousand_delimiter":{"title":"Currency Thousand Delimiter","description":"Currency thousand delimiter.","deprecated":true,"type":"string"},"currency_space_between_amount_and_symbol":{"title":"Currency Space Between Amount and Symbol","description":"Currency space between amount and symbol.","deprecated":true,"type":"boolean","default":true}}},"CurrencySymbolPosition":{"title":"Currency Symbol Position","description":"Currency symbol position.","deprecated":true,"type":"string","enum":["LEFT","RIGHT"]},"ProductTypeSeason":{"title":"Product Type Season","description":"Details on a single product type season.","type":"object","properties":{"product_type_season_label":{"title":"Product Type Season Label","type":"string","description":"Optional label for this season. Only applicable if set and `product_seasonal_pricing:true."},"product_type_season_start_date":{"title":"Product Type Season Start Date","description":"Start date of this season.","format":"date-time","type":"string"},"product_type_season_end_date":{"title":"Product Type Season End Date","description":"End date of this season.","type":"string","format":"date-time"},"product_type_season_details":{"title":"Product Type Season Details","description":"Contains information related to the different product type versions in this season.","type":"array","items":{"$ref":"#/components/schemas/ProductTypeDetails"}}},"required":["product_type_season_start_date","product_type_season_details"]},"ProductTypeDetails":{"title":"Product Type Details","description":"Details on a single product type.","type":"object","properties":{"product_type":{"$ref":"#/components/schemas/ProductType"},"product_type_class":{"$ref":"#/components/schemas/ProductTypeClass"},"product_type_variant_id":{"title":"Product Type Variant ID","description":"Unique identifier for this product type variant.","type":"string","deprecated":true,"readOnly":true},"product_type_id":{"title":"Product Type ID","type":"string","readOnly":true},"product_parent_type_id":{"title":"Product Parent Type ID","description":"In case of bundle products, this field indicated the related parent type ID. This can be used to simplify the booking process by bundling the product type selection.","type":"string"},"product_type_label":{"title":"Product Type Label","description":"(Translatable) The actual label to show on your front-end.","type":"string"},"product_type_description":{"title":"Product Type Description","type":"string","description":"(Translatable) Optional description of this product type. If provided, it is highly recommended to show it on your front-end as it might contain important information about the eligibility."},"product_type_age_from":{"title":"Product Type Age From","description":"The starting age for age group.","readOnly":true,"type":"integer","multipleOf":1},"product_type_age_to":{"title":"Product Type Age To","description":"The ending age for age group.  If both `product_type_age_from` and `product_type_age_to` are empty no age-restrictions should be shown. If only `product_type_age_to` is empty, then it is advised to show the age-restriction as e.g. \"22+\".\n","type":"integer","readOnly":true,"multipleOf":1},"product_type_pax":{"title":"Product Type Pax","description":"Number of persons that should be counted in the reporting.","type":"integer","readOnly":true,"minimum":0,"multipleOf":1,"default":1},"product_type_capacity":{"title":"Product Type Capacity","type":"integer","readOnly":true,"minimum":0,"multipleOf":1,"default":1,"description":"Capacity that should be counted / blocked in the system.\n\nFor example:\n\nIf a single table with six seats is booked by two persons, the setup would be as follows:\n\n  ```\n  \"product_type_count\": 1,\n  \"product_type_pax\": 2,\n  \"product_type_capacity\": 6\n  ```\n"},"product_type_quantity_min":{"title":"Product Type Quantity Min","description":"The minimum required quantity to be selected. The `product_type_count` must be equal or higher.","type":"integer","multipleOf":1,"readOnly":true},"product_type_quantity_max":{"title":"Product Type Quantity Max","description":"The maximum allowed quantity to be selected. The `product_type_count` must be equal or lower.","maximum":500,"type":"integer","multipleOf":1,"readOnly":true},"product_type_price_tax_id":{"title":"Product Type Price Tax ID","description":"Tax ID for this product type. Tax information can be retrieved from the Tax API.","type":"string","readOnly":true},"product_type_price_type":{"title":"Product Type Price Type","description":"Whether the price is applicable per individual or fixed for the whole group. \nPrice Type:\n     * `INDIVIDUAL` - Depending on the booking quantity, the price increases.\n     * `GROUP` - The price for this product type is fixed regardless of how many are booked.","type":"string","readOnly":true,"enum":["INDIVIDUAL","GROUP"]},"product_type_pricing":{"$ref":"#/components/schemas/ProductTypePricingExtended"},"product_type_taxes":{"title":"Product Type Taxes","description":"List of taxes. Some tax types are only visible for certain users.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductTax"}},"product_type_fees":{"title":"Product Type Fees","description":"List of fees. Some fee types are only visible for certain users.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Fee"}},"product_type_quantity_variations":{"title":"Product Type Quantity Variations","description":"Only set if `product_quantity_pricing:true`.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProductTypeQuantityVariation"}},"product_type_daily_variations":{"title":"Product Type Daily Variations","description":"Only set if `product_daily_pricing:true`. As an alternative to implementing these prices statically (Content API), they could also be retrieved from the Availability API (`availability_pricing`).","type":"array","items":{"$ref":"#/components/schemas/ProductTypeDailyVariation"}}},"required":["product_type","product_type_id","product_type_pricing"]},"ProductType":{"title":"Product Type","type":"string","description":"Each product contains product types. These product types can offer aged based ticketing (such as Adult and Child), but also provide a variety of other flexible product variations such as group pricing, business and economy seating or different car configurations.\n\nBecause some products might behave different from others, each product type is categorized within a product class; a group of products that behaves similarly.\n<details>\n  <summary>**Product Types**</summary>\n\n  * Class Standard:\n    \n    Product types in the standard class are the most common and are supported by almost all systems. These types will always be age-restricted.\n    \n    Tour and experience providers have the flexibility to vary prices and apply different rules based on the age of their customers. This means they can charge full ticket prices for adults while offering discounted rates for children, or they may have specific requirements such as requiring at least one adult for every group of children booking a tour.\n    \n    During the process of checking prices and proceeding to checkout, customers should be able to select the number of individuals from each available age group for their booking.\n  \n    * `ADULT` - Adult.\n    \n    * `CHILD` - Child.\n    \n    * `SENIOR` - Senior.\n    \n    * `YOUTH` - Youth.\n        \n    * `INFANT` - Infant.\n    \n  * Class Individual:\n  \n    Product types in the individual class are less common and therefore have fewer supported systems. These types will never be age-restricted.\n    \n    * `PERSON` - Person.\n    \n    * `STUDENT` - Student.\n    \n    * `RESIDENT` - Resident.\n    \n    * `MILITARY` - Military.\n    \n    * `IMPAIRED` - Impaired.\n  \n  * Class Item:\n  \n    Product types in the item class do not refer to actual persons, instead they could, for example, be packages (Regular, Silver, Diamond), objects (Merchandise, private tours), a type of event, class identifier (Economy, Business) and much more.\n  \n    * `ITEM` - Item.\n    \n  * Class Group:\n   \n    Product types in the group class always consist of multiple persons. It can, for example, be a family of 2 Adults and 2 Childs.\n    \n    * `GROUP` - Group.\n    \n    * `FAMILY` - Family.\n    \n  * Class Custom:\n  \n    Product types in the custom class are completely dynamic and therefore require explicit mapping with external systems. They do not return as `CUSTOM`, instead they can take any form.\n    \n    * `CUSTOM` - Custom.\n    \n</details>\n","enum":["ADULT","CHILD","SENIOR","YOUTH","INFANT","PERSON","STUDENT","RESIDENT","MILITARY","IMPAIRED","ITEM","GROUP","FAMILY","CUSTOM"]},"ProductTypeClass":{"title":"Product Type Class","type":"string","readOnly":true,"description":"<details>\n  <summary>**Product Type Classes**</summary>\n  \n  * `STANDARD` - Product types in the standard class are the most common and are supported by almost all systems. These types will always be age-restricted.\n  \n  * `INDIVIDUAL` - Product types in the individual class are less common and therefore have fewer supported systems. These types will never be age-restricted.\n  \n  * `ITEM` - Product types in the item class do not refer to actual persons, instead they could, for example, be packages (Regular, Silver, Diamond), objects (Merchandise, private tours), a type of event, class identifier (Economy, Business) and much more.\n  \n  * `GROUP` - Product types in the group class always consist of multiple persons. It can, for example, be a family of 2 Adults and 2 Childs.\n  \n  * `CUSTOM` - Product types in the custom class are completely dynamic and therefore require explicit mapping with external systems. They do not return as CUSTOM, instead they can take any form.\n\n</details>\n","enum":["STANDARD","INDIVIDUAL","ITEM","GROUP","CUSTOM"]},"ProductTypePricingExtended":{"title":"Product Type Pricing","description":"Product Type specific pricing.","type":"object","properties":{"product_type_list_price":{"title":"Product Type List Price","description":"Recommended retail price (RRP). Standard price before discount for the end customer of this product type set by the supplier.","type":"string"},"product_type_discount":{"title":"Product Type Discount","description":"Strike-through discount applicable to `product_type_list_price`.","type":"string","nullable":true,"readOnly":true},"product_type_discount_percentage":{"title":"Product Type Discount Percentage","description":"Strike-through discount percentage. If blank then the Strike-through discount is not based on percentages.","type":"string","readOnly":true},"product_type_sales_price":{"title":"Product Type Sales Price","description":"Standard price after discount for the end-customer set by the reseller. (`product_type_list_price` - `product_type_discount` == `product_type_sales_price`).","type":"string","readOnly":true},"product_type_distributor_price":{"title":"Product Type Resale Price","description":"Price paid by the distributor to the reseller.","type":"string","readOnly":true},"product_type_reseller_price":{"title":"Product Type Reseller price","description":"Price the reseller pays to the market administrator.","type":"string"},"product_type_market_price":{"title":"Product Type Market Price","description":"Price paid by the market admin to the supplier.","type":"string"},"product_type_supplier_price":{"title":"Product Type Supplier Price","type":"string","description":"Optional internal benchmark cost defined by supplier.","readOnly":true},"product_type_display_price":{"title":"Product Type Display Price","type":"boolean","readOnly":true,"description":"The display price is used to show an indicative price for this specific product configuration on your user interface. This price can be used to show the guest a common or marketing related price without requiring further details such as timeslot, pieces, age etc. which would alter the final price. Each individual season can have one or more display prices."}},"required":["product_type_list_price","product_type_sales_price","product_type_display_price"]},"ProductTax":{"title":"Product Tax","description":"Applied tax.","type":"object","readOnly":true,"required":["tax_id","tax_name","tax_amount"],"properties":{"tax_id":{"title":"Tax ID","type":"string","description":"Unique identifier of this tax configuration.","readOnly":true},"tax_name":{"title":"Tax Name","description":"Name of the tax.","type":"string","readOnly":true},"tax_price_type":{"title":"Tax Price Type","description":"Price level for which this tax is applicable.","type":"string","enum":["LIST_PRICE","SALES_PRICE","DISTRIBUTOR_PRICE","RESELLER_PRICE","MARKET_PRICE","SUPPLIER_PRICE"]},"tax_amount":{"title":"Tax Amount","description":"Amount of tax.","type":"string","readOnly":true},"tax_rate":{"title":"Tax Rate","description":"Tax rate (percentage).","type":"string","readOnly":true},"tax_lines":{"$ref":"#/components/schemas/TaxLines"}}},"TaxLines":{"title":"Tax Lines","type":"object","description":"Additional tax lines.","properties":{"tax_lines_id":{"title":"Tax Lines ID","description":"Tax lines ID.","type":"string"},"tax_line_name":{"title":"Tax Line Name","description":"Name of the tax line.","type":"string"},"tax_line_type":{"title":"Tax Line Type","type":"string","description":"Tax abbreviation."},"tax_line_rate":{"title":"Tax Line Rate","type":"string","description":"Tax rate (percentage)."},"tax_line_region":{"title":"Tax Line Region","description":"Country or State of the related tax authority.","type":"string"}}},"Fee":{"title":"Fee","description":"Fee details.","type":"object","readOnly":true,"required":["fee_type","fee_amount","fee_tax_id","fee_tax_amount","fee_included","fee_refundable"],"properties":{"fee_type":{"$ref":"#/components/schemas/FeeType"},"fee_amount":{"title":"Fee Amount","description":"The applicable fee amount, can either be a surcharge or discount.","type":"string","readOnly":true},"fee_percentage":{"title":"Fee Percentage","description":"Fee percentage.","type":"string"},"fee_tax_amount":{"title":"Fee Tax Amount","description":"Amount of tax.","type":"string","readOnly":true},"fee_included":{"title":"Fee Included","description":"Whether this is an additional fee that should be listed separately and included in the `price_total` or is part of a calculation, e.g. margin breakdown (informational only). ","type":"boolean","readOnly":true}}},"FeeType":{"title":"Fee Type","readOnly":true,"description":"Type of fee.\n\nFee Type:\n  * `SERVICE` - The service fee or margin for this transaction or product.\n  * `PARTNER` - The partner fee or margin for this transaction or product.\n  * `DISTRIBUTOR` - The distributor fee or margin for this transaction or product.\n  * `AFFILIATE` - The affiliate fee or margin for this transaction or product.\n  * `RESELLER` - The reseller fee or margin for this transaction or product.\n  * `MARKET_ADMIN` - The market admin fee or margin for this transaction or product.\n  * `PLATFORM` - The platform fee or margin for this transaction or product.\n  * `PAYMENT` - The payment fee for this transaction or product.\n  * `INSURANCE` - The insurance fee for this transaction or product.\n  * `CUSTOM` - Custom fee for this transaction, product or order.","type":"string","enum":["SERVICE","PARTNER","DISTRIBUTOR","AFFILIATE","RESELLER","MARKET_ADMIN","PLATFORM","PAYMENT","INSURANCE","CUSTOM"]},"ProductTypeQuantityVariation":{"title":"Product Type Quantity Variation","description":"Product type quantity variation per piece.","type":"object","properties":{"product_type_quantity_variation_min":{"title":"Product Type Quantity Variation Min","description":"If `product_quantity_pricing:true`; The minimum booking quantity of this type required for this pricing configuration. This value has `product_type_quantity_min` as an absolute minimum.","type":"integer","minimum":1},"product_type_quantity_variation_max":{"title":"Product Type Quantity Variation Max","description":"If `product_quantity_pricing:true`; The maximum booking quantity allowed for this pricing configuration. This value will never exceed `product_type_quantity_max`.","type":"integer","minimum":1},"product_type_quantity_variation_discount":{"title":"Product Type Quantity Variation Discount","description":"Quantity related discount (per piece) applicable to the product type sales price.","type":"string"},"product_type_quantity_variation_amount":{"title":"Product Type Quantity Variation Amount","description":"Quantity related price change (per piece) applicable to the product type sales price.","type":"string"},"product_type_quantity_variation_price_type":{"$ref":"#/components/schemas/PriceVariationPriceType"},"product_type_quantity_variation_fees":{"title":"Product Type Quantity Variation Fees","description":"List of fees. Some fee types are only visible for certain users.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Fee"}}},"required":["product_type_quantity_variation_min","product_type_quantity_variation_amount","product_type_quantity_variation_price_type"]},"PriceVariationPriceType":{"title":"Price Variation Price Type","description":"Whether this price variation applies to the sales or resale price.","type":"string","default":"SALES_PRICE","enum":["SALES_PRICE","RESALE_PRICE"]},"ProductTypeDailyVariation":{"title":"Product Type Daily Variation","description":"Product type daily variation.","type":"object","properties":{"product_type_daily_variation_label":{"title":"Product Type Daily Variation Label","description":"Product type daily variation label.","type":"string"},"product_type_daily_variation_start_date":{"title":"Product Type Daily Variation Start Date","description":"Product type daily variation start date.","type":"string","format":"date-time"},"product_type_daily_variation_end_date":{"title":"Product Type Daily Variation End date","description":"Product type daily variation end date.","type":"string","format":"date-time"},"product_type_daily_variation_start_time":{"title":"Product Type Daily Variation Start Time","description":"Product type daily variation start time.","type":"string","format":"time"},"product_type_daily_variation_end_time":{"title":"Product Type Daily Variation End Time","description":"Product type daily variation end time.","type":"string","format":"time"},"product_type_daily_variation_price_type":{"$ref":"#/components/schemas/PriceVariationPriceType"},"product_type_daily_variation_details":{"title":"Product Type Daily Variation Details","description":"Product type daily variation details.","type":"array","items":{"$ref":"#/components/schemas/ProductTypeDailyVariationDetail"}}},"required":["product_type_daily_variation_start_date","product_type_daily_variation_details"]},"ProductTypeDailyVariationDetail":{"title":"Product Type Daily Variation Detail","description":"If `product_type_daily_variation_day` is empty, then the variation is applicable to the whole week. Otherwise each applicable individual day of the week will be returned. Days cannot be repeated within the same variation.","type":"object","properties":{"product_type_daily_variation_amount":{"title":"Product Type Daily Variation Amount","description":"Product type daily variation amount.","type":"string"},"product_type_daily_variation_day":{"$ref":"#/components/schemas/DayOfTheWeek"},"product_type_daily_variation_fees":{"title":"Product Type Daily Variation Fees","description":"List of fees. Some fee types are only visible for certain users.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/Fee"}}},"required":["product_type_daily_variation_amount"]},"DayOfTheWeek":{"title":"Day Of The Week","description":"Day of the a week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"ExtraOptions":{"title":"Product Options","description":"Product options.","type":"object","properties":{"option_id":{"title":"Option ID","description":"Option ID.","type":"string"},"option_name":{"title":"Option Name","description":"(Translatable) Option name.","type":"string","readOnly":true},"option_description":{"title":"Option Description","description":"(Translatable) Option description.","type":"string","readOnly":true},"option_type":{"title":"Extra Option Type","type":"string","readOnly":true,"description":"* `SINGLE` - Single option value is available.\n* `RADIO` - Customer can select only one out of multiple option values.\n* `CHECKBOX` - Customers can select one or more option values.\n* `SHORT_ANSWER` - A one-line input field for text. (UPCOMING)\n* `PARAGRAPH` - A multi-line input field for text. (UPCOMING)\n* `DROPDOWN` - A selection from a dropdown. (UPCOMING)\n* `BOOLEAN` - A yes/no button. (UPCOMING)\n* `DATE` - A date. (UPCOMING)\n* `TIME` - A time. (UPCOMING)\n* `DATETIME` - A date and time. (UPCOMING)\n* `NUMBER` - A number. (UPCOMING)\n* `LOCATION_SEARCH` - A search widget that supports finding matched location given user input from provided location list. (UPCOMING)\n","enum":["SINGLE","RADIO","CHECKBOX","SHORT_ANSWER","PARAGRAPH","DROPDOWN","BOOLEAN","DATE","TIME","DATETIME","NUMBER","LOCATION_SEARCH"]},"option_selection_type":{"title":"Option Selection Type","type":"string","readOnly":true,"description":"* `MANUAL` - Whether the guest is able to select the options himself.\n* `AUTO` - **(ADVANCED)** Whether the option is automatically added to the cart. This only applies to `option_count_type:RESTRICTED`. Only available for `option_type:SINGLE`.\n","enum":["MANUAL","AUTO"]},"option_count_type":{"title":"Option Count Type","type":"string","readOnly":true,"description":"* `FLEXIBLE` - The sum of `option_values.value_count` is not restricted to the `booking quantity` (Product Option) or `product_type_count` (Product Type Option). Do note that it should still adhere to `option_quantity_min` and `option_quantity_max`.\n* `RESTRICTED` - The sum of `option_values.value_count` must be equal to the `booking quantity` (Product Option) or `product_type_count` (Product Type Option).\n","enum":["FLEXIBLE","RESTRICTED"]},"option_count_visible":{"title":"Option Count Visible","description":"Whether the selected quantity should be visible in the cart or shown as combined single price.","type":"boolean"},"option_list_type":{"title":"Option List Type","type":"string","readOnly":true,"description":"Whether to show this option on product level (once on the page), or repeat the option for each selected `product_type` / Person / PAX.\n* `PRODUCT` - Show the option once on product level.\n* `PRODUCT_TYPE` - Show the option for each selected `product_type`.\n","enum":["PRODUCT","PRODUCT_TYPE"]},"option_price_type":{"title":"Option Price Type","type":"string","readOnly":true,"description":"Whether this option has individual pricing for each `product_type` or a fixed amount. If `PRODUCT_TYPE` then the prices will be returned per `value_product_type_id` regardless of whether this is a Product- or Product Type Option.\n* `PRODUCT` - Prices are equal regardless of the selected `product_type`'s. Price is still increased based on the selected quantity.\n* `PRODUCT_TYPE` - Prices are different per `product_type`. For `product_options` this will always be in combination with `option_count_type:RESTRICTED` (as you are unable to determine how many options should be charged for which `product_type`).\n* `INCLUDED` - Prices are already included in the sales price of the product itself. Amounts are shown for informational purposes only.\n","enum":["PRODUCT","PRODUCT_TYPE"]},"option_booking_quantity_min":{"title":"Option Booking Quantity Minimum","type":"integer","readOnly":true,"description":"The minimum booking quantity required for this option to be applicable. The booking quantity is a sum of all values of `product_type_count`."},"option_booking_quantity_max":{"title":"Option Booking Quantity Maximum","type":"integer","readOnly":true,"description":"The maximum booking quantity allowed for this option to be applicable The booking quantity is a sum of all values of `product_type_count`."},"option_quantity_min":{"title":"Option Quantity Minimum","description":"The minimum option count required.  If `option_mandatory:true` and `option_quantity_min` is not set then option count should be equal to `product_type_count`.\n  Option count is a sum of all values of `option_values.value_count`.","type":"integer","default":0,"readOnly":true},"option_quantity_max":{"title":"Option Quantity Maximum","description":"The maximum option count allowed.  If `option_mandatory:true` and `option_quantity_max` is not set then option count should be equal to `product_type_count`.\n  Option count is a sum of all values of `option_values.value_count`.","type":"integer","default":0,"readOnly":true},"option_discount_applicable":{"title":"Option Discount Applicable","description":"Whether any cart or promotional discounts apply on this option.","type":"boolean"},"option_mandatory":{"title":"Option Mandatory","description":"Whether it is mandatory to set this option.","default":false,"type":"boolean","readOnly":true},"option_values":{"title":"Option Values","description":"Option values.","type":"array","items":{"$ref":"#/components/schemas/ExtraOptionValueDetails"}}},"required":["option_id","option_name","option_type","option_selection_type","option_count_type","option_price_type","option_mandatory"]},"ExtraOptionValueDetails":{"title":"Extra Option Value Detail","description":"Extra option value detail.","type":"object","allOf":[{"$ref":"#/components/schemas/ExtraOptionValue"},{"type":"object","properties":{"value_quantity_min":{"title":"Value Quantity Min","description":"Minimum quantity required for this value.","type":"integer","readOnly":true},"value_quantity_max":{"title":"Value Quantity Max","description":"Maximum quantity allowed for this value, can never exceed `option_quantity_max'.","type":"integer","readOnly":true}}}]},"ExtraOptionValue":{"title":"Extra Option Value","description":"Extra option value.","type":"object","properties":{"value_id":{"title":"Value ID","description":"Value ID.","type":"string"},"value_name":{"title":"Value Name","description":"(Translatable) Value name.","type":"string","readOnly":true},"value_price":{"title":"Value Price","description":"The price of this value. In case `option_price_type:PRODUCT_TYPE` then this field will be undefined on `product_options` level.","type":"string","readOnly":true},"value_cost_price":{"title":"Value Cost Price","description":"The cost price of this value.","type":"string","readOnly":true},"value_percentage":{"title":"Value Percentage","description":"Optionally returned if `value_price` is percentage based.","type":"string","readOnly":true},"value_price_tax_id":{"title":"Value Price Tax ID","description":"Tax ID for this product option value. Tax information can be retrieved from the Tax API.","type":"string","readOnly":true},"value_price_tax_amount":{"title":"Value Price Tax Amount","description":"Amount of tax applied for this product option value. Additional tax information can be retrieved from the Tax API.","type":"string","readOnly":true},"value_price_tax_rate":{"title":"Value Price Tax Rate","description":"Tax rate applied for this product option value. Additional tax information can be retrieved from the Tax API.","type":"string","readOnly":true},"value_product_type_id":{"title":"Value Product Type ID","description":"Returned in case this value / option is only applicable to a specific product type (`option_price_type:PRODUCT_TYPE`).","type":"string","readOnly":true}},"required":["value_id"]},"CancellationPolicy":{"title":"Cancellation Policy","description":"Optional fee that may be charged if a cancellation is requested. Either a fixed amount or a set percentage should be charged.","type":"object","additionalProperties":false,"properties":{"cancellation_description":{"title":"Cancellation description","description":"Description of this cancellation policy.","type":"string"},"cancellation_type":{"$ref":"#/components/schemas/CancellationType"},"cancellation_fee_threshold":{"title":"Cancellation Fee Threshold","type":"integer","description":"The amount of minutes before / after the traveldate / booking date for which this policy is applicable."},"cancellation_fee_percentage":{"title":"Cancellation Fee Percentage","type":"number","format":"double","description":"Percentage of the total booking value that should be charged."},"cancellation_fee_amount":{"title":"Cancellation Fee Amount","description":"Fixed amount that should be charged.","type":"string"}},"required":["cancellation_type"]},"CancellationType":{"title":"Cancellation Type","type":"string","description":"Whether the `cancellation_fee_threshold` is based on the travel date or booking date.","enum":["TRAVEL_DATE","BOOKING_DATE"]},"OpeningTimes":{"title":"Opening Times","description":"Opening times.","type":"object","additionalProperties":false,"properties":{"opening_time_valid_from":{"title":"Opening Time Valid From","description":"Opening time valid from.","type":"string","format":"date"},"opening_time_valid_till":{"title":"Opening Time Valid Till","description":"Opening time valid till.","type":"string","format":"date"},"opening_time_details":{"title":"Opening Time Details","description":"Opening Time Details, based on the days of the week. If unset, the product / venue can be deemed unavailable / closed.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimeDetail"}}},"required":["opening_time_details"]},"OpeningTimeDetail":{"title":"Opening Time Detail","description":"Opening time details.","type":"object","additionalProperties":false,"properties":{"opening_time_day":{"$ref":"#/components/schemas/DayOfTheWeek"},"opening_time_start":{"title":"Opening Time Start","description":"Starting time of a venue for a particular day.","type":"string","format":"time"},"opening_time_end":{"title":"Opening Time End","description":"Closing time of a venue for a particular day.","type":"string","format":"time"}},"required":["opening_time_day"]},"Flag":{"title":"Flag","description":"Flag details. This object will not be returned directly upon booking.","type":"object","required":["flag_id","flag_name","flag_value"],"properties":{"flag_id":{"title":"Flag ID","description":"Flag identifier.","type":"string"},"flag_name":{"title":"Flag Name","description":"Flag name.","type":"string"},"flag_type":{"title":"Flag Type","description":"Type of flag.","type":"string","enum":["TAG","FLAG","CONTENT_LABEL","PARTNER_LABEL","MARKETING_LABEL","FINANCIAL_LABEL","PROMOTION_LABEL"]},"flag_value_id":{"title":"Flag Value ID","description":"Flag value identifier.","type":"string"},"flag_value":{"title":"Flag Value","description":"Flag value.","type":"string"}}},"ProductLocation":{"title":"Product Location","description":"Product location.","allOf":[{"$ref":"#/components/schemas/LocationModel"},{"type":"object","properties":{"location_pickup_point":{"title":"Location Has Pickup Point","type":"boolean","default":false,"description":"Whether this location is a pickup point."}},"required":["location_pickup_point"]}]},"LocationModel":{"title":"Location Model","description":"Location model.","type":"object","additionalProperties":false,"properties":{"location_id":{"title":"Location ID","description":"Unique identifier of this location.","type":"string","readOnly":true},"location_label":{"title":"Location Label","description":"The label for this location.","type":"string"},"location_name":{"title":"Location Name","description":"Returns location name.","type":"string"},"location_description":{"title":"Location Description","description":"Optional description of the location.","type":"string"},"location_url":{"title":"Location URL","description":"The location URL.\n\nCan contain additional information about the location, or for example, show a link to an online video-conference.\n","type":"string","format":"URI"},"location_type":{"$ref":"#/components/schemas/LocationType"},"location_address":{"$ref":"#/components/schemas/AddressModel"},"location_contacts":{"title":"Location Contacts","description":"Location contacts.","type":"array","items":{"$ref":"#/components/schemas/ContactDetails"}},"location_opening_times":{"title":"Location Opening Times","description":"Opening times of this location.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimes"}},"location_custom_fields":{"title":"Location Custom Fields","description":"Freeform entry of any key-value pair.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}}},"required":["location_id","location_name","location_type"]},"LocationType":{"title":"Location Type","description":"Type of location.\n\n <details>\n  <summary>**Location Types**</summary>\n\n  * `SHOP` - Location where tickets can be purchased. Generally also offers the ability for customers to get support.\n  * `COMPANY` - Headquarters or similar location. \n  * `PICKUP` - Location where passengers can be picked-up, tour starts or vouchers can be retrieved.\n  * `POI` - Arbitrary Point-of-Interest.\n  * `VENUE` - Venue of the supplier.\n  * `DEPARTURE` - Departure location.\n  * `START` - Starting point of the product / tour.\n  * `END` - Ending point of the product / tour.\n  * `ENTRY` - Entrance of the venue. Generally for large venues which have multiple entrances.\n  * `DESTINATION` - In case of tours or transport.\n  * `MEETING` - Meeting point.\n  * `INFO` - Generally a location where customers can retrieve more information / support.\n  * `STOP` - In case of tours or transport.\n  * `ONLINE` - (UPCOMING) Activity or information is available online. A `location_url` is likely provided.\n  * `STEP` - A step in a certain tour or transport.\n  * `OTHER` - Any type not listed above.\n  * `UNKNOWN` - Type unknown / not set.\n  \n  </details>","type":"string","default":"VENUE","readOnly":true,"enum":["SHOP","COMPANY","PICKUP","POI","VENUE","DEPARTURE","START","END","ENTRY","DESTINATION","MEETING","INFO","STOP","ONLINE","STEP","OTHER","UNKNOWN"]},"AddressModel":{"title":"Address Model","type":"object","description":"Address details.","properties":{"id":{"title":"Address ID","type":"string","format":"uuid","deprecated":true,"readOnly":true,"description":"Unique address identifier."},"name":{"title":"Address Name","description":"Name / Label of this address / addressee.","type":"string"},"street":{"title":"Address Street","description":"Address line 1 / Street.","type":"string"},"addition":{"title":"Address Addition","description":"Additional address line 2.","type":"string"},"city":{"title":"Address City","description":"Town / City / Village.","type":"string"},"postal_code":{"title":"Address Postal Code","description":"Address postal code.","type":"string"},"region":{"title":"Address Region","description":"State / Province / Region.","type":"string"},"country":{"title":"Address Country","description":"Address country.","type":"string"},"country_code":{"title":"Address Country Code","description":"Returns country code of the product ( [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))","type":"string"},"place_id":{"title":"Address Google Place ID","description":"Google Place ID","type":"string"},"latitude":{"title":"Address Latitude","description":"Address latitude.","type":"string"},"longitude":{"title":"Address Longitude","description":"Address longitude.","type":"string"},"notes":{"title":"Address Note","description":"Address note.","type":"string"}}},"ContactDetails":{"title":"Contact Details","description":"Information on the contact.","type":"object","properties":{"contact_uid":{"title":"Contact User Identifier","description":"A unique contact identifier created by Prio. \n\nIn case this field is left blank, a new contact will be created in the system. If you pass an already existing `contact_uid`, those contact details will be  used and linked to the current/future order. In this case all other fields will be ignored.\n> Only applicable for partners using the Contacts Module (Returning guests). For regular transactions this parameter can be safely ignored.","type":"string","format":"uuid"},"contact_external_uid":{"title":"Contact External User Identifier","description":"Unique external identifier of the contact.","type":"string"},"contact_version":{"title":"Contact Version","description":"Contact version; every time the contact details are updated, a new version is registered.","type":"integer","readOnly":true,"default":1,"multipleOf":1},"contact_number":{"title":"Contact Number","description":"Number of the contact.","type":"string","maxLength":50},"contact_type":{"$ref":"#/components/schemas/ContactType"},"contact_title":{"title":"Contact Title","description":"Title prefix of the contact (Mister / Miss / Misses etc).","type":"string"},"contact_name_first":{"title":"Contact First Name","description":"First name of the contact.","type":"string","maxLength":255},"contact_name_last":{"title":"Contact Last Name","description":"Surname of the contact. If you only have the fullname, we recommend sending it as `contact_name_last` and leaving the `contact_name_first` blank.","type":"string","maxLength":255},"contact_email":{"title":"Contact Email","description":"Email address of the contact.","type":"string","format":"email"},"contact_phone":{"title":"Contact Phone","description":"Must be a valid E.164 spec compliant phone number.","type":"string","format":"phone"},"contact_mobile":{"title":"Contact Phone","description":"Must be a valid E.164 spec compliant phone number.","type":"string","format":"phone"},"contact_language":{"title":"Contact Language","type":"string","description":"Language and culture code of the contact preferred language ([ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1))."},"contact_nationality":{"title":"Contact Nationality","description":"Country code of the contact ([ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)).","type":"string"},"contact_flight_number":{"title":"Contact Flight Number","description":"Contact Flight Number.","type":"string"},"contact_loyalty_number":{"title":"Contact Loyalty Number","description":"Contact Loyalty Number.","type":"string"},"contact_birth_place":{"title":"Contact Birth Place","description":"Place of birth.","type":"string"},"contact_birth_date":{"title":"Contact Birth Date","description":"Date of birth.","type":"string","format":"date"},"contact_passport":{"title":"Contact Passport","description":"Passport details of the contact.","type":"string"},"contact_gender":{"title":"Contact Gender","description":"Gender of the contact.","type":"string","enum":["MALE","FEMALE","OTHER"]},"contact_age":{"title":"Contact Age","description":"Age of the contact.","type":"integer","maximum":150},"contact_room_number":{"title":"Contact Room Number","description":"Contact room number.","type":"string"},"contact_website":{"title":"Contact Website","description":"Contact website.","type":"string","format":"URI"},"contact_company":{"$ref":"#/components/schemas/ContactCompany"},"contact_classification":{"$ref":"#/components/schemas/ContactClassification"},"contact_address":{"$ref":"#/components/schemas/AddressModel"},"contact_notes":{"title":"Contact Notes","description":"Contact notes.","type":"array","items":{"$ref":"#/components/schemas/Note"}},"contact_custom_fields":{"title":"Contact Custom Fields","description":"Freeform entry of any key-value pair.","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"contact_created":{"title":"Contact Created","description":"Creation date and time of the contact.","type":"string","format":"date-time","readOnly":true},"contact_modified":{"title":"Contact Modified","description":"Last update date and time of the contact.","type":"string","format":"date-time","readOnly":true}},"required":["contact_created","contact_modified"]},"ContactType":{"title":"Contact Type","description":"Type of contact.\n\nSome supplier systems do not support multiple contacts per orders. In that case we have the following policy:\n1. If set, we sent `contact_type:BOOKER`.\n2. Otherwise, if set, we sent the first `contact_type:CONTACT`.\n3. If both are not set, we sent the first contact in the array.\n\n<details>\n  <summary>**Contact Types**</summary>\n\n* `BOOKER` - Main Booker details (End-consumer). Only a single main booker is recommended. \n  \n  This is the most common type of contact, as it contains information about the person / entity who made the booking.\n  \n  > Any automated emails such as order confirmations will be sent to this contact type. \n\n* `CONTACT` - General, non-specific contact. \n\n  Only use this type if a more specific classification is unknown.\n\n* `GUEST` - Guest / End-consumer / Passenger linked to the booking.\n\n  Defining the guests per booking allows for advanced functionality such as Check-In and passenger management.\n\n* `PARTNER` - Partner details.\n* `STAFF` - General staff.\n* `CASHIER` - Cashier performing the sales.\n* `PAYMENT` - Billing / Financial contact. \n\n  > Payment emails will be sent to this contact type by default.\n\n* `AGENT` - Agent details.\n* `EMERGENCY` - Emergency contact (Guest, host, family member etc.).\n* `GUIDE` - Teacher / Instructor / Guide details.\n* `SUPPLIER` - Supplier details.\n* `VENUE` - Venue details.\n* `HOST` - Host details.\n* `COMPANY` - (Guest) company details.\n* `DELIVERY` - (Guest) Delivery / Shipping contact / address details.\n* `MANAGER` - (UPCOMING) Manager contact.\n* `SUPPORT` - (UPCOMING) Support contact.\n* `INSTRUCTOR` - (UPCOMING) Instructor contact.\n* `OTHER` - Other type of contact, not mentioned above.\n</details>","type":"string","default":"CONTACT","enum":["BOOKER","CONTACT","GUEST","PARTNER","STAFF","CASHIER","PAYMENT","AGENT","EMERGENCY","GUIDE","SUPPLIER","VENUE","HOST","COMPANY","DELIVERY","OTHER"]},"ContactCompany":{"title":"Contact Company","description":"Contact company details.","type":"object","properties":{"company_name":{"title":"Company Name","description":"Company name.","type":"string"},"company_registration_number":{"title":"Company Registration Number","description":"Company registration number.","type":"string"},"company_tax_number":{"title":"Company Tax Number","description":"Company tax number.","type":"string"}}},"ContactClassification":{"title":"Contact Classification","description":"Contact classification.","type":"string","enum":["IMPORTANT","VERY_IMPORTANT","PROBLEMATIC","DISABLED_PERSON","TOP_MANAGEMENT","STAFF","LOYALTY_PROGRAM","MEDIA","FRIEND_OR_FAMILY","RETURNING","PERSONAL","BUSINESS"]},"Note":{"title":"Note","description":"Details on the note.","type":"object","properties":{"note_value":{"title":"Note Value","description":"Note value.","type":"string"},"note_created":{"title":"Note Date","description":"Creation / Modification date of the note.","type":"string","format":"date-time","readOnly":true},"note_recipients":{"title":"Note Recipients","description":"List of accounts that are able to view the note.","type":"array","items":{"title":"Note Recipient","type":"string","description":"Account type of the users receiving / being able to view the note. \n\nFor example when sending a note from the distributor to the supplier, this will indicate the recipient (supplier).\n<details>\n  <summary>**Account Types**</summary>\n  \n  * `GUEST` - Note visible to the guest.\n  \n  * `PARTNER` - Note visible to the partner.\n\n  * `SUPPLIER` - Note visible to the supplier.\n  \n  * `RESELLER` - Note visible to the reseller / supplier admin.\n  \n  * `DISTRIBUTOR` - Note visible to the distributor.\n  \n</details>\n","enum":["GUEST","PARTNER","SUPPLIER","RESELLER","DISTRIBUTOR"]}},"note_creator_account_type":{"title":"Note Creator Account Type","type":"string","description":"Account type of the user who created the note. \n\nFor example when sending a note from the distributor to the supplier, this will indicate the sender (e.g distributor).\n<details>\n  <summary>**Account Types**</summary>\n\n  * `GUEST` - Note created by the guest.\n  \n  * `PARTNER` - Note created by the partner.\n\n  * `SUPPLIER` - Note created by the supplier.\n  \n  * `DISTRIBUTOR` - Note created by the distributor.\n  \n  * `RESELLER` - Note created by the reseller / supplier admin.\n  \n  * `PLATFORM_ADMIN` - Note created by the platform-admin.\n  \n  * `SUPER_ADMIN` - Note created by the super-admin.\n\n</details>\n","enum":["GUEST","PARTNER","SUPPLIER","RESELLER","DISTRIBUTOR"]},"note_creator_user_name":{"title":"Note Creator User Name","type":"string","description":"Name of the user that created this note.","readOnly":true},"note_creator_user_email":{"title":"Note Creator User Email","type":"string","description":"Email of the user that created this note.","readOnly":true},"note_creator_user_role":{"title":"Note Creator User Role","type":"string","description":"Userrole (name) of the user that created this note.","readOnly":true}},"required":["note_value","note_recipients"]},"CustomField":{"title":"Custom Field","type":"object","description":"Custom Fields allow you to store and list any arbitrary value in the system.\n\nThis metadata are data elements that you create yourself. When you add metadata to your request, they are echoed in the response so that you can connect the transaction to your metadata. For example, to add a shift number and an employee ID to a transaction. You are free to create metadata fields, even encoded, as long as the datatype is a string.","properties":{"custom_field_name":{"title":"Custom Field Name","type":"string","description":"Unique Name / Identifier for this field."},"custom_field_value":{"title":"Custom Field Value","type":"string","description":"Freeform value of this field."},"custom_field_type":{"$ref":"#/components/schemas/CustomFieldType"}}},"CustomFieldType":{"title":"Custom Field Type","type":"string","deprecated":true,"description":"Custom Field Type:\n  * `SYSTEM` - This field is only stored and returned in the API. Only visible to the system.\n  * `USER` - This value is stored and visualized, can be shown in a customized fashion in other modules.","enum":["SYSTEM","USER"]},"ProductRelationDetails":{"title":"Product Relation","description":"Details on the Product Relation (sub-products).","type":"object","properties":{"product_id":{"title":"Product ID","description":"Unique identifier for the product assigned by Prio.","type":"string"},"product_parent_id":{"title":"Product Parent ID","description":"Unique identifier for the parent product assigned by Prio.","type":"string","readOnly":true},"product_supplier_id":{"title":"Product Supplier ID","description":"Unique identifier for supplier.","type":"string","readOnly":true},"product_supplier_name":{"title":"Product Supplier Name","description":"Name of the supplier which offers the product(s).","type":"string","readOnly":true},"product_title":{"title":"Product Title","description":"The title of product.","type":"string"},"product_from_price":{"title":"Product From Price","description":"Static From price which can be shown. (Usually regular Adult including discount). Also used for price filtering.","type":"string"},"product_currency_code":{"title":"Product Currency Code","description":"Product Currency Code, according to [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217).","type":"string","readOnly":true},"product_start_date":{"title":"Product Start Date","description":"Starting date of the product.","type":"string","format":"date-time"},"product_end_date":{"title":"Product End Date","description":"End date of the product.","type":"string","format":"date-time"},"product_timepicker_visible":{"title":"Product Timepicker Visible","type":"boolean","default":true,"description":"Whether you should show the timepicker during booking."},"product_traveldate_dependency":{"title":"Product Traveldate Dependency","description":"This addon should be booked on the same date as the main booking.","type":"boolean","default":true},"product_recommended":{"title":"Product Recommended","description":"Whether this product is marked as recommended.","type":"boolean","default":false},"product_booking_window_product_id":{"title":"Product Booking Window Product ID","description":"The booking window dependant product, also called dependencies, indicates the restrictions on sub-ticket bookings in regards to the selected travel-date of another product. This means that some products can only be bought between a fixed booking window relative to another product (booking). This is mainly used in itenaries and tours where external factors such as travel time restrict a guest to book multiple attractions in a short period.\n\nThis dependancy can be set for another (previous) sub-product in this array or the main product of this booking.\n\nOnly applicable if `product_class:COMBI` or `product_addon:true`.","type":"string"},"product_booking_window_start_time":{"title":"Product Booking Window Start Time","type":"integer","description":"The minimum amount of minutes passed after the selected travel date (`booking_travel_date`) or availability slot (`availability_from_date_time`) of the `product_booking_window_product_id`.\n\nOnly applicable if `product_class:COMBI` or `product_addon:true`."},"product_booking_window_end_time":{"title":"Product Booking Window End Time","type":"integer","description":"The maximum amount of minutes allowed after the previously selected travel date (`booking_travel_date`) or availability slot (`availability_from_date_time`) of the `product_booking_window_product_id`.\n\nOnly applicable if `product_class:COMBI` or `product_addon:true`."},"product_class":{"$ref":"#/components/schemas/ProductClass"},"product_admission_type":{"$ref":"#/components/schemas/ProductAdmissionType"},"product_images":{"title":"Product Images","description":"It contains images related to the product.","type":"array","items":{"$ref":"#/components/schemas/Image"}},"product_type_seasons":{"title":"Product Type Seasons","description":"Product types per season.","type":"array","items":{"$ref":"#/components/schemas/ProductTypeSeason"}}},"required":["product_parent_id","product_id","product_supplier_id","product_supplier_name","product_title","product_admission_type","product_currency_code"]},"GuideLanguage":{"title":"Guide Language","type":"object","description":"Language code of the available guide.\n\nLanguage is defined in [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.","required":["language_codes","language_type"],"properties":{"language_codes":{"title":"Language Codes","description":"Language codes.","type":"array","items":{"title":"Language Code","type":"string"}},"language_type":{"title":"Language Type","type":"string","description":"Type of language.","enum":["GUIDE_LIVE","GUIDE_AUDIO","GUIDE_READING"]}}},"AccountType":{"title":"Account Type","description":"Based on the type of account / user role, different details are returned. \n\nThis value defaults and is limited to the scope of your credentials.\n\n <details>\n  <summary>**Account Types**</summary>\n\n  * `GUEST` - Details visible to the guest.\n    \n  * `PARTNER` - Details visible to the partner.\n\n  * `DISTRIBUTOR` - Details visible to the distributor.\n  \n  * `RESELLER` - Details visible to the reseller.\n  \n  * `PLATFORM` - Details visible to the platform.\n  \n  * `SUPER_ADMIN` - Details visible to the super admin.\n  \n  * `MARKET_ADMIN` - Details visible to the market admin.\n  \n  * `SUPPLIER_ADMIN` - Details visible to the supplier admin.\n  \n  * `SUPPLIER` - Details visible to the supplier.\n</details>","type":"string","deprecated":true,"enum":["GUEST","PARTNER","DISTRIBUTOR","RESELLER","PLATFORM","SUPER_ADMIN","MARKET_ADMIN","SUPPLIER_ADMIN","SUPPLIER"]},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"NotModified":{"description":"Not Modified\n\nThe HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.","headers":{"Last-Modified":{"$ref":"#/components/headers/Last-Modified"}}},"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/{product_id}":{"get":{"description":"This API provides all the product information that is available in the Prio system for the requested product (`product_id`).","summary":"List Product Details","tags":["Products"],"operationId":"getProduct","parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"name":"product_id","in":"path","required":true,"description":"Unique identifier for the product assigned by Prio.","schema":{"type":"string"}},{"name":"product_content_language","in":"query","required":false,"description":"Language code to request language specific product data. If left empty or language is not available (not included in `product_content_languages`), the response will be in the default language i.e. English. The actual language returned can also be found inside the `Content-Language` header.","schema":{"type":"string"}},{"$ref":"#/components/parameters/Cache"},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product Detail Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDetailResponse"}}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
````

## List Product Availabilities (Deprecated)

> The availability API is used to make sure that the product or service is available on the desired date and time slot. \
> \
> Depending on the \`product\_availability\` parameter given in the product feed, the availability needs to be requested using this endpoint prior to making a booking.\
> \
> This endpoint should be called in order to get up-to-date availability information for a product with managed capacity. \
> The response will contain the availability for each time slot of the requested product that lies within the specified date range. \
> \*Availability Logic\*\*\
> Please consult our dedicated "Availability" section for more information on how to use this endpoint. \
> \
> \*\*Caching Recommendations\*\*\
> \
> Please consult our dedicated "Caching" section for more information on how to use this endpoint.   \
> \
> \> ### Notes\
> \> \* Dates and times are always relative to the supplier timezone and all offsets are automatically adjusted based on daylight saving time (DST).\
> \> \* A maximum of 90 days is allowed. If you would like to batch availability for a longer period, please make multiple calls.

````json
{"openapi":"3.0.0","info":{"title":"Distributor API Specification V3.8","version":"3.8.0"},"tags":[{"name":"Products","description":"Manage and retrieve all your products.\n- View your inventory.\n- Get tax information.\n- Extensive search and filter.\n- Retrieve availability and capacity.\n- Get product ratings and reviews.\n\n In most cases, this content is periodically cached on the partner end, but these API endpoints are also optimized for direct front-end use.\n"}],"servers":[{"url":"https://{environment}.prioticket.com/{version}/distributor","description":"Prio environments.","variables":{"environment":{"description":"* `distributor-api` - Production server; used for real transactions.\n\n* `sandbox-distributor-api` - Sandbox server.\n\n* `staging-distributor-api` - Pre-Production server; used for testing (UAT), verification, demo and certification.\n\n* `internal-distributor-api` - Internal server; reserved for internal use.\n","default":"staging-distributor-api","enum":["distributor-api","sandbox-distributor-api","staging-distributor-api","internal-distributor-api"]},"version":{"description":"Api version.","default":"v3.8","enum":["v3.8"]}}}],"security":[{"OAuth2":["https://www.prioticketapis.com/auth/distributor/products"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 implementation.","flows":{"clientCredentials":{"tokenUrl":"https://sandbox-distributor-api.prioticket.com/v3.8/distributor/oauth2/token","scopes":{"https://www.prioticketapis.com/auth/distributor.products.readonly":"Grants access to products.","https://www.prioticketapis.com/auth/distributor.reservations":"Grants access to reservations.","https://www.prioticketapis.com/auth/distributor.bookings":"Grants access to bookings.","https://www.prioticketapis.com/auth/distributor.bookings.details":"Grants access to booking details.","https://www.prioticketapis.com/auth/distributor/reporting":"Grants access to reporting."}}}}},"parameters":{"DistributorIDOptional":{"name":"distributor_id","in":"query","required":false,"description":"[FILTER] on `distributor_id`.","schema":{"type":"string"}},"If-Modified-Since":{"in":"header","name":"If-Modified-Since","description":"[CACHE] The `If-Modified-Since` request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date. \n\nIf the resource has not been modified since, the response will be a 304 without any body; the `Last-Modified` response header of a previous request will contain the date of last modification.\n> Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.","schema":{"title":"If-Modified-Since","type":"string"}}},"headers":{"Cache-Control":{"description":"Specifies the maximum amount of time a resource will be considered fresh. Contrary to Expires, this directive is relative to the time of the request.","schema":{"type":"string"}},"Last-Modified":{"description":"The Last-Modified response HTTP header contains the date and time at which the origin server believes the resource was last modified.","schema":{"type":"string"}},"Content-Language":{"description":"The Content-Language entity header is used to describe the language(s) intended for the audience, so that it allows a user to differentiate according to the users' own preferred language.","schema":{"type":"string"}},"Content-Length":{"description":"The Content-Length entity header indicates the size of the entity-body, in bytes, sent to the recipient.","schema":{"type":"string"}},"Access-Control-Allow-Methods":{"description":"The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.","schema":{"type":"string"}},"Content-Security-Policy":{"description":"Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks.","schema":{"type":"string"}},"X-XSS-Protection":{"description":"The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks.","schema":{"type":"string"}},"X-Content-Type-Options":{"description":"The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised in the Content-Type headers should not be changed and be followed.","schema":{"type":"string"}},"X-RateLimit-Limit":{"deprecated":true,"description":"Request limit per hour.","schema":{"type":"integer","deprecated":true}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"type":"string"}},"Origin":{"description":"The Origin request header indicates where a fetch originates from.","schema":{"type":"string","format":"URI"}}},"schemas":{"AvailabilityVariationListResponse":{"title":"Availabilities Variation List Response","description":"Availabilities list response.","type":"object","properties":{"api_version":{"$ref":"#/components/schemas/ApiVersion"},"data":{"$ref":"#/components/schemas/AvailabilityVariationListResponseData"}},"required":["api_version","data"]},"ApiVersion":{"title":"API Version","description":"Represents the version of the service API that's served in the response.","type":"string","readOnly":true},"AvailabilityVariationListResponseData":{"title":"Availabilities Variation List Response Data","description":"Availabilities list response data.","type":"object","allOf":[{"$ref":"#/components/schemas/ReservedPaginationData"},{"type":"object","properties":{"items":{"title":"Availability Slots","description":"List of all availability slots.","type":"array","items":{"$ref":"#/components/schemas/AvailabilityVariationModel"}}}}],"required":["kind","total_items","items"]},"ReservedPaginationData":{"title":"Reserved Pagination Data","type":"object","description":"The following properties are located in the data object, and help page through a list of items.\nThe paging properties below allow for various styles of paging, including:\n+ Previous/Next paging - Allows user's to move forward and backward through a list, one page at a time. The nextLink and previousLink properties (described in the \"Reserved Property Names for Links\" section below) are used for this style of paging.\n+ Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?startIndex=200.\n+ Page-based paging - Allows user's to jump directly to a specific page within the items. \n\n  This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The pageIndex and totalPages properties are used for this style of paging.","required":["kind","current_item_count","items_per_page","start_index","total_items","page_index","total_pages"],"properties":{"kind":{"$ref":"#/components/schemas/Kind"},"current_item_count":{"title":"Current Item Count","type":"integer","maximum":500,"minimum":0,"description":"The number of items in this result set. Should be equivalent to items.length, and is provided as a convenience property. For example, suppose a developer requests a set of search items, and asks for 10 items per page. The total set of that search has 14 total items. The first page of items will have 10 items in it, so both `items_per_page` and `current_item_count` will equal \"10\". The next page of items will have the remaining 4 items; `items_per_page` will still be \"10\", but `current_item_count` will be \"4\"."},"items_per_page":{"title":"Items Per Page","type":"integer","minimum":0,"maximum":200,"description":"The number of items in the result. This is not necessarily the size of the data.items array; if we are viewing the last page of items, the size of data.items may be less than `items_per_page`. However the size of data.items should not exceed `items_per_page`."},"start_index":{"title":"Start Index","type":"integer","minimum":1,"description":"The index of the first item in data.items. For consistency, `start_index` should be 1-based. For example, the first item in the first set of items should have a `start_index` of 1. If the user requests the next set of data, the `start_index` may be 10."},"total_items":{"title":"Total Items","type":"integer","readOnly":true,"description":"The total number of items available in this set. For example, if a user has 100 blog posts, the response may only contain 10 items, but the `total_items` would be 100.","minimum":0},"page_index":{"title":"Page Index","type":"integer","minimum":1,"description":"The index of the current page of items. For consistency, `page_index` should be 1-based. For example, the first page of items has a `page_index` of 1. `page_index` can also be calculated from the item-based paging properties: `page_index` = floor(`start_index` / `items_per_page`) + 1."},"total_pages":{"title":"Total Pages","type":"integer","minimum":0,"readOnly":true,"description":"The total number of pages in the result set. `total_pages` can also be calculated from the item-based paging properties above: `total_pages` = ceiling(`total_items` / `items_per_page`)"}}},"Kind":{"title":"Kind","description":"The kind property serves as a guide to what type of information this particular object stores.","type":"string","readOnly":true,"enum":["location","route","category","product","currency","tax","addon","availability","stock","reservation","order","promocode","promo","webhook","notification","voucher","contact","payment","credit","destination","recommendation"]},"AvailabilityVariationModel":{"title":"Availability Variation Model","type":"object","allOf":[{"$ref":"#/components/schemas/AvailabilityModel"},{"type":"object","properties":{"availability_pricing":{"title":"Availability Slot Pricing","type":"array","description":"Daily / Dynamic Pricing, only returned in case `product_daily_pricing:true` or `product_dynamic_pricing:true` for this product.\n\nPlease note that in case both are enabled, the combined difference will be returned.","items":{"$ref":"#/components/schemas/AvailabilityPrice"}}}}]},"AvailabilityModel":{"title":"Availability Slot Model","type":"object","additionalProperties":false,"description":"Information on a specific availability slot.\n> Only applicable if `product_availability:true`.","properties":{"availability_id":{"title":"Availability Slot ID","description":"The unique ID for this availability slot.","type":"string","readOnly":true},"availability_capacity_id":{"title":"Availability Slot Capacity ID","description":"Availability group / capacity identifier.","type":"string","readOnly":true},"availability_capacity_shared_id":{"title":"Availability Slot Shared Capacity ID","description":"Shared availability / capacity identifier. Only applicable if `capacity_type:SHARED / COMBINED`.","type":"string"},"availability_label":{"title":"Availability Slot Label","type":"string","description":"Optional label for this availability slot."},"availability_product_id":{"title":"Availability Slot Product ID","description":"The product linked to this availability slot.\n\n> In case you are requesting the availability for a main combi product (`product_class:COMBI`) or a cluster product (`product_class:CLUSTER`) and `sub_products_depth: > 0` all sub-product availabilities will be returned as well. ","type":"string"},"availability_admission_type":{"$ref":"#/components/schemas/ProductAdmissionType"},"availability_active":{"title":"Availability Slot Active","description":"Whether this availability slot is active (open) or not (closed). This availability cannot be booked if `availability_active:false`.","type":"boolean","default":true},"availability_duration":{"title":"Availability Slot Duration","type":"integer","description":"Duration of the timeslot in seconds"},"availability_from_date_time":{"title":"Availability Slot From Date Time","description":"The starting date and time of the activity availability slot.","type":"string","format":"date-time"},"availability_to_date_time":{"title":"Availability Slot To Date Time","description":"The till date and time of the activity availability slot.","type":"string","format":"date-time"},"availability_booking_window_start":{"title":"Availability Booking Window Start","type":"string","format":"date-time","description":"The start date-time from when this availability slot is bookable."},"availability_booking_window_end":{"title":"Availability Booking Window End","type":"string","format":"date-time","description":"The end date-time from which this availability slot is no longer bookable."},"availability_spots":{"$ref":"#/components/schemas/AvailabilitySpots"},"availability_created":{"title":"Availability Slot Created","description":"The date on which the availability slot has been created.","type":"string","format":"date-time"},"availability_modified":{"title":"Availability Slot Modified","description":"The date on which this availability slot has been modified (Capacity and Configuration).","type":"string","format":"date-time"}},"required":["availability_id","availability_active","availability_from_date_time","availability_created","availability_modified"]},"ProductAdmissionType":{"title":"Product Admission Types","type":"string","readOnly":true,"enum":["TIME_PERIOD","TIME_DATE","TIME_POINT","TIME_SLOT","TIME_OPEN"],"description":"<details>\n  <summary>**Product Admission Types**</summary>\n  \n* `TIME_PERIOD` - Customers can arrive at any time between the start (`availability_from_date_time`) and end time (`availability_to_date_time`) of the availability slot. Multiple periods in a single day should be expected.\n  Therefore a date- and timepicker should be shown.\n\n* `TIME_DATE` - Variation on `TIME_PERIOD`, whereas only a single period exists in a day. It is not required to choose between different times within a day, therefore only a datepicker is required.\n  Note that in case the slot includes midnight (two or more days), the day from which the `availability_from_date_time` originated should take precedence.\n\n* `TIME_POINT` - Customers are required to be present at the start time of the availability slot but can leave any time they want.\n* `TIME_OPEN` - Customers can arrive at any time. Availablity is not applicable.\n* `TIME_SLOT` - Customers are required to be present at the start time of the availability slot, and the service is expected to finish at the end time of the slot. </details>\n"},"AvailabilitySpots":{"title":"Availability Spots","type":"object","description":"Information over the spots that the merchant has set for this configuration.\n> Only applicable for managed (limited) capacity `product_capacity:true`.\n\n> In case of 3rd party aggregated data, not all fields will be available.","properties":{"availability_spots_total":{"title":"Availability Spots Total","description":"The total number of spots that the merchant has configured for this distributor (including those that are not available).","type":"integer"},"availability_spots_reserved":{"title":"Availability Spots Reserved","description":"The number of spots currently reserved / blocked for this availability entry. Some of these might open up in the near future (e.g. abandoned checkouts). This value is already deducted from the `availability_spots_open` parameter and can be safely ignored in capacity calculations.\n\nFormula: `availability_spots_total` - (`availability_spots_booked` + `availability_spots_reserved`) = `availability_spots_open`.","type":"integer"},"availability_spots_booked":{"title":"Availability Spots Booked","description":"The number of spots currently booked for this availability entry. These might open up in the near future (Cancellations). This value is already deducted from the `availability_spots_open` parameter and can be safely ignored in capacity calculations.\n\nFormula: `availability_spots_total` - (`availability_spots_booked` + `availability_spots_reserved`) = `availability_spots_open`.","type":"integer","multipleOf":1},"availability_spots_open":{"title":"Availability Spots Open","description":"The number of spots currently available for this availability entry.","type":"integer","multipleOf":1},"availability_spots_details":{"title":"Availability Spots Details","description":"List of available spots.","deprecated":true,"type":"array","items":{"$ref":"#/components/schemas/Spot"}}},"required":["availability_spots_open"]},"Spot":{"title":"Spot","type":"object","description":"Information on the selected spot. Only applicable if PrioSeating is being used (`product_availability_assigned:true`).\n","properties":{"spot_name":{"title":"Spot Name","type":"string","description":"Spot name.","readOnly":true},"spot_section":{"title":"Spot Section","type":"string","description":"Name of the section. Only applicable if the product has sections."},"spot_row":{"title":"Spot Row","type":"string","description":"The row the spot resides in."},"spot_number":{"title":"Spot Number","description":"The spot number.","type":"string"}},"required":["spot_state"]},"AvailabilityPrice":{"title":"Availability Price","type":"object","description":"Pricing for this specific availability entry.","deprecated":true,"properties":{"availability_pricing_variation_amount":{"title":"Availability Pricing Variation Amount","description":"The dynamic variation amount.","type":"string"},"availability_pricing_variation_percentage":{"title":"Availability Pricing Variation Percentage","description":"The dynamic variation percentage. If blank then the variation is not based on percentages.","type":"string"},"availability_pricing_variation_description":{"title":"Availability Pricing Variation Description","description":"Reason for the price variation.","type":"string"},"availability_pricing_variation_type":{"$ref":"#/components/schemas/PriceVariationType"},"availability_pricing_variation_price_type":{"$ref":"#/components/schemas/PriceVariationPriceType"},"availability_pricing_variation_commission_included":{"title":"Availability Pricing Variation Commission Included","description":"Whether the distributor commission percentage is applicable on this price variation or not.","type":"boolean"},"availability_pricing_variation_product_type_id":{"title":"Availability Pricing Variation Product Type ID","description":"The applicable product type.","type":"string"},"availability_pricing_variation_product_type_discount_included":{"title":"Availability Pricing Variation Product Type Discount Included","description":"Whether the product type discount is applicable on the price variation or not.","type":"boolean"},"availability_pricing_variation_product_type":{"$ref":"#/components/schemas/ProductType"}},"required":["availability_pricing_variation_amount"]},"PriceVariationType":{"title":"Price Variation Type","description":"<details>\n  <summary>**Price Variation Types**</summary>\n\n* `DATE_VARIATION` - Pricing based on calendar date.\n* `DATETIME_VARIATION` - Pricing based on calendar date and time.\n* `WEEKDAY_VARIATION` - Pricing based on the day of the week (e.g Monday, Tuesday). This is also called Daily pricing.\n* `CUSTOM_VARIATION` - Custom dynamic pricing. </details>\n","type":"string","enum":["DATE_VARIATION","DATETIME_VARIATION","WEEKDAY_VARIATION","CUSTOM_VARIATION"]},"PriceVariationPriceType":{"title":"Price Variation Price Type","description":"Whether this price variation applies to the sales or resale price.","type":"string","default":"SALES_PRICE","enum":["SALES_PRICE","RESALE_PRICE"]},"ProductType":{"title":"Product Type","type":"string","description":"Each product contains product types. These product types can offer aged based ticketing (such as Adult and Child), but also provide a variety of other flexible product variations such as group pricing, business and economy seating or different car configurations.\n\nBecause some products might behave different from others, each product type is categorized within a product class; a group of products that behaves similarly.\n<details>\n  <summary>**Product Types**</summary>\n\n  * Class Standard:\n    \n    Product types in the standard class are the most common and are supported by almost all systems. These types will always be age-restricted.\n    \n    Tour and experience providers have the flexibility to vary prices and apply different rules based on the age of their customers. This means they can charge full ticket prices for adults while offering discounted rates for children, or they may have specific requirements such as requiring at least one adult for every group of children booking a tour.\n    \n    During the process of checking prices and proceeding to checkout, customers should be able to select the number of individuals from each available age group for their booking.\n  \n    * `ADULT` - Adult.\n    \n    * `CHILD` - Child.\n    \n    * `SENIOR` - Senior.\n    \n    * `YOUTH` - Youth.\n        \n    * `INFANT` - Infant.\n    \n  * Class Individual:\n  \n    Product types in the individual class are less common and therefore have fewer supported systems. These types will never be age-restricted.\n    \n    * `PERSON` - Person.\n    \n    * `STUDENT` - Student.\n    \n    * `RESIDENT` - Resident.\n    \n    * `MILITARY` - Military.\n    \n    * `IMPAIRED` - Impaired.\n  \n  * Class Item:\n  \n    Product types in the item class do not refer to actual persons, instead they could, for example, be packages (Regular, Silver, Diamond), objects (Merchandise, private tours), a type of event, class identifier (Economy, Business) and much more.\n  \n    * `ITEM` - Item.\n    \n  * Class Group:\n   \n    Product types in the group class always consist of multiple persons. It can, for example, be a family of 2 Adults and 2 Childs.\n    \n    * `GROUP` - Group.\n    \n    * `FAMILY` - Family.\n    \n  * Class Custom:\n  \n    Product types in the custom class are completely dynamic and therefore require explicit mapping with external systems. They do not return as `CUSTOM`, instead they can take any form.\n    \n    * `CUSTOM` - Custom.\n    \n</details>\n","enum":["ADULT","CHILD","SENIOR","YOUTH","INFANT","PERSON","STUDENT","RESIDENT","MILITARY","IMPAIRED","ITEM","GROUP","FAMILY","CUSTOM"]},"ErrorModel":{"title":"Error Model","description":"Error model.","type":"object","readOnly":true,"properties":{"error":{"title":"Error Code","description":"The error code which occured.\n\nAs our API has over 1000+ unique error codes (grouped by HTTP status). We discourage implementing individual errors on your customer front-end interface and suggest a catch-all clause for each HTTP status code instead.\n\nErrors can be shown directly to the customer using the `error_message`, while more specific details explaining the problem will be provided in the `errors` object.\nWe recommend a combination of `error_message` and `error_reference` when communicating with the customer and API support.\n","type":"string","readOnly":true},"error_reference":{"title":"Error Reference","description":"Unique reference linked to this error.\n\nWe recommend showing this reference to the customer to allow for better issue tracking.\n","type":"string","readOnly":true},"error_message":{"title":"Error Message","description":"Customer friendly error message which can be shown on your front-end.\n","type":"string","readOnly":true},"error_description":{"title":"Error Description","description":"Human-readable ASCII [[USASCII]](https://tools.ietf.org/html/rfc6749#ref-USASCII) text providing additional information, used to assist the client developer in understanding the error that occurred.","type":"string","readOnly":true},"error_uri":{"title":"Error URI","description":"A URI identifying a human-readable web page with information about the error, used to provide the client \ndeveloper with additional information about the error.","type":"string","readOnly":true},"errors":{"title":"Error Messages","description":"Specific messages indicating one or more problems.","type":"array","readOnly":true,"items":{"title":"Error Message","description":"Specific message indicating a problem.","type":"string","readOnly":true}}},"required":["error","error_reference"]}},"responses":{"InvalidRequest":{"description":"Invalid Request\n\nThe HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"AuthenticationFailed":{"description":"Authentication Failed\n\nThe access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code.  The client MAY request a new access token and retry the protected resource request.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"Forbidden":{"description":"Forbidden\n\nThe request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.","headers":{"WWW-Authenticate":{"description":"Defines the authentication method that should be used to gain access to a resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"MethodNotAllowed":{"description":"Method Not Allowed\n\nThe HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.\n\nA request method is not supported for the requested\n      resource; for example, a GET request on a form that\n      requires data to be presented via POST, or a PUT request\n      on a read-only resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotAcceptable":{"description":"Not Acceptable\n\nThe HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"UnprocessableEntity":{"description":"Unprocessable Entity\n\nThe HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"LimitReached":{"description":"Too Many Requests\n\nThe HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time (\"rate limiting\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"InternalServerError":{"description":"Internal Server Error\n\nThe HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"NotImplemented":{"description":"Not Implemented\n\nThe HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.\n\nThe server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"BadGateway":{"description":"Bad Gateway\n\nThe HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.\n\nThe HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"ServiceUnavailable":{"description":"Service Unavailable\n\nThe HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.\n\nThe HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"GatewayTimeout":{"description":"Gateway Timeout\n\nThe HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.\n\nThe HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}}},"paths":{"/products/{product_id}/availability":{"get":{"description":"The availability API is used to make sure that the product or service is available on the desired date and time slot. \n\nDepending on the `product_availability` parameter given in the product feed, the availability needs to be requested using this endpoint prior to making a booking.\n\nThis endpoint should be called in order to get up-to-date availability information for a product with managed capacity. \nThe response will contain the availability for each time slot of the requested product that lies within the specified date range. \n*Availability Logic**\nPlease consult our dedicated \"Availability\" section for more information on how to use this endpoint. \n\n**Caching Recommendations**\n\nPlease consult our dedicated \"Caching\" section for more information on how to use this endpoint.   \n\n> ### Notes\n> * Dates and times are always relative to the supplier timezone and all offsets are automatically adjusted based on daylight saving time (DST).\n> * A maximum of 90 days is allowed. If you would like to batch availability for a longer period, please make multiple calls.","summary":"List Product Availabilities (Deprecated)","tags":["Products"],"operationId":"getProductAvailability","deprecated":true,"parameters":[{"$ref":"#/components/parameters/DistributorIDOptional"},{"name":"product_id","in":"path","required":true,"description":"Unique identifier for the product assigned by Prio.","schema":{"type":"string"}},{"name":"from_date","in":"query","required":true,"description":"[FILTER] From which date availability is requested.\nIf supplied with `to_date` , then availability request is for a date range. \nIf supplied without `to_date`, then for a single date availability is requested.","schema":{"type":"string","format":"date"}},{"name":"to_date","in":"query","required":false,"description":"[FILTER] Till which date availability is requested.\nIf this is empty, availability will be searched for the given `from_date` only. ","schema":{"type":"string","format":"date"}},{"name":"include_disabled","in":"query","required":false,"description":"[FILTER] Include disabled / closed (`availability_active:false`) entries. ","schema":{"type":"boolean","default":false}},{"name":"availability_capacity_id","in":"query","required":false,"description":"[FILTER] on `availability_capacity_id`.","schema":{"type":"string"}},{"name":"spots_open_min","in":"query","required":false,"description":"[FILTER] The minimum remaining `availability_spots_open`.","schema":{"type":"integer","exclusiveMaximum":false}},{"name":"sub_products_depth","in":"query","required":false,"description":"[FILTER] The iteration depth of the included entries of the sub-products in the response. This will not apply to sub-products which have shared capacity linked to the main product.\n\nExample Setup:\n```\nProduct 101 (Main)\n  Product 201 (Sub)\n    Product 301 (Nested)\n    Product 302 (Nested)\n  Product 202 (Sub)\n    Product 401 (Nested)\n    Product 402 (Nested)\n```\n* `sub_products_depth:0` will return Product 101.\n* `sub_products_depth:1` will return Product 101, 201 and 202.\n* `sub_products_depth:2` will return Product 101, 201, 202, 301, 302, 401 and 402.","schema":{"type":"integer","default":0}},{"name":"availability_modified","in":"query","required":false,"description":"[FILTER] Only show entries modified after the given date.\n  \n  \n  Fetch incremental updates through this endpoint.\n","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/If-Modified-Since"}],"responses":{"200":{"description":"Product Availability Response","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Last-Modified":{"$ref":"#/components/headers/Last-Modified"},"Content-Language":{"$ref":"#/components/headers/Content-Language"},"Content-Length":{"$ref":"#/components/headers/Content-Length"},"Access-Control-Allow-Methods":{"$ref":"#/components/headers/Access-Control-Allow-Methods"},"Content-Security-Policy":{"$ref":"#/components/headers/Content-Security-Policy"},"X-XSS-Protection":{"$ref":"#/components/headers/X-XSS-Protection"},"X-Content-Type-Options":{"$ref":"#/components/headers/X-Content-Type-Options"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Origin":{"$ref":"#/components/headers/Origin"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityVariationListResponse"}}}},"400":{"$ref":"#/components/responses/InvalidRequest"},"401":{"$ref":"#/components/responses/AuthenticationFailed"},"403":{"$ref":"#/components/responses/Forbidden"},"405":{"$ref":"#/components/responses/MethodNotAllowed"},"406":{"$ref":"#/components/responses/NotAcceptable"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/LimitReached"},"500":{"$ref":"#/components/responses/InternalServerError"},"501":{"$ref":"#/components/responses/NotImplemented"},"502":{"$ref":"#/components/responses/BadGateway"},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
````


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.prioticket.com/endpoints/products.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.