Updated on January 20, 2020:
\\nOnce the Operators, as detailed in Clause 13 below, (hereinafter referred to as “the Operator”), [...]"}}},"TourCity":{"type":"object","properties":{"location_id":{"type":"integer","description":"Unique identifier for the city in the TourRadar system.","example":1938},"city_name":{"type":"string","description":"Name of the city.","example":"Rome"},"country_code":{"type":"string","description":"ISO code for the country where the city is located.","example":"IT"},"latitude":{"type":"number","description":"Geographic latitude.","example":41.901766},"longitude":{"type":"number","description":"Geographic longitude.","example":12.496777}}},"TourItinerary":{"description":"Details the itinerary of the tour, with day-by-day description of the activities and the destinations visited.","type":["array","null"],"items":{"type":"object","properties":{"order":{"type":"integer","description":"The order of the itinerary item.","example":1},"duration":{"type":["integer","null"],"description":"The duration of this item in number of days.","example":1},"title":{"type":"string","description":"Title of the itinerary item.","example":"Day 1: Start of tour in Rome - Venice"},"description":{"type":"string","description":"Description of the itinerary item.","example":"Welcome to your first day on tour! After meeting up with your tour leader and group it’s time to hit the road! Sit back and enjoy the scenery as we make our way from Rome to Venice! Vineyards and orchards flash in front of a majestic mountain backdrop as we drive. The diversity of the Italian landscapes will continue to impress. Venice is an unique city, perched across 118 islands, and known for its canals, gondolas, Venetian masks, piazzas, art and traditional glass and lace making. Your tour leader will introduce you to the city with an orientation walk so you can use your free time in the early evening to explore. See the world-famous St Mark's Square, Grand Canal and Rialto Bridge. The evening is yours to enjoy authentic Italian delights, with hundreds of fantastic local restaurants and bars to choose from. After an espresso, explore Venice the traditional way - from the canals. Take a gondola ride optional which gives you a completely different perspective and appreciation for the amazing structure of this supremely unique location. Please note - for 2021 departures the Rome Optional Free Day takes place at the beginning of the tour, rather than end."},"locations":{"type":"array","description":"Locations visited in this itinerary item.","items":{"$ref":"#/components/schemas/TourCity"}}}}},"PartnersPresetStatus":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The status of the partner preset workflow","enum":["PENDING","RUNNING","FAILED","SUCCEEDED"],"example":"PENDING"}}},"OperatorBulkFiles":{"type":"object","properties":{"urls":{"type":"array","description":"List of files that can be downloaded for this data set.","items":{"type":"string","format":"uri","description":"File URL containing requested data in compressed JSON format."}},"expires_in":{"type":"integer","description":"Validity, in seconds, of the URLS. For example, the value `600` indicates that the URL will expire in 10 minutes from the time the response was generated.","example":600}}},"TourPrice":{"type":"object","properties":{"partner_info":{"type":"object","description":"Information about the partner-specific component of the price, including commission.","properties":{"booking_fee_value":{"type":"number","description":"The actual booking fee value, calculated on the price reported in this section.","example":0},"booking_fee_rate":{"type":"number","description":"The booking fee rate, if any, espressed as multiplier. For example, a booking fee of 5% would be represented by `0.05`. If no booking fee will be due for booking this tour, this will be `0`.","example":0},"commission_rate":{"type":"number","description":"The commission rate, expressed as multiplier. For example, a commission of 5% would be represented by `0.05`. If no commission will be paid for booking this tour, this will be `0`.","example":0},"commission_value":{"type":"number","description":"The actual commission value, calculated on the price reported in this section.","example":0},"contract_type":{"type":"string","enum":["direct","wholesale","affiliate","organiser"],"description":"The contract type your partner account is operating with for this operator.","example":"marketplace"},"calculation_base":{"type":"string","enum":["accommodation","all_extras"],"description":"Definition of the amount used as reference for the commission calculation.","example":"accommodation"}}},"based_on":{"type":["string","null"],"description":"If available, the type of accommodation that the base price refers to.","example":"Base price"},"price_base":{"type":"number","description":"Base price of the tour, also referenced as brochure price. Note this is the lowest price among the possible departure dates (some departure dates may be more expensive than this).","example":2990},"price_addons":{"type":"number","description":"Sum of the mandatory addons that the passenger will have to pay (both upfront and local payments).","example":180},"price_promotion":{"type":"number","description":"Discounted price, or base price minus the promotion.","example":2145},"price_total_upfront":{"type":"number","description":"Final sale price, composed by the base price, minus the applied promotion, plus the upfront addons.","example":2145},"price_total":{"type":"number","description":"Final sale price, composed by the base price, minus the applied promotion, plus the mandatory local and upfront addons.","example":2325},"currency":{"type":"string","description":"Currency code for the reported prices.","example":"USD"},"promotion":{"$ref":"#/components/schemas/ToursPromotion"},"mandatory_addons":{"type":"array","description":"List of the mandatory addons (extra price elements).","items":{"type":"object","properties":{"price":{"type":"number","description":"Price for this addon.","example":180},"name":{"type":"string","description":"Name of the addon.","example":"Domestic flight"},"payment_type":{"type":"string","enum":["upfront","local"],"description":"The payment type (upfront or local).","example":"local"},"local_currency":{"type":["null","string"],"description":"For local payments, the currency this payment must be executed in.","example":"USD"},"local_value":{"type":["null","number"],"description":"The price of the addon in the local currency.","example":180}}}}}},"PartnersOperatorsPermissionsList":{"type":"array","items":{"$ref":"#/components/schemas/PartnersOperatorsInfo"}},"PartnersUsagePlans":{"type":"array","description":"List of available usage plans","items":{"type":"object","description":"Attribute representation","properties":{"id":{"type":"string","description":"Usage plan id","example":"7ww3b6"},"name":{"type":"string","description":"Usage plan name","example":"Basic"},"description":{"type":"string","description":"Usage plan description"}}}},"PartnerByAccreditation":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Partner","example":"Some Partner"},"description":{"type":"string","description":"The Partner ID","example":"some-partner"}}}},"PartnerUpdateInput":{"type":"object","required":["id","name","role","status"],"properties":{"id":{"type":"string","description":"Partner ID","example":"4d353262-f2e8-4de6-8585-9e813e187c60"},"name":{"type":"string","description":"Partner name","example":"TourRadar GmbH"},"status":{"enum":["active","inactive"],"description":"Status of partner","example":"inactive"},"role":{"type":"string","description":"Partner role","example":"api"},"notes":{"type":"string","description":"Internal notes about partner","example":"Some note"},"payout_terms":{"type":"object","description":"The commission payout terms","properties":{"terms_days":{"type":"integer","description":"Describe margin days when payout will be made","example":-5},"base_date":{"enum":["tour_start_date","tour_end_date"],"description":"Describe when commission will be payout","example":"tour_end_date"}}},"attributes":{"type":"array","description":"List of partner attributes","items":{"type":"object","description":"Attribute representation","properties":{"name":{"type":"string","description":"Attribute name","example":"registration_completed"},"value":{"type":["string","number","boolean"],"description":"Attribute value","example":true}}}},"is_whitelabel":{"type":"boolean","description":"Determine if partner has whitelabel domain or not","example":true}}},"PartnerUsersInviteToken":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"Token for partner users invite","example":"GYW9qfFPQGNy9JtF!+ssa="}}},"TourDepartureMandatoryAddon":{"type":["object","null"],"description":"Mandatory addon.","properties":{"id":{"type":"integer","description":"Unique identifier of the price item in the TourRadar system.","example":999},"value":{"type":"number","description":"Value of the price item.","example":180},"code":{"type":["string","null"],"description":"Code of the item.","example":""},"name":{"type":"string","description":"Name of the item.","example":"Domestic flight"},"description":{"type":"string","description":"Description of the item.","example":"Domestic flight"},"payment_type":{"type":["string","null"],"description":"Payment type.","enum":["upfront","local"],"example":"local"},"pax_restriction":{"type":["number","null"],"description":"Maximum pax number to apply this promotion. If null - no limit.","example":30},"price_tiers":{"$ref":"#/components/schemas/TourDeparturePriceTiers"},"local_currency":{"type":["string","null"],"description":"The used currency.","example":"USD"},"local_value":{"type":["number","null"],"description":"The value in local currency.","example":180}}},"PartnersOperatorsInfo":{"type":"object","properties":{"operator_code":{"type":"string","description":"Operator code","example":"topdeck"},"operator_id":{"type":"integer","description":"Operator ID","example":"204"},"calculation":{"type":"array","items":{"type":"object","properties":{"contract_type":{"enum":["direct","wholesale","affiliate","marketplace","organiser"],"description":"The contract type partner account is operating with for this operator.","example":"direct"},"commission_rate":{"type":"number","description":"The commission rate, expressed as multiplier. For example, a commission of 5% would be represented by `0.05`. If no commission will be paid for booking this tour, this will be `0`.","example":"0.025"},"booking_fee_rate":{"type":"number","description":"The booking fee rate, if any, espressed as multiplier. For example, a booking fee of 5% would be represented by `0.05`. If no booking fee will be due for booking this tour, this will be `0`.","example":"0.25"},"is_default":{"type":"boolean","description":"True, if is default method","example":true}}}},"calculation_base":{"enum":["accommodation","all_extras"],"description":"Definition of the amount used as reference for the commission calculation.","example":"accommodation"},"type":{"enum":["included","excluded"],"description":"Type of rule","example":"included"},"permissions":{"type":"array","description":"List of permissions","items":{"enum":["tours/read","bookings/write","bookings/read"],"description":"Permissions name","example":"bookings/write"}}}},"OperatorList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the operator in the TourRadar system.","example":"204"},"name":{"type":"string","description":"Name of the operator.","example":"Intrepid Travel"},"code":{"type":"integer","description":"Operator code.","example":"intrepid"},"has_integration":{"type":"boolean","description":"True if the operator has an integration system.","example":true},"terms_url":{"type":"string","description":"Address of the terms and conditions page from the operator website, if available.","example":"https://www.tourradar.com/terms-conditions"}}}},"PartnersPayoutFields":{"type":"object","properties":{"AUD":{"type":"array","description":"Set of payout fields for Australia","items":{"type":"string","description":"field name","example":"bank_code"}},"CAD":{"type":"array","description":"Canadian regions fieldset","items":{"type":"string","description":"field name","example":"bank_code"}},"GBP":{"type":"array","description":"Pound Sterling regions field-set","items":{"type":"string","description":"field name","example":"bank_code"}},"EUR":{"type":"array","description":"EU regions bank details fields","items":{"type":"string","description":"field name","example":"bank_code"}},"USD":{"type":"array","description":"USA bank data field-set","items":{"type":"string","description":"field name","example":"bank_code"}}}},"PartnerUserList":{"type":"array","items":{"$ref":"#/components/schemas/PartnerUser"}},"PartnersPartnerBookings":{"type":"object","description":"List of partner's bookings","required":["partner_id"],"items":{"type":"object","properties":{"partner_id":{"type":"string"}}}},"PartnersRelatedPartners":{"type":"array","items":{"type":"object","properties":{"partner_id":{"type":"string"},"related_partner_id":{"type":"string"},"is_default":{"type":"boolean"}}}},"Empty":{"title":"Empty Schema","type":"object"},"BookingLinks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of link","example":"booking-page","enum":["booking-page"]},"url":{"type":"string","description":"Url","example":"https://www.tourradar.com/booking/12345?enquiryCode=fvwffws8hgqqz4blyh13icbyldjqhp6d"}}}},"BookingStatus":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the booking in the TourRadar system.","example":892000},"tour_id":{"type":"integer","description":"Deprecated. Moved to `$.tour.tour_id`.","example":14263},"tour":{"type":"object","description":"Metadata about tour that was booked.","properties":{"tour_id":{"type":"integer","description":"Unique identifier for the tour in the TourRadar system.","example":14263},"tour_name":{"type":"string","description":"Name of the tour.","example":"Europe Escape - 12 Days"},"tour_length_days":{"type":"integer","description":"Length of the tour, expressed in number of days.","example":12},"operator":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the tour operator in the TourRadar system.","example":1170},"name":{"type":"string","description":"Name of the tour operator.","example":"Expat Explore Travel"}}}}},"departure_date":{"type":"string","description":"Departure date that was booked, in the format `YYYY-MM-DD`.","example":"2023-06-25"},"created_at":{"type":"string","description":"Exact timestamp of when the booking was created, in the ISO 8601 format.","example":"2023-05-01"},"confirmed_at":{"type":["string","null"],"description":"Exact timestamp of when the booking was confirmed, in the ISO 8601 format. If the status of the booking is not `confirmed`, this field will be `null`.","example":"2023-05-01"},"type":{"type":"string","description":"Type of this booking record.","enum":["booking","question","hold"],"example":"booking"},"status":{"type":"string","description":"Status of the booking.","enum":["open_question","open_hold","pending","confirmed","declined","cancelled","hold_expired","hold_declined"],"example":"pending"},"links":{"$ref":"#/components/schemas/BookingLinks"},"status_reason":{"$ref":"#/components/schemas/BookingDeclineReason"},"status_reason_text":{"type":["string","null"],"description":"The full description of the declination reason, if set.","example":"Received error response from operator: Failed service status transition."},"status_reason_context":{"type":["object","null"],"description":"Additional information related to the current status, if set."}}},"TaxonomyLanguagesList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Language ID.","example":"1"},"code":{"type":"string","description":"Language code.","example":"en"},"name":{"type":"string","description":"Language name.","example":"English"}}}},"BookingFields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the field (must be used when creating bookings).","example":"first_name"},"label":{"type":"string","description":"Descriptive name of the field.","example":"First Name"},"group":{"type":"string","description":"Category of the fields (can be used to group together similar fields).","example":"Contact"},"type":{"type":"string","description":"Type of data expected for this field.","example":"string","enum":["string","number","email","phone","date"]},"main_pax":{"type":"string","description":"Defines if this field is mandatory for the lead passenger (first passenger in the booking).","example":"mandatory","enum":["mandatory","optional","mandatory_post_booking"]},"additional_pax":{"type":"string","description":"Defines if this field is mandatory for additional passengers.","example":"mandatory","enum":["mandatory","optional","mandatory_post_booking"]}}}},"BookingResponse":{"type":"object","properties":{"reservation_details":{"type":"object","description":"Detailed reservation information for one matching reservation.","properties":{"confirmation":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.","example":"TTCXXX-X123456"},"status":{"type":["null","string"],"description":"Status of the booking. Note this is mapped from the operator values to a TourRadar internal state. In case of status `unknown`, the original value provided by the operator is available in the field `operator_status`.","enum":["pending","confirmed","cancelled","declined","unknown"],"example":"confirmed"},"operator_status":{"type":["string","null"],"description":"Status of the booking, as provided by the operator.","example":"onHold"}}},"basic_info":{"type":"object","description":"Core information about the booked tour and/or activity, including ID(s) and name.","properties":{"name":{"type":"string","description":"The name of the tour and/or activity.","example":"Canada Rockies"},"tour_activity_id":{"type":"string","description":"A unique ID that identifies this tour and/or activity that may be referenced elsewhere in this message.","example":"82014275"},"booking_date":{"type":["string","null"],"format":"date","example":"2021-04-06"},"edocs":{"type":["boolean","null"],"example":true},"booking_version":{"type":["string","null"],"example":"4"},"problem_note":{"type":["boolean","null"],"example":false},"booking_type":{"type":["string","null"],"example":"travelAgent"},"type":{"type":["string","null"],"example":"Explorer"},"region":{"type":["string","null"],"example":"Middle East & North Africa"}}},"schedule":{"type":"object","description":"The departure or tour/activity start date/time.","properties":{"duration":{"type":"integer","example":10},"start":{"type":["null","string"],"format":"date","description":"The starting value of the time span, in ISO 8601 prescribed format.","example":"2021-08-02"},"end":{"type":["null","string"],"format":"date","description":"The ending value of the time span, in ISO 8601 prescribed format.","example":"2021-08-06"}}},"pickup_dropoff":{"type":"array","description":"The pickup and/or dropoff information if transportation is provided to/ from the tour/activity location.","items":{"type":"object","properties":{"datetime":{"type":["string","null"],"description":"The date and time for the pickup or dropoff.","example":"TODO"},"dropoff_ind":{"type":"boolean","description":"If true, this is dropoff information.","example":false},"pickup_ind":{"type":"boolean","description":"If true, this is pickup information.","example":true},"location_name":{"type":["string","null"],"description":"The name of the pickup/ dropoff location.","example":"Pick Up: Hotel Mogador Opera @ 18:00"},"person_qty":{"type":["integer","null"],"description":"The quantity of persons to be picked up or dropped off.","example":1},"id":{"type":["string","null"],"example":"91178"},"address":{"type":"object","description":"Information about an address that identifies a location for a specific purposes.","properties":{"address_line":{"type":["string","null"],"description":"Free form address details.","example":"Avenue du Président Kennedy"},"postal_code":{"type":["string","null"],"description":"Post Office Code number.","example":"40000"},"city_name":{"type":["string","null"],"description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","example":"Marrakesh"}}},"telephone":{"type":"object","description":"Information about a telephone number, including the actual number and its usage.","properties":{"phone_number":{"type":["string","null"],"description":"Telephone number assigned to a single location.","example":"+212 1234-56789"}}}}}},"participant_info":{"type":"array","description":"Individual participant, participant category and group details.","items":{"type":"object","properties":{"category":{"type":"object","description":"Information for a participant category.","properties":{"qualifier_info":{"type":["string","null"],"description":"A specific type of age and/or group qualifier, such as adult.","example":"adult"},"quantity":{"type":"integer","description":"Used to define the quantity of participants for the specified information.","example":1}}},"individual":{"type":"object","description":"Name and other information for known participants.","properties":{"participant_id":{"type":["string","null"],"description":"A unique identifier for a known participant that may be referenced elsewhere in this message.","example":"1"},"lead_customer_ind":{"type":"boolean","description":"When `true`, indicates that this is the 'lead' participant (i.e., the primary contact making the booking).","example":true},"name_prefix":{"type":["string","null"],"description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)","example":"Mr"},"given_name":{"type":"string","description":"Given name, first name or names.","example":"Max"},"surname":{"type":"string","description":"Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.","example":"Mustermann"},"middle_name":{"type":["string","null"],"description":"The middle name of the person name.","example":"William"},"gender":{"type":["string","null"],"description":"Identifies the gender.","example":"male"},"birth_date":{"type":["string","null"],"format":"date","description":"Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.","example":"1982-02-02"},"contact":{"type":"array","description":"Contact information. Name of an individual and appropriate contact information. May be contact information for the customer or someone affiliated with the customer.","items":{"type":"object","properties":{"email":{"type":["string","null"],"description":"Electronic email address, in IETF specified format.","example":"email@tourradar.io"},"address":{"type":["object","null"],"description":"Information about an address that identifies a location for a specific purposes.","properties":{"address_line":{"type":"string","description":"Free form address details.","example":"216 Wolverine Drive"},"city_name":{"type":"string","description":"City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).","example":"Fort mcmurray"},"county":{"type":"string","description":"County or Region Name (e.g., Fairfax).","example":"Alberta"},"postal_code":{"type":"string","description":"Post Office Code number.","example":"T9H4M2"},"country_name":{"type":"string","description":"Country name (e.g., Ireland).The name or code of a country (e.g. as used in an address or to specify citizenship of a traveller).","example":"Canada"},"country_code":{"type":["string","null"],"example":"CA"}}},"emergency_flag":{"type":"boolean","description":"Indicates if this contact should be used in the case of an emergency.","example":false},"person_name":{"type":"object","description":"This provides name information for a person.","properties":{"given_name":{"type":["string","null"],"description":"Given name, first name or names.","example":"Max"},"surname":{"type":["string","null"],"description":"Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.","example":"Mustermann"},"relationship":{"type":["string","null"],"example":"Daughter"}}},"telephone":{"type":"object","description":"Information about a telephone number, including the actual number and its usage.","properties":{"phone_number":{"type":["string","null"],"description":"Telephone number assigned to a single location.","example":"+0000000000"},"country_access_code":{"type":["string","null"],"description":"Code assigned by telecommunications authorities for international country access identifier.","example":"+212"}}}}}},"document":{"type":["object","null"],"description":"Document information for verification purposes and also used for additional filtering for common names.","properties":{"doc_type":{"type":"string","description":"Indicates the type of document (e.g. Passport, Military ID, Drivers License, national ID, Vaccination Certificate).","example":"passport"},"doc_id":{"type":["string","null"],"description":"Unique number assigned by authorities to document.","example":"XX123456"},"place_of_issue":{"type":["string","null"],"example":"Australia"},"date_of_issue":{"type":["string","null"],"format":"date","example":"2015-03-17"},"date_of_expiry":{"type":["string","null"],"format":"date","example":"2025-03-17"}}},"nationality":{"type":["string","null"],"description":"The nationality of a participant, if known. Uses ISO 3166 Country Codes.","example":"AU"},"status":{"type":["string","null"],"example":"complete"},"restricted":{"type":["boolean","null"],"example":false}}},"insurance":{"type":["object","null"],"description":"Required and/or provided insurance for groups and/or individuals.","properties":{"provided":{"type":"object","description":"Third party insurance provided by a group and/or individual.","properties":{"participant_id":{"type":["number","null"],"description":"A unique ID (that is assigned elsewhere in the message) that associates a participant with other information.","example":"1"},"plan_id":{"type":["string","null"],"description":"The third-party insurance plan ID.","example":"XXX-XXXX-XXX"},"provider_name":{"type":["null","string"],"description":"The name of the insurer provider company. Identifies a company by name.","example":"Ins. Company"},"telephone":{"type":"object","properties":{"phone_number":{"type":["string","null"],"description":"Telephone number assigned to a single location.","example":"+0000000000"}}}}}}},"special_need":{"type":["array","null"],"description":"The name and/or code for a special need requirement, such as a wheelchair or vegetarian meal.","items":{"type":"object","properties":{"participant_id":{"type":["string","null"],"description":"A unique identifier for a known participant that may be referenced elsewhere in this message.","example":"1"},"code":{"type":["string","null"],"description":"A code known between trading partners for a special needs item.","example":"dietary"},"description":{"type":["string","null"],"description":"Allergic to seafood"}}}},"lodging_info":{"type":"array","items":{"type":"object","description":"Lodging information for the participant and/or group.","properties":{"room_number":{"type":["string","null"],"description":"The room number in the hotel and/or other lodging facility.","example":"40842462"},"room_type":{"type":["string","null"],"example":"twin"},"bed_preference":{"type":["string","null"],"example":"TOGETHER"}}}}}}},"pricing":{"type":"object","description":"Pricing information for the tour/ activity that may be broken down by participant category and/or a group.","properties":{"summary":{"type":"object","description":"Pricing information for the tour/ activity that is not assciated with participant category(s) and/or group(s).","properties":{"currency_code":{"type":"string","description":"An ISO 4217 (3) alpha character code that specifies a monetary unit.","example":"AUD"},"amount":{"type":["null","number"],"description":"A monetary amount.","example":"4390.00"},"final_payment_due_date":{"type":["string","null"],"format":"date","example":"2021-04-06"},"deposit_amount":{"type":["number","null"],"example":"3160.80"},"deposit_due_date":{"type":["string","null"],"format":"date","example":"2020-09-21"},"outstanding_balance":{"type":["number","null"],"example":"0.00"},"gross_outstanding_balance":{"type":["number","null"],"example":"790.20"},"net_outstanding_balance":{"type":["number","null"],"example":"0.00"},"net_amount":{"type":"number","example":"4013.35"}}},"participant_category":{"type":"array","description":"Pricing for one or more participant category(s).","items":{"type":"object","properties":{"qualifier_info":{"type":["string","null"],"description":"A specific type of age and/or group qualifier, such as `adult`.","example":"adult"},"price":{"type":"object","description":"Pricing for the specified participant category information.Base price and taxes associated with the tour and/or activity.","properties":{"currency_code":{"type":"string","description":"An ISO 4217 (3) alpha character code that specifies a monetary unit.","example":"AUD"},"amount":{"type":["null","number"],"description":"A monetary amount.","example":"1195.00"},"full":{"type":["number","null"],"example":"1195.00"},"tax_inclusive":{"type":"boolean","description":"If TRUE, taxes are included in this charge.","example":"true"},"tax_amounts":{"type":"array","description":"A collection of one or more taxes associated with a specific charge.","items":{"type":"object","properties":{"tax_amount":{"type":"object","description":"Detailed information on one specific tax associated with a specific charge","properties":{"total":{"type":"number","description":"The total amount of the tax.","example":"790.20"}}}}}}}}}}}}},"commission_info":{"type":"object","description":"Commission information.Contains details pertaining to commissions.","properties":{"currency_code":{"type":"string","example":"AUD"},"commission_payable_amount":{"type":["null","number"],"description":"The amount of commission to be paid.","example":"412.2"},"tax_amount":{"type":["number","null"],"example":"0"}}},"supplier_operator":{"type":"object","description":"Information about the supplier/ operator of the tour/ activity.","properties":{"name":{"type":"string","description":"Company name information. Identifies a company by name.","example":"COSMOS"},"operator_ind":{"type":"boolean","description":"","example":"true"}}},"payment_info":{"type":"array","description":"Payment details that may be associated with an individual participant, a participant category and/or a group.","items":{"type":"object","properties":{"amount":{"type":["null","number"],"description":"A monetary amount.","example":"75"},"currency_code":{"type":["null","string"],"description":"An ISO 4217 (3) alpha character code that specifies a monetary unit.","example":"USD"},"participant_id":{"type":["string","null"],"description":"A unique identifier for a known participant that may be referenced elsewhere in this message.","example":"1"},"credit_card_fee":{"type":["number","null"],"example":"0.0000"},"commission":{"type":["number","null"],"example":"0.0"},"payment_status":{"type":["string","null"],"example":"Authorised"},"payment_method":{"type":["string","null"],"example":"creditAgreement, creditCard"},"description":{"type":["string","null"],"description":"A description of the charge.","example":"Deposit"},"payment_due_date":{"type":["string","null"],"format":"date","example":"2020-12-24"},"payment_identifier":{"type":["string","null"],"example":"1B814FFF-6621-30FB-ABE2-E184FE7B13FE"},"date_made":{"type":["string","null"],"format":"date-time","example":"2020-04-07T17:05:29+01:00"},"net_gross":{"type":["string","null"],"example":"Nett Payment"},"detail":{"type":"object","description":"Detailed information for the payment form.","properties":{"payment_transaction_type_code":{"type":["string","null"],"description":"This is used to indicate either a charge, reserve (deposit) or refund.","example":"refund"}}}}}},"extra":{"type":"array","description":"Extra amenities that were requested and/or reserved.","items":{"type":"object","properties":{"name":{"type":"string","description":"The extra amenity name.","example":"Arrival Transfer Nice Airport to Hotel"},"status":{"type":"string","example":"confirmed"},"type":{"type":"string","example":"miscellaneous"},"quantity":{"type":"integer","description":"The quantity of this extra required.","example":"2"},"other_code":{"type":["string","null"],"description":"The trading partner code that uniquely identifies the extra and is associated with the supplier code.","example":"91075"},"start_date":{"type":["string","null"],"format":"date","example":"2021-03-13"},"end_date":{"type":["string","null"],"format":"date","example":"2021-03-13"},"pricing":{"type":"object","description":"Summary and detailed pricing.","properties":{"summary":{"type":"object","description":"Summary pricing that is not associated with a participant category and/or group.Base price and taxes associated with the tour and/or activity.","properties":{"amount":{"type":"number","description":"A monetary amount.","example":"4390.00"},"net_amount":{"type":"number","description":"The monetary net amount.","example":"4390.00"},"commission":{"type":["number","null"],"example":"376.65"}}}}}}}},"discount":{"type":"array","description":"Promotion code and discount program information that may be associated with an individual participant, a participant category and/or a group.","items":{"type":"object","properties":{"discount_program":{"type":"object","description":"Discount program details.","properties":{"detail":{"type":"object","description":"Details about a discount program.","properties":{"program_id":{"type":["string","null"],"description":"A unique ID for this program that may be referenced elsewhere in this message.","example":"traveltalk"},"name":{"type":["string","null"],"description":"The name of a discount program, e.g. 'Day Pass' or 'Gold Card'.","example":"Travel Talk"}}},"amount":{"type":["null","number"],"example":"100"},"quantity":{"type":["integer","null"],"example":"2"},"percentage":{"type":["number","null"],"example":"0.0"}}},"participant_id":{"type":["string","null"],"description":"A unique identifier for a known participant that may be referenced elsewhere in this message.","example":"1"},"promotion":{"type":"object","description":"Code for promotional pricing.","properties":{"code":{"type":["string","null"],"description":"A promotion code.","example":""}}}}}},"itinerary":{"type":["array","null"],"items":{"type":"object","description":"An item of package itinerary - typically a flight, accommodation or car rental arrangement.","properties":{"start":{"type":"object","properties":{"city_name":{"type":["string","null"],"example":"Athens"},"city_id":{"type":["integer","null"],"example":"2385"},"country_name":{"type":["string","null"],"example":"Greece"},"country_code":{"type":["string","null"],"example":"GR"}}},"end":{"type":"object","properties":{"city_name":{"type":["string","null"],"example":"Athens"},"city_id":{"type":["integer","null"],"example":"2385"},"country_name":{"type":["string","null"],"example":"Greece"},"country_code":{"type":["string","null"],"example":"GR"}}}}}},"agent":{"type":["object","null"],"properties":{"email":{"type":["string","null"],"example":"booking@tourradar.com"},"buying_agent_name":{"type":["string","null"],"example":"Tour Radar - Vienna"},"travel_consultant_first_name":{"type":["string","null"],"example":"Richard"},"travel_consultant_surname":{"type":["string","null"],"example":"Welch"},"app_id":{"type":["string","null"],"example":"82b6dd76-8199-4bc9-8381-e05beebf23de"}}}}}}},"TourDeparture":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the departure date (must be used for price calculation and booking creation).","example":740389663},"date":{"type":"string","description":"Date of the departure, in the format `YYYY-MM-DD`.","example":"2024-03-24"},"departure_type":{"type":"string","description":"Type of departure.","enum":["guaranteed","scheduled","request"],"example":"guaranteed"},"is_instant_confirmable":{"type":"boolean","description":"If true, bookings related to this departure can be instantly confirmed by the operator.","example":true},"availability":{"type":"integer","description":"Availability.","example":5},"guide_languages":{"type":"array","description":"List of languages this tour is offered in (for their meaning, see **[/taxonomy/languages](#tag/Taxonomy/paths/~1v1~1taxonomy~1languages/get]**).","items":{"type":"integer","example":[1]}},"links":{"$ref":"#/components/schemas/ToursLinks"},"prices":{"type":"object","description":"Pricing information.","properties":{"currency":{"type":"string","description":"Currency code for the reported prices.","example":"USD"},"price_base":{"type":"number","description":"Base price of the tour, also referenced as brochure price.","example":2990},"price_addons":{"type":"number","description":"Sum of the mandatory addons that the passenger will have to pay (both upfront and local payments).","example":180},"price_promotion":{"type":"number","description":"Discounted price, or base price minus the promotion.","example":2145},"price_total":{"type":"number","description":"Final sale price, composed by the base price, minus the applied promotion, plus the mandatory local and upfront addons.","example":2325},"price_total_upfront":{"type":"number","description":"Final sale price, composed by the base price, minus the applied promotion, plus the upfront addons.","example":2145},"promotion":{"$ref":"#/components/schemas/ToursDeparturePromotion"},"based_on":{"type":["string","null"],"description":"If available, the type of accommodation that the base price refers to.","example":"Base price"},"mandatory_addons":{"type":"array","description":"List of the mandatory addons (extra price elements).","items":{"$ref":"#/components/schemas/TourDepartureMandatoryAddon"}},"payment_schedule":{"type":"object","description":"Defines how the payment for the tour must be performed (deposit, pay by installments, final payment date).","properties":{"deposit":{"type":["number","null"],"description":"The amount that must be paid as deposit. If no deposit is required for this tour, the value will be `null`.","example":214.5},"pay_by_installments":{"type":"boolean","description":"Indicates if pay by installments is available for this tour.","example":false},"final_payment_date":{"type":["null","string"],"description":"Date by which the price must be paid in full.","example":"2024-03-24"}}},"accommodations":{"type":"array","description":"Accommodation options available for this tour.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the accommodation option in the TourRadar system.","example":309880},"name":{"type":"string","description":"Name of the accommodation option.","example":"Base price"},"description":{"type":"string","description":"Description of the accommodation option.","example":"Base price"},"payment_type":{"type":["string","null"],"enum":["upfront","local"],"description":"The payment type (upfront or local).","example":"upfront"},"beds_number":{"type":["integer","null"],"description":"Number of beds.","example":2},"is_shared":{"type":["boolean","null"],"description":"If true, this accommodation is shared with other participants of the tour.","example":false},"value":{"type":"integer","description":"Base price of the accommodation option.","example":2990},"price_tiers":{"type":"array","description":"Detailed information of all the pricing options for this accommodation.","items":{"type":"object","properties":{"is_default":{"type":"boolean","description":"If true, this is the default price tier (used to calculate the base price).","example":true},"price_category_id":{"type":"integer","description":"Identifier of the passenger category this price refers to (for example: adult, child). To retrieve the possible identifiers, use the **[/tours/{tourId}/prices](#tag/Pricing-and-Availability/paths/~1v1~1tours~1{tourId}~1prices/get)** endpoint.","example":4},"pax_min":{"type":["integer","null"],"description":"Minimum number of passengers required for this price tier.","example":2},"pax_max":{"type":["integer","null"],"description":"Maximum number of passengers allowed for this price tier.","example":4},"value":{"type":"number","description":"Price for this item with this pricing option.","example":2990},"local_currency":{"type":["null","string"],"description":"For local payments, the currency this payment must be executed in.","example":"USD"},"local_value":{"type":["null","number"],"description":"The price of the accommodation option in the local currency.","example":2990}}}},"pax_restriction":{"type":["number","null"],"description":"Maximum pax number to apply this promotion. If null - no limit.","example":10},"code":{"type":["string","null"],"description":"Code of the addon.","example":"1267"}}}},"optional_extras":{"type":"array","description":"List of optional extra items that can be booked together with the tour.","items":{"$ref":"#/components/schemas/OptionalExtraItem"}},"partner_info":{"type":["object","null"],"properties":{"calculation_base":{"type":["null","string"],"description":"Calculation base.","example":"accommodation"},"contract_type":{"type":"string","description":"Contract type.","example":"marketplace"},"commission_rate":{"type":"number","description":"Commission rate of the partner.","example":0},"commission_value":{"type":"number","description":"Commission value of the partner.","example":0},"booking_fee_rate":{"type":"number","description":"Booking fee rate of the partner.","example":0},"booking_fee_value":{"type":"number","description":"Booking fee value of the partner.","example":0}}}}}}},"Partner":{"type":"object","required":["id","name","status","scopes"],"properties":{"id":{"type":"string","description":"Partner ID","example":"4d353262-f2e8-4de6-8585-9e813e187c60"},"name":{"type":"string","description":"Partner name","example":"TourRadar GmbH"},"status":{"enum":["active","inactive"],"description":"Status of partner","example":"inactive"},"role":{"type":"string","description":"Partner role","example":"api"},"scopes":{"type":"array","description":"When partner.role === custom, list of allowed partner scopes","items":{"type":"string","description":"Scope name","example":"com.tourradar.tours/read"}},"notes":{"type":"string","description":"Internal notes about partner","example":"Some note"},"attributes":{"type":"array","description":"List of partner attributes","items":{"type":"object","description":"Attribute representation","properties":{"name":{"type":"string","description":"Attribute name","example":"registration_completed"},"value":{"type":["string","number","boolean"],"description":"Attribute value","example":true}}}},"terms_approved":{"type":"boolean","description":"True, if partner approved terms & conditions","example":true},"payout_terms":{"type":"object","description":"The commission payout terms","properties":{"terms_days":{"type":"integer","description":"Describe margin days when payout will be made","example":-5},"base_date":{"enum":["tour_start_date","tour_end_date"],"description":"Describe when commission will be payout","example":"tour_end_date"}}},"usage_plan":{"type":"string","description":"Partner usage plan id","example":"7ww3b6"}}},"PartnerDocsEndpoints":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"API endpoint path","example":"/v1/bookings/{operator}/{bookingCode}"},"methods":{"type":"array","description":"List of available API Methods","items":{"type":"object","properties":{"method":{"enum":["GET","POST","PUT","PATCH","OPTIONS","DELETE"],"description":"API Method","example":"GET"},"allowed":{"type":"boolean","description":"If true, partner is allowed to see documentation about this method","example":true},"summary":{"type":"string","description":"Short summary about endpoint","example":"Get information about booking"}}}}}}},"Tour":{"type":"object","properties":{"tour_id":{"type":"integer","description":"Unique identifier for the tour in the TourRadar system (please note that this is different from the operator code).","example":14263},"locale":{"type":"string","description":"Language locale the content is provided, default is `en_US` (English).","example":"en_US"},"codes":{"type":"array","description":"Operator codes for the tour. Note that some operators offer the same tours in a number of variants (usually for different accommodation options), but TourRadar handles them as a single tour. For this reason, it's possible that more than one code refers to this tour.","items":{"type":"string","example":"26"}},"language":{"type":"string","description":"Language code the content is provided, default is `en` (English).","example":"en"},"tour_name":{"type":"string","description":"Name of the tour. Note that tour names are sometimes adjusted by TourRadar, and might not exactly match the name provided by the operator.","example":"Europe Escape - 12 Days"},"is_active":{"type":"boolean","description":"Determines if the tour is currently active, e.g. if it has departure dates that can be booked. Note: inactive tours are never returned by searching, but they could have existing bookings, so it's possible to retrieve them directly by ID.","example":"true"},"description":{"type":["null","string"],"description":"Description of the tour, providing a summary of the itinerary and the key important selling points for the tour.","example":"This is the flagship tour that started it all for Expat Explore! Journey to 8 of Europe's most popular countries. Start off by getting to know the Italian way of life in Rome and the romantic Venice. Explore the gem that is Paris, and meander through the countryside of France. Cross borders to the heart of the Swiss Alps and see castle-lined riverbanks in Germany’s Rhine Valley. Explore the vibrant streets and beautiful canals of Amsterdam. There’s so much in store for you! Please note: there are changes to the itinerary for 2021 departures - see the itinerary and contact us for info"},"tour_length_days":{"type":"integer","description":"Length of the tour, expressed in number of days.","example":12},"is_instant_confirmable":{"type":"boolean","description":"If true, bookings related to this tour can be instantly confirmed by the operator.","example":true},"guide_languages":{"type":["array","null"],"description":"List of languages this tour is offered in (for their meaning, see **[/taxonomy/languages](#tag/Taxonomy/paths/~1v1~1taxonomy~1languages/get)**).","items":{"type":"integer"},"example":[1]},"start_point":{"type":"object","description":"Information about the starting point of the tour (e.g. pickup point), if available.","properties":{"latitude":{"type":["null","number"],"description":"Latitude of the location where the tour will start.","example":"41.893060"},"longitude":{"type":["null","number"],"description":"Longitude of the location where the tour will start.","example":"12.482780"},"name":{"type":"string","description":"Name of the location where the tour will start.","example":"Hotel in Rome"},"address":{"type":"string","description":"Address of the location where the tour will start.","example":"Roma, Rome, Italy"},"time":{"type":"string","description":"Time of the day when the tour will start.","example":"10:00"}}},"end_point":{"type":"object","description":"Information about the ending point of the tour (e.g. drop off point), if available.","properties":{"latitude":{"type":["null","number"],"description":"Latitude of the location where the tour will end.","example":"41.893060"},"longitude":{"type":["null","number"],"description":"Longitude of the location where the tour will end.","example":"12.482780"},"name":{"type":"string","description":"Name of the location where the tour will end.","example":"Hotel in Rome"},"address":{"type":"string","description":"Address of the location where the tour will end.","example":"Roma, Rome, Italy"},"time":{"type":"string","description":"Time of the day when the tour will end.","example":"10:00"}}},"budget":{"type":["string","null"],"description":"A market term that defines the price category of the tour.","enum":["budget","flexible","comfort","luxury"],"example":"comfort"},"max_group_size":{"type":"integer","description":"Maximum number of passengers allowed on the tour.","example":51},"operator":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the tour operator in the TourRadar system.","example":"1170"},"name":{"type":"string","description":"Name of the tour operator.","example":"Expat Explore Travel"}}},"links":{"$ref":"#/components/schemas/ToursLinks"},"prices":{"$ref":"#/components/schemas/TourPrice"},"itinerary":{"$ref":"#/components/schemas/TourItinerary"},"start_city":{"description":"The city where the tour starts.","type":"object","properties":{"location_id":{"type":"integer","description":"Unique identifier for the city in the TourRadar system.","example":1938},"city_name":{"type":"string","description":"Name of the city.","example":"Rome"},"country_code":{"type":"string","description":"ISO code for the country where the city is located.","example":"IT"},"latitude":{"type":"number","description":"Geographic latitude.","example":41.901766},"longitude":{"type":"number","description":"Geographic longitude.","example":12.496777}}},"end_city":{"description":"The city where the tour ends.","type":"object","properties":{"location_id":{"type":"integer","description":"Unique identifier for the city in the TourRadar system.","example":1938},"city_name":{"type":"string","description":"Name of the city.","example":"Rome"},"country_code":{"type":"string","description":"ISO code for the country where the city is located.","example":"IT"},"latitude":{"type":"number","description":"Geographic latitude.","example":41.901766},"longitude":{"type":"number","description":"Geographic longitude.","example":12.496777}}},"destinations":{"$ref":"#/components/schemas/TourDestinations"},"images":{"description":"An array of images for the tour. This is limited to 3 entries, plus the image of the tour map.","type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"URL for the image on the TourRadar CDN.","example":"https://cdn.tourradar.com/s3/tour/1500x800/14263_5df8b6cf672a0.jpg"},"thumbnail_url":{"type":"string","description":"URL for the image thumbnail on the TourRadar CDN.","example":"https://cdn.tourradar.com/s3/tour/200x200/14263_5df8b6cf672a0.jpg"},"type":{"type":"string","enum":["image","map"],"description":"Type of image, can be `image` for regular tour images, or `map` for an auto-generated image that shows the tour itinerary on a geographical map."}}}},"tour_types":{"type":"array","description":"List of the types this tour is categorised under.","items":{"type":"object","properties":{"type_id":{"type":"integer","description":"Unique identifier for the tour type in the TourRadar system. For a list of all values, use the **[/taxonomy/tours/types](#tag/Taxonomy/paths/~1v1~1taxonomy~1tours~1types/get)** endpoint.","example":368},"type_name":{"type":"string","description":"Name of the tour type.","example":"Private"},"group_id":{"type":"integer","description":"Unique identifier for the tour type group in the TourRadar system. For a list of all values, use the **[/taxonomy/tours/types](#tag/Taxonomy/paths/~1v1~1taxonomy~1tours~1types/get)** endpoint.","example":1},"group_name":{"type":"string","description":"Name of the tour type group.","example":"Group"}}}},"services":{"type":"object","description":"This section describes the various services provided with the tour (accommodation, food, and so on).","properties":{"accommodation":{"type":"array","description":"Information about the nature of the accommodation provided with the tour.","items":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Flag to determine if the accommodation is included.","example":true},"description":{"type":"string","description":"Description of the accommodation components included in the tour.","example":"11 nights' accommodation in twin rooms with private en-suite facilities. Single travellers have the option to pay a single supplement to ensure a private room"},"accommodations":{"type":"array","description":"A detailed list of the accommodation options included in the tour.","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of accommodation, for example: hotel, hostel, cabin, camping, etc."},"nights":{"type":["number","null"],"description":"If available, the number of nights spent in this accommodation option."}}}},"ship_rooms":{"type":"array","description":"For cruise tours, the list of available cabin types offered.","items":{"type":"object","properties":{"ship_name":{"type":"string","description":"Name of the ship.","example":"Avalon Visionary"},"category":{"type":["null","string"],"description":"Category of the cabins.","example":"D, E"},"type":{"type":["null","string"],"description":"Description of the cabin type.","example":"Avalon Deluxe Stateroom"}}}}}}},"flights":{"type":"array","description":"Information about the inclusion of flights with the tour.","items":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Flag to determine if flights are included.","example":false},"description":{"type":"string","description":"Description of the flights included.","example":""}}}},"guide":{"type":"array","description":"Information about the tour guide.","items":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Flag to determine if the guide is included.","example":true},"description":{"type":"string","description":"Description of the included tour guide services.","example":"Services of your Expat tour leader, who will be on hand with advice and tips to ensure that you get the most from your trip"}}}},"insurance":{"type":"array","description":"Information about the travel insurance.","items":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Flag to determine if travel insurance is included.","example":false},"description":{"type":"string","description":"Description of the included insurance services.","example":""}}}},"meals":{"type":"array","description":"Information about the food services provided with the tour.","items":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Flag to determine if meals are included.","example":true},"description":{"type":"string","description":"Description of the included meals.","example":"11 breakfasts and 6 dinners"},"food_options":{"type":"array","description":"Special food options available, for example: vegetarian, halal, kosher, etc.","items":{"type":"string","example":"vegetarian"}}}}},"optional":{"type":"array","description":"Information about additional optional services that the tour offers.","items":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Flag to determine optional inclusions.","example":false},"description":{"type":"string","description":"Description of available options for the tour.","example":"On Tour Excursions: All optional excursions are booked on tour and paid in cash to your tour leader, unless stated otherwise. Please note, certain optional excursions are subject to availability and could change as a result."}}}},"others":{"type":"array","description":"Information about other services.","items":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Flag to determine other inclusions.","example":true},"description":{"type":"string","description":"Description of other included services.","example":"All taxes and fees.19 Experiences (including guided walking tours, orientation walks, driving tours of cities plus other exciting experiences).Free Expat Explore tour souvenir – a memorable gift of your once in a lifetime trip"}}}},"transport":{"type":"array","description":"Information about means of transportation included in the tour.","items":{"type":"object","properties":{"is_included":{"type":"boolean","description":"Flag to determine if transport services are included.","example":true},"description":{"type":"string","description":"Description of the transport services.","example":"Modern air conditioned coach with reclining seats, TV for showing DVDs, and toilet. Any public transport used as part of the tour (excludes free days)"},"ships":{"type":"array","description":"For cruise tours, this will identify the ship (or ships) used as means of transportation.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ship.","example":"Avalon Visionary"},"description":{"type":"string","description":"A short description of the ship.","example":"Take in the view like never before on the Avalon Visionary. You'll enjoy the intimate setting achieved with two full decks of suites featuring Wall-to-Wall Panoramic Windows."}}}}}}},"hygieneprotocol":{"type":"array","description":"Information about the hygiene protocol that the tour operator will observe. This will include vaccination requirements, if any.","items":{"properties":{"is_included":{"type":"boolean","description":"Flag to determine if hygiene protocol is included.","example":true},"description":{"type":"string","description":"Description of the hygiene protocol.","example":"You must be fully vaccinated to travel with us. Your final vaccine dose must have been administered a minimum of 15 days prior to the start of the trip. This is your second dose of Pfizer, Moderna, or Astra Zeneca, or single dose of Johnson & Johnson."}}}}}},"ratings":{"type":"object","description":"Ratings are collected by TourRadar from customers, after the tour is completed, and in some occasions provided by the operator.","properties":{"overall":{"type":["null","number"],"description":"Rating out of 5 for the overall tour.","example":4.4},"itinerary":{"type":["null","number"],"description":"Rating out of 5 for the itinerary of the tour.","example":4.5},"transport":{"type":["null","number"],"description":"Rating out of 5 for included transport services.","example":4.7},"food":{"type":["null","number"],"description":"Rating out of 5 for meals included in the tour.","example":4},"guide":{"type":["null","number"],"description":"Rating out of 5 for the guiding services of the tour.","example":4.8},"accommodation":{"type":["null","number"],"description":"Rating out of 5 for the included accommodation.","example":4},"operator":{"type":["null","number"],"description":"Rating out of 5 for the tour operator.","example":4.4}}},"reviews_count":{"type":"integer","description":"Number of reviews related to this tour.","example":23},"age_range":{"type":"object","description":"Age limits for this tour.","properties":{"strict":{"type":["null","object"],"description":"This is the operator restriction for passengers on the tour (passengers outside of this age range will not be accepted).","properties":{"min_age":{"type":"integer","description":"Minimum age limit for passengers on the tour.","example":15},"max_age":{"type":"integer","description":"Maximum age limit for passengers on the tour.","example":99}}},"recommended":{"type":["null","object"],"description":"This is the operator recommended age range, based on the activities part of the tour.","properties":{"min_age":{"type":["integer","null"],"description":"Minimum age limit for passengers on the tour.","example":18},"max_age":{"type":["integer","null"],"description":"Maximum age limit for passengers on the tour.","example":65}}}}},"has_machine_translated_content":{"type":["null","boolean"],"description":"This flag indicates if the content in the current language was translated automatically (using a Machine Translation service), or is provided by the operator. It is recommended to display a warning in case content is automatically translated, and if the content is included on a public website, the page should be marked as `noindex` for search engines.","example":"false"},"departure_months":{"type":"array","description":"List of available departure by month.","items":{"type":"object","properties":{"year":{"type":"integer","description":"Year of departure date.","example":2025},"month":{"type":"integer","description":"Month of departure date. 1 is January ... 12 is December.","example":1}}}}}},"TaxonomyDestinationPagination":{"required":["current_page","items"],"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TaxonomyDestination"}},"next_page":{"type":"integer","description":"If this attribute exists, then another page is available. To get more results, repeat the request with the number specified in the `page` parameter. If this attribute is not part of the response, then the last page has been reached."}}},"PartnerRegisterOutput":{"type":"object","required":["partner","user","resend_token"],"properties":{"partner":{"$ref":"#/components/schemas/Partner"},"user":{"$ref":"#/components/schemas/PartnerUser"},"resend_token":{"type":"string","description":"Token to be able call resend email endpoint","example":"GYW9qfFPQGNy9JtF!+ssa="}}},"PartnerAdminFindDomain":{"type":"object","properties":{"partner":{"$ref":"#/components/schemas/Partner"},"customizations":{"$ref":"#/components/schemas/PartnersCustomizations"},"related_partners":{"$ref":"#/components/schemas/PartnersRelatedPartners"},"domain":{"type":"object","properties":{"domain":{"type":"string","description":"The domain url","example":"llama-travel.whitelabel.tourradar.com"},"type":{"type":"string","description":"The type of the domain","enum":["whitelabel","agent-portal","shop"],"example":"whitelabel"}}}}},"PartnersCustomizations":{"type":"object","description":"Partner branding customizations","properties":{"agency_name":{"type":"string","description":"Agency name"},"domain":{"type":"string","description":"Domain for shop/whitelabel"},"agents_domain":{"type":"string","description":"Agent portal domain"},"footer":{"type":"string","description":"Footer HTML code"},"gtag":{"type":"string","description":"Google tag ID"},"header":{"type":"string","description":"Header HTML code"},"header_mode":{"type":"string","description":"The header mode to be displayed. direct - code will be placed directly to website, isolation - code will be placed in iframe","enum":["direct","isolation"],"example":"isolation"},"header_logo":{"type":"object","description":"The logo to be displayed in the header.","properties":{"url":{"type":"string","description":"The URL of the image to be displayed.","example":"http://www.example.com/image.png"},"width":{"type":"number","description":"The width of the image in pixels.","example":256},"height":{"type":"number","description":"The height of the image in pixels.","example":144}}},"email_logo":{"type":"object","description":"The logo to be displayed in the header.","properties":{"url":{"type":"string","description":"The URL of the image to be displayed.","example":"http://www.example.com/image.png"},"width":{"type":"number","description":"The width of the image in pixels.","example":256},"height":{"type":"number","description":"The height of the image in pixels.","example":144}}},"homepage":{"type":"integer","description":"CLP page id to homepage"},"question_page":{"type":"integer","description":"CLP page id to question page"},"not_found_page":{"type":"integer","description":"CLP page id to 404 not found page"},"tdp_page":{"type":"integer","description":"CLP page id to Tour Detail Page"},"retargeting":{"type":"boolean","description":"Determine if partner has whitelabel domain or not","example":true},"support":{"type":"boolean","description":"If true, on partner page will be enabled customer support links","example":true},"login":{"type":"boolean","description":"If true, travellers will be able to login","example":true},"bnpHeaderColor":{"type":"string","description":"For white-labeling purposes, enable the option to apply the brand color to the header background of the ‘Book Now’ page."},"color":{"type":"string","description":"Customize the color of your whitelabel pages branding"},"disableInsuranceOption":{"type":"boolean","description":"By default agents and their customers are able to purchase insurance on bookings.","example":true},"disableCoBrandedTdpBookability":{"type":"boolean","description":"By default, when you share Co-branded TDP, the customer will be able to make a booking from this page.","example":true},"whitelabeled_bcp":{"type":"boolean","description":"By default customer conversation pages are not whitelabeled.","example":true},"access_filter":{"type":"object","description":"More information https://tourradar.atlassian.net/wiki/spaces/B2b/pages/3493363825/AccessLevel+filter+schema"},"operator_id":{"type":"integer","description":"Connected Operator ID"},"additional_operators_id":{"type":"array","items":{"type":"integer","description":"Additional connected Operator IDs"}},"direct_payment_info":{"type":"string","description":"The payment terms and links entered here will be displayed on the booking confirmation/success page for operator shop partners who have enabled direct payment contract type."},"bcp_direct_payment_info":{"type":"string","description":"The payment terms and links entered here will be displayed on the BCP for bookings of shop direct payment type."},"allow_enquiry_create_op_dash":{"type":"boolean","description":"Allow enquiry creation op-dash","example":true},"allow_bnp_help_and_share":{"type":"boolean","description":"Allow Book now page help & share feature","example":true},"bnp_header_background_color":{"type":"string","description":"Customize the color of your whitelabel bnp header"},"has_customer_data_access":{"type":"boolean","description":"Has access to customer data","example":true},"bnp_terms_prefix":{"type":"string","description":"Text that will be prepended to the BNP standard T&C"},"payment_confirmation_page_info":{"type":"string","description":"Additional information that will be displayed on the payment confirmation page."}}},"PartnersRelatedUsers":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerUser"}}},"ToursList":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/ToursLinks"},"budget":{"type":["string","null"],"description":"A market term that defines the price category of the tour.","enum":["budget","flexible","comfort","luxury"],"example":"comfort"},"images":{"description":"An array of images for the tour.","type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"URL for the image on the TourRadar CDN.","example":"https://cdn.tourradar.com/s3/tour/1500x800/14263_5df8b6cf672a0.jpg"},"thumbnail_url":{"type":"string","description":"URL for the image thumbnail on the TourRadar CDN.","example":"https://cdn.tourradar.com/s3/tour/200x200/14263_5df8b6cf672a0.jpg"}}}},"locale":{"type":"string","description":"Language locale the content is provided, default is `en_US` (English).","example":"en_US"},"prices":{"$ref":"#/components/schemas/TourPrice"},"ratings":{"type":"object","description":"Ratings are collected by TourRadar from customers, after the tour is completed, and in some occasions provided by the operator.","properties":{"overall":{"type":"number","description":"Rating out of 5 for the overall tour.","example":4.4},"itinerary":{"type":"number","description":"Rating out of 5 for the itinerary of the tour.","example":4.5},"transport":{"type":"number","description":"Rating out of 5 for included transport services.","example":4.7},"food":{"type":"number","description":"Rating out of 5 for meals included in the tour.","example":4},"guide":{"type":"number","description":"Rating out of 5 for the guiding services of the tour.","example":4.8},"accommodation":{"type":"number","description":"Rating out of 5 for the included accommodation.","example":4},"operator":{"type":"number","description":"Rating out of 5 for the tour operator.","example":4.4}}},"tour_id":{"type":"integer","description":"Unique identifier for the tour in the TourRadar system (please note that this is different from the operator code).","example":14263},"end_city":{"$ref":"#/components/schemas/TourCity"},"language":{"type":"string","description":"Language code the content is provided, default is `en` (English).","example":"en"},"operator":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the tour operator in the TourRadar system.","example":1170},"name":{"type":"string","description":"Name of the tour operator.","example":"Expat Explore Travel"}}},"is_active":{"type":"boolean","description":"Determines if the tour is currently active, e.g. if it has departure dates that can be booked. Note: inactive tours are never returned by searching, but they could have existing bookings, so it's possible to retrieve them directly by ID.","example":"true"},"tour_name":{"type":"string","description":"Name of the tour. Note that tour names are sometimes adjusted by TourRadar, and might not exactly match the name provided by the operator.","example":"Europe Escape - 12 Days"},"start_city":{"$ref":"#/components/schemas/TourCity"},"tour_types":{"type":"array","description":"List of the types this tour is categorised under.","items":{"type":"object","properties":{"type_id":{"type":"integer","description":"Unique identifier for the tour type in the TourRadar system. For a list of all values, use the **[/taxonomy/tours/types](#tag/Taxonomy/paths/~1v1~1taxonomy~1tours~1types/get)** endpoint.","example":368},"type_name":{"type":"string","description":"Name of the tour type.","example":"Private"},"group_id":{"type":"integer","description":"Unique identifier for the tour type group in the TourRadar system. For a list of all values, use the **[/taxonomy/tours/types](#tag/Taxonomy/paths/~1v1~1taxonomy~1tours~1types/get)** endpoint.","example":1},"group_name":{"type":"string","description":"Name of the tour type group.","example":"Group"}}}},"description":{"type":["null","string"],"description":"Description of the tour, providing a summary of the itinerary and the key important selling points for the tour.","example":"This is the flagship tour that started it all for Expat Explore! Journey to 8 of Europe's most popular countries. Start off by getting to know the Italian way of life in Rome and the romantic Venice. Explore the gem that is Paris, and meander through the countryside of France. Cross borders to the heart of the Swiss Alps and see castle-lined riverbanks in Germany’s Rhine Valley. Explore the vibrant streets and beautiful canals of Amsterdam. There’s so much in store for you! Please note: there are changes to the itinerary for 2021 departures - see the itinerary and contact us for info"},"destinations":{"$ref":"#/components/schemas/TourDestinations"},"max_group_size":{"type":"integer","description":"Maximum number of passengers allowed on the tour.","example":51},"tour_length_days":{"type":"integer","description":"Length of the tour, expressed in number of days.","example":12},"is_instant_confirmable":{"type":"boolean","description":"If true, bookings related to this tour can be instantly confirmed by the operator.","example":true},"age_range":{"type":"object","description":"Age limits for this tour.","properties":{"strict":{"type":"object","description":"This is the operator restriction for passengers on the tour (passengers outside of this age range will not be accepted).","properties":{"min_age":{"type":"integer","description":"Minimum age limit for passengers on the tour.","example":15},"max_age":{"type":"integer","description":"Maximum age limit for passengers on the tour.","example":99}}},"recommended":{"type":"object","description":"This is the operator recommended age range, based on the activities part of the tour.","properties":{"min_age":{"type":["integer","null"],"description":"Minimum age limit for passengers on the tour.","example":18},"max_age":{"type":["integer","null"],"description":"Maximum age limit for passengers on the tour.","example":65}}}}}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"The error code","enum":["UNKNOWN_ERROR"]},"message":{"type":"string","description":"The error message, if available"},"context":{"type":"object","description":"Additional data relative to the error condition"},"validation_errors":{"type":"array","description":"In case of validation error, all the elements that didn't pass validation","items":{"type":"string"}}}},"TaxonomyToursTypesList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Type ID.","example":183},"name":{"type":"string","description":"Type name.","example":"Self Drive"},"group_id":{"type":"integer","description":"Group ID.","example":2},"group_name":{"type":"string","description":"Group name.","example":"Guide Type"},"links":{"$ref":"#/components/schemas/TaxonomyLinks"}}}},"PartnerDetails":{"type":"object","properties":{"id":{"type":"string","description":"Partner ID","example":"tourradar"},"name":{"type":"string","description":"Name of partner","example":"Tourradar GMBH"},"industry":{"type":["null","string"],"enum":["travel_agent","association","travel_organiser"],"description":"Industry","example":"travel_organiser"},"address":{"type":"string","description":"Address of operator","example":"Kärntner Ring 5-7 Top 304-306"},"city":{"type":"string","description":"City of operator","example":"Vienna"},"state":{"type":"string","description":"State of operator","example":"Vienna"},"zip_code":{"type":"string","description":"Zip-code","example":"1010"},"country":{"type":"string","description":"Country of operator in ISO-2 code","example":"AT"},"currency":{"type":"string","description":"Default currency for partner","example":"EUR"},"phone_number":{"type":"string","description":"Phone number to operator","example":"+43 829-424-124"},"travel_accreditation_id":{"type":"string","description":"Travel accreditation ID","example":"IAPL9291"},"number_of_agents":{"type":["string","null"],"description":"Range of agents","example":"51-100"},"email":{"type":"string","description":"Email to operator","example":"contact@tourradar.com"},"contact_username":{"type":"string","description":"Username ID to contact","example":"9b9839999-ef9465edb982e-3892a284fa"},"travel_accreditation_code":{"enum":["ABTA","ACTA","AFTA","ASTA","CLIA","IATA","TAANZ","Other"],"description":"Travel accreditation CODE","example":"ABTA"},"travel_accreditation_code_other":{"type":"string","description":"Travel accreditation code when selected options selected is Other","example":"xyz"},"travel_accreditation_code_owner":{"type":"boolean","description":"Travel accreditation code owner","example":false},"social_media":{"type":"array","description":"List of the URLs/handlers (social media, website, ...) related to the partner","maxItems":10,"items":{"type":"object","properties":{"reference":{"type":"string","description":"URL or handler","example":"https://www.myownwebsite.com","maxLength":128},"followers":{"type":["string","null"],"description":"Number of followers","enum":["less_than_5k","between_5k_and_20k","between_20k_and_100k","more_than_100k"],"example":"more_than_100k"},"type":{"type":"string","description":"Type of URL","example":"website","maxLength":20}}}},"website_monthly_visitors":{"type":["string","null"],"description":"Website monthly visitors","enum":["less_than_50k","between_50k_and_150k","between_150k_and_300k","more_than_300k"],"example":"between_50k_and_150k"},"affiliate_company_type":{"type":["string","null"],"description":"Affiliate company type","enum":["business","individual"],"example":"individual"},"affiliate_type":{"type":["string","null"],"description":"Affiliate type","enum":["content_reviews","deals_coupons","loyalty_rewards","network","commerce_solution","media_arbitrage","cross_audience_monetization","other"],"example":"loyalty_rewards"},"hyperwallet":{"type":"object","properties":{"account_status":{"type":"string","description":"Status of the Hyperwallet account","example":"ACTIVE"},"verification_status":{"type":"string","description":"Status of the Hyperwallet KYC verification","example":"VERIFIED"},"updated_at":{"type":"string","description":"Date of the last update","example":"2020-04-24T12:00:00Z"}}},"payout":{"type":"object","properties":{"address":{"type":"string","description":"Address of operator","example":"Kärntner Ring 5-7 Top 304-306"},"city":{"type":"string","description":"City of operator","example":"Vienna"},"state":{"type":"string","description":"State of operator","example":"Vienna"},"zip_code":{"type":"string","description":"Zip-code","example":"1010"},"country":{"type":"string","description":"Country of operator in ISO-2 code","example":"AT"},"currency":{"type":"string","description":"Default currency for partner","example":"EUR"},"bank_code":{"type":"string","description":"Bank SWIFT/BIC code","example":"BREXPLPWXXX"},"iban":{"type":"string","description":"International bank account number","example":"PL 65 1500 1067 0762 0589 8586 4321"},"account_number":{"type":"string","description":"Regular bank account number. Typically, an account number can be eight or nine or even 11 digits signifier.","example":"012345678"},"account_name":{"type":"string","description":"Bank account name. The account holder's name. Usually the name of a person authorized to have an account, verifiable using specific personal information. Not required for payments","example":"Adam Smith"},"bank_name":{"type":"string","description":"Bank name","example":"mBank"},"notice_email":{"type":"string","description":"Notice email","example":"payment@tourradar.com"},"sort_code":{"type":"string","description":"Bank transit number, routing number or sort code is a 9-digit number (US), a 6-digit number (CA) or 11-digit alpha-numeric code (India - IFSC) - that's assigned to a branch of a bank that holds the account, for internal purposes","example":"ICIC0001359"}}}}},"BookingDeclineReason":{"type":["string","null"],"description":"The reason of the declination, if set.","enum":["already_booked","alt_tour_selected","another_tour_found","border_restrictions","death_in_family","departure_cancelled","duplicate_booking","employment_status","employment_status_change","family_issues","health_issue","invalid_request","on_request_cancelled","operator_error","operator_timeout","other","pax_requested_decline","pax_unfit","plans_changed","price_incorrect","price_incorrect_deal_promotion","price_incorrect_single_supplement","requirements_unmet","server_error","suspected_fraud","system_error","tour_itinerary_details_incorrect","tour_unavailable","tour_unavailable_departure_soon","tour_unavailable_fully_booked","tour_unavailable_no_date","unknown_error","visa_declined","withdrawn_tour"],"example":"operator_error"},"HoldInput":{"type":"object","properties":{"tour_id":{"type":"integer","description":"Unique identifier for the tour in the TourRadar system.","example":5113},"departure_id":{"type":"integer","description":"Unique identifier of the departure date. For a list of departure dates, use the **[/tours/{tourId}/departures](#tag/Pricing-and-Availability/paths/~1v1~1tours~1{tourId}~1departures/get)** endpoint.`","example":736283495},"currency":{"description":"Currency code for the booking. The default is `USD`.","enum":["USD","AUD","GBP","NZD","EUR","CAD"],"example":"EUR"},"email":{"description":"Email address for the lead passenger.","type":"string","example":"jane.doe@tourradar.com"},"user_country":{"description":"Identifier for the country of residence of the main passenger. Country IDs can be obtained from the **[/taxonomy/destinations/country](#tag/Taxonomy/paths/~1v1~1taxonomy~1destinations~1{type}/get)** endpoint.","type":"integer","example":139},"passengers":{"type":"array","description":"List of passengers. Each entry represents one passenger.","items":{"type":"object","properties":{"pax_number":{"type":"integer","description":"Passenger identifier, starting from 1. If the booking contains 5 passengers, the values must be from 1 to 5."},"price_category_id":{"type":"integer","description":"Price category ID retrieved from the **[/tours/{tourId}/prices](#tag/Pricing-and-Availability/paths/~1v1~1tours~1{tourId}~1prices/get)** endpoint."},"fields":{"type":"object","description":"A set of key-value pairs containing passenger information. For a list of the available and mandatory keys, use the **[/operators/{operatorId}/booking-fields](#tag/Operators/paths/~1v1~1operators~1{operator}~1booking-fields/get)** endpoint."}},"example":[{"pax_number":1,"price_category_id":1634,"fields":{"title":"Mr.","first_name":"John","last_name":"Doe","email":"john.doe@tourradar.com","phone_number":"+46 029 01920 028","date_of_birth":"11/06/1993","gender":"male","address":"Kartner Ring 5-7 Top 304-306","city":"Vienna","postal_code":"1010","state":"Vienna","country":"Austria","nationality":"Austria","pre_existing_medical_conditions":"none"}},{"pax_number":2,"price_category_id":1634,"fields":{"title":"Ms.","first_name":"Jane","last_name":"Doe","email":"jane.doe@tourradar.com","date_of_birth":"25/05/1994","nationality":"Austria","gender":"female","pre_existing_medical_conditions":"none"}}]}},"accommodations":{"type":"array","description":"Accommodation requested, and assignment to passengers.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the selected accommodation, taken from the **[/tours/{tourId}/departures/{departureId}](#tag/Pricing-and-Availability/paths/~1v1~1tours~1{tourId}~1departures~1{departureId}/get)** endpoint."},"passengers":{"type":"array","description":"List of `pax_number` identifiers that should be placed in the selected accommodation.","items":{"type":"integer"}}}},"example":[{"id":396410,"passengers":[1,2]}]},"optional_extras":{"type":"array","description":"Optional extras requested, and assignment to passengers.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of an optional extra, taken from the **[/tours/{tourId}/departures/{departureId}](#tag/Pricing-and-Availability/paths/~1v1~1tours~1{tourId}~1departures~1{departureId}/get)** endpoint."},"passengers":{"type":"array","description":"List of `pax_number` identifiers for which this optional extra is being booked.","items":{"type":"integer"}}}},"example":[{"id":644520,"passengers":[1,2]}]},"partner_booking_code":{"description":"the booking code, or reference number, in your system. This will be stored with the booking, and returned with the booking detail request.","type":"string","example":"the_code_value"},"custom_data":{"description":"Additional info set by the partner when creating the booking. Up to 5 string properties can be set in it.","type":"object","example":{"custom_attribute":"custom value","custom_date":"Tuesday"}},"store_id":{"type":["string","null"],"description":"Identifier of the store, or agency, that made the booking. Note: this is only relevant for bookings made via the TourRadar Partner API.","example":"878"}},"required":["departure_id","email","passengers","user_country"]},"TourPriceCategories":{"type":"object","properties":{"price_categories":{"type":"array","description":"List of all available price categories.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the price category in the TourRadar system.","example":1633},"age_max":{"type":["integer","null"],"description":"Maximum age for passengers to qualify for this category (or null if no limit).","example":39},"age_min":{"type":["integer","null"],"description":"Minimum age for passengers to qualify for this category (or null if no limit).","example":18},"price_category_type_id":{"type":"integer","description":"Price category type id.","example":1},"external_reference":{"type":"string","description":"External reference of the category.","example":"adult"},"title":{"type":"string","description":"Title of the price category.","example":"Adult"},"description":{"type":"string","description":"Description of the price category.","example":"Adult"},"occupancy":{"type":"integer","description":"The number of seats the category requires.","example":1},"title_plural":{"type":"string","description":"Plural of the title.","example":"Adults"}}}}}},"PartnersDomainList":{"type":"array","items":{"$ref":"#/components/schemas/PartnersDomain"}},"OperatorCreateInput":{"type":"object","required":["id","name","commission_group","code","has_integration","terms_url"],"properties":{"id":{"type":"integer","description":"Operator ID","example":123},"name":{"type":"string","description":"Operator name","example":"TourRadar GmbH"},"commission_group":{"type":"integer","description":"Operator comission group","example":2},"code":{"type":"string","description":"Operator code","example":"tourradar"},"has_integration":{"type":"boolean","description":"If operator has integration","example":true},"terms_url":{"type":"string","description":"Operator url to terms and conditions","example":"https://some-terms-and-conditions/"}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"The error code","enum":["UNKNOWN_ERROR"]},"message":{"type":"string","description":"The error message, if available"},"context":{"type":"object","description":"Additional data relative to the error condition"},"validation_errors":{"type":"array","description":"In case of validation error, all the elements that didn't pass validation","items":{"type":"string"}}}},"PartnerCreateInput":{"type":"object","required":["id","name","role","status"],"properties":{"id":{"type":"string","description":"Partner ID","example":"4d353262-f2e8-4de6-8585-9e813e187c60"},"name":{"type":"string","description":"Partner name","example":"TourRadar GmbH"},"status":{"enum":["active","inactive"],"description":"Status of partner","example":"inactive"},"role":{"type":"string","description":"Partner role","example":"api"},"notes":{"type":"string","description":"Internal notes about partner","example":"Some note"},"payout_terms":{"type":"object","description":"The commission payout terms","properties":{"terms_days":{"type":"integer","description":"Describe margin days when payout will be made","example":-5},"base_date":{"enum":["tour_start_date","tour_end_date"],"description":"Describe when commission will be payout","example":"tour_end_date"}}},"is_whitelabel":{"type":"boolean","description":"Determine if partner has whitelabel domain or not","example":true}}},"PartnerRegisterShopAgent":{"type":"object","required":["operator_id","email","captcha_token"],"properties":{"operator_id":{"type":"number","description":"Shop partner operator ID","example":"123"},"email":{"type":"string","description":"Email","example":"shop@agent.com"},"captcha_token":{"type":"string","description":"Captcha token given by reCaptcha v2","example":"5LYAsJfUJ3V5eT8mN9DZTyVCg"}}},"PartnersRegisterBranding":{"type":"object","description":"Partner register branding customizations","properties":{"partner":{"type":"object","properties":{"name":{"type":"string","description":"The name of the partner."}}},"customizations":{"type":"object","properties":{"agents_domain":{"type":"string","description":"Agent portal domain"},"header_logo":{"type":"object","description":"The logo to be displayed in the header.","properties":{"url":{"type":"string","description":"The URL of the image to be displayed.","example":"http://www.example.com/image.png"},"width":{"type":"number","description":"The width of the image in pixels.","example":256},"height":{"type":"number","description":"The height of the image in pixels.","example":144}}},"color":{"type":"string","description":"Customize the color of your whitelabel pages branding"},"terms_page":{"type":"string","description":"The URL of the terms and conditions page to be displayed in the footer."}}}}},"DefaultError401":{"type":"object","properties":{"error":{"type":"string","description":"The error code","enum":["UNAUTHORIZED"]},"message":{"type":"string","description":"The error message, if available"},"context":{"type":"object","description":"Additional data relative to the error condition"},"validation_errors":{"type":"array","description":"In case of validation error, all the elements that didn't pass validation","items":{"type":"string"}}}},"DefaultError500":{"type":"object","properties":{"error":{"type":"string","description":"The error code","enum":["UNKNOWN_ERROR"]},"message":{"type":"string","description":"The error message, if available"},"context":{"type":"object","description":"Additional data relative to the error condition"},"validation_errors":{"type":"array","description":"In case of validation error, all the elements that didn't pass validation","items":{"type":"string"}}}}},"securitySchemes":{"application":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://oauth.api.sandbox.b2b.tourradar.com/oauth2/token","scopes":{"com.tourradar.bookings/read":"Read booking information","com.tourradar.bookings/write":"Create new bookings","com.tourradar.bookings.affiliate/read":"Read booking information","com.tourradar.operators/read":"Read operators information","com.tourradar.tours/read":"Read tours informations"}}}}}}}