| Error Code | Issue |
|---|
| BOOKING_REDEEMED | The booking was already used/redeemed by the traveler and the reservation system has this information. |
| BOOKING_IN_PAST | The booking is in the past and cannot be canceled |
| BOOKING_ALREADY_CANCELLED | The booking has already been canceled on the Connectivity partner's end |
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BookingCancellationRequest'
examples:
Success Response:
value:
data:
bookingReference: bk456
gygBookingReference: GYG1B2D34GHI
productId: bk456
/1/notify/:
post:
summary: Notification
operationId: post-notify
tags:
- Notification
description:
$ref: 'description-notify.md'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
examples:
Product Deactivation:
$ref: '#/components/examples/NotificationProductDeactivation'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EmptySuccessResponse'
examples:
Success Response:
value:
data: {}
/1/products/{productId}/pricing-categories/:
get:
summary: Pricing Categories
operationId: get-pricing-categories
tags:
- Products
description:
$ref: 'description-pricing-categories.md'
parameters:
- schema:
type: string
in: path
name: productId
required: true
description: The ID of the requested product in the supplier’s system.
example: prod123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PricingCategoriesResponse'
/1/suppliers/{supplierId}/products/:
get:
summary: Products List
operationId: get-supplier-products
tags:
- Products
description:
$ref: 'description-product-list.md'
parameters:
- schema:
type: string
in: path
name: supplierId
description: The Supplier ID of the supplier on the Partner platform (SRS).
required: true
example: "Abc123"
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SupplierProductsResponse'
- $ref: '#/components/schemas/ProductsListErrorResponse'
examples:
Success Response:
value:
data:
supplierId: "supplier123"
supplierName: "Supplier Name"
products:
- productId: "prod123"
productTitle: "Product Title"
- productId: "prod456"
productTitle: "Another product Title"
Error Response:
value:
errorCode: INVALID_SUPPLIER
errorMessage: Supplier ID not found
/1/products/{productId}/addons/:
get:
summary: Fetch Addons
operationId: fetch-addons
tags:
- Addons
description:
$ref: 'description-addons.md'
parameters:
- name: productId
in: path
required: true
description: Product identifier in the Connectivity partner's system
example: 'PPYM1U'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AddonsResponse'
- $ref: '#/components/schemas/AddonsErrorResponse'
examples:
Success Response:
value:
data:
addons:
- addonType: FOOD
retailPrice: 1050
currency: EUR
- addonType: OTHERS
retailPrice: 100
currency: EUR
addonDescription: Donation to support the local community
- addonType: TRANSPORT
retailPrice: 500
currency: EUR
addonDescription: Shuttle bus from the hotel
Error:
value:
errorCode: INVALID_PRODUCT
errorMessage: This product does not exist
/1/products/{productId}:
get:
summary: Product Details
operationId: get-product-details
tags:
- Products
description:
$ref: 'description-product-details.md'
parameters:
- name: productId
in: path
required: true
description: Product identifier in the Connectivity partner's system
example: 'PPYM1U'
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ProductDetailsResponse'
- $ref: '#/components/schemas/ProductDetailsErrorResponse'
examples:
Success Response:
value:
data:
supplierId: supplier123
productTitle: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
productDescription: Nunc pulvinar vulputate scelerisque...
destinationLocation:
city: Berlin
country: DEU
configuration:
participantsConfiguration:
min: 1
max: 10
Error:
value:
errorCode: INVALID_PRODUCT
errorMessage: This product does not exist
components:
examples:
ErrorMaxParticipantSizeConstraint:
value:
errorCode: INVALID_PARTICIPANTS_CONFIGURATION
errorMessage: The activity requires a minimum of 4 participants
participantsConfiguration:
min: 4
max: null
ErrorMinParticipantSizeConstraint:
value:
errorCode: INVALID_PARTICIPANTS_CONFIGURATION
errorMessage: The activity cannot be reserved for more than 5 participants
participantsConfiguration:
min: 1
max: 5
ErrorGroupSizeConstraint:
value:
errorCode: INVALID_PARTICIPANTS_CONFIGURATION
errorMessage: The activity cannot be reserved for more than 5 participants per group; max 2 groups are allowed
participantsConfiguration:
min: 1
max: 5
groupConfiguration:
max: 2
NotificationProductDeactivation:
value:
data:
notificationType: PRODUCT_DEACTIVATION
description: GetYourGuide - Product ID - prod123 is deactivated due to API Error
supplierName: Mock Travel Agency
integrationName: Mock Reservation System
productDetails:
productId: prod123
gygTourOptionId: '123456'
tourOptionTitle: Mock Walking Tour in a Mock City
notificationDetails:
failedRequestType: reserve
deactivationTimestamp: '2022-09-28T14:54:10+02:00'
gygBookingReference: GYG2RA9W579V
travellers: '5x adult, 1x child, '
errorType: no_availability
errorMessageReceived: Requested timeslot is not available
vacanciesReceivedAfterGetAvailability: '99'
activityStartTime: '2022-09-30T00:00:00-04:00'
activityTimeZone: America/New_York
dateTime: '2022-09-28T16:34:33+02:00'
schemas:
Availability:
type: object
properties:
dateTime:
type: string
format: date-time
description: The date/time of the activity (ISO 8601). Content of the time part depends on the type (see time point vs time period).
vacancies:
type: integer
minimum: 0
description: |
For Individual ticket categories, this is the total number of vacancies across all categories for the requested product at the time slot specified in the dateTime field. If the product has “unlimited” availability please use a large value here. E.g. 5000. For GROUP products, this is the total number of available groups, not the total number of individual vacancies.
**Note** - The "vacancies" field has an internal GetYourGuide cap of "5000". If received vacancies exceed 5000 for any DateTimeslot, GetYourGuide will still cap the value to 5000
vacanciesByCategory:
type: array
description: |
For Individual ticket categories, this is the number of vacancies available for each ticket category for the requested product at the time slot specified in the dateTime field. For GROUP products, this isn't supported.
items:
$ref: '#/components/schemas/VacanciesByCategory'
cutoffSeconds:
type: integer
minimum: 0
description: Cut-off time expressed in seconds for the availability of a specific product (the time until which a product can be booked). This field can be 0
currency:
type: string
description: 'Code of the currency (ISO 4217), using alphabetic code and three characters in length. Must be a supported currency. Example: "EUR"'
pricesByCategory:
type: object
description: 'Object representing the prices of the product'
properties:
retailPrices:
type: array
description: 'List of retail prices per categories'
items:
type: object
properties:
category:
enum:
- ADULT
- CHILD
- YOUTH
- INFANT
- SENIOR
- STUDENT
- EU_CITIZEN
- MILITARY
- EU_CITIZEN_STUDENT
- GROUP
description: The category for which the retail price is being provided.
type: string
price:
type: integer
minimum: 0
description: 'Integer representation of the smallest unit of the currency. Example: 10.00 Euro should be 1000. Following currencies are exception - JPY, CLP, KRW, VND. For these currencies we expect the exact retail price. Example: 5000 JPY should be price 5000'
required:
- category
- price
required:
- retailPrices
tieredPricesByCategory:
type: object
description: 'Object representing the tiered prices of the product'
properties:
retailPrices:
type: array
description: 'List of tiered prices per categories'
items:
type: object
properties:
category:
enum:
- ADULT
- CHILD
- YOUTH
- INFANT
- SENIOR
- STUDENT
- EU_CITIZEN
- MILITARY
- EU_CITIZEN_STUDENT
- GROUP
description: The category for which the retail price is being provided.
type: string
nullable: false
tiers:
type: array
description: 'List of prices with tiers'
nullable: false
items:
type: object
properties:
lowerBound:
type: integer
description: 'The minimum number of participants for this price tier. Inclusive.'
nullable: false
upperBound:
type: integer
description: 'The maximum number of participants for this price tier. Inclusive.'
nullable: true
price:
type: integer
description: 'Integer representation of the smallest unit of the currency. Example: 10.00 Euro should be 1000. Following currencies are exception - JPY, CLP, KRW, VND. For these currencies we expect the exact retail price. Example: 5000 JPY should be price 5000'
nullable: false
openingTimes:
type: array
description: 'A list of opening times (from/to pairs) for time period product only. Should be in the format HH:MM'
items:
type: object
properties:
fromTime:
type: string
description: 'Example: "09:00"'
toTime:
type: string
description: 'Example: "12:00"'
productId:
type: string
description: The ID of the requested product in the supplier’s system that this availability refers to.
required:
- productId
- dateTime
oneOf:
- required:
- vacancies
- required:
- vacanciesByCategory
VacanciesByCategory:
type: object
required:
- category
- vacancies
properties:
category:
enum:
- ADULT
- CHILD
- YOUTH
- INFANT
- SENIOR
- STUDENT
- EU_CITIZEN
- MILITARY
- EU_CITIZEN_STUDENT
description: 'The ticket categories for which the availabilities is being provided.'
type: string
vacancies:
type: integer
minimum: 0
description: |
The number of vacancies available for the ticket Category.
AvailabilityResponse:
type: object
properties:
data:
type: object
properties:
availabilities:
type: array
items:
$ref: '#/components/schemas/Availability'
required:
- availabilities
required:
- data
BookingCancellationRequest:
type: object
properties:
data:
type: object
properties:
bookingReference:
type: string
description: 'An alphanumeric identifier for the booking in the supplier’s system. Maximum length of 25 characters. Example: GYG123JKE453-sf3321C'
gygBookingReference:
type: string
description: The reference of this booking in GetYourGuide’s system.
productId:
type: string
description: The ID of the requested product in the supplier’s system. Please avoid using the character `%` in the `productId`.
required:
- bookingReference
- gygBookingReference
- productId
required:
- data
ReservationBookingItem:
type: object
properties:
category:
$ref: '#/components/schemas/Category'
groupSize:
type: integer
description: 'Indicates the amount of pax per group, only provided in the context of a bookingItem of category type GROUP. The number of persons being reserved for the specified category. When bookingItems[].category is GROUP it must indicate the number of persons in that group.'
count:
type: integer
description: 'The number of persons being reserved for the specified category. When bookingItems[].category is GROUP this will always be 1. If we are reserving multiple groups we will add multiple bookingItems.'
required:
- category
- count
BookingItem:
type: object
properties:
category:
$ref: '#/components/schemas/Category'
groupSize:
type: integer
description: 'Indicates the amount of pax per group, only provided in the context of a bookingItem of category type GROUP. The number of persons being reserved for the specified category. When bookingItems[].category is GROUP it must indicate the number of persons in that group.'
count:
type: integer
description: 'The number of persons being reserved for the specified category. When bookingItems[].category is GROUP this will always be 1. If we are reserving multiple groups we will add multiple bookingItems.'
retailPrice:
type: integer
description: 'The basic retail price in the given currency that GetYourGuide charged the customer for one participant of this category during the booking process. This will be sent for all options, regardless of whether Price Over API is enabled. The received retailPrice must never be the reason to fail the booking request. If you observe a wrong price being sent, do not reject the booking and reach out to the Connectivity Support team.'
required:
- category
- count
- retailPrice
AddonItem:
type: object
properties:
addonType:
type: string
description: The Addon Type which is provided during booking.
enum:
- FOOD
- DRINKS
- SAFETY
- TRANSPORT
- DONATION
- OTHERS
addonDescription:
type: string
description: |
The description of the addon in your system. Max 50 characters. This field is optional but required and must be unique when multiple addons with the same addonType are present in the response.
count:
type: integer
description: 'The number of Addon being booked for the specified Addon.'
retailPrice:
type: integer
description: Integer representation of the smallest unit of the currency. F.e. 10.00 Euro should be 1000. Following currencies are exception - JPY, CLP, KRW, VND. For these currencies we expect the exact retail price. F.e. 5000 JPY should be price 5000.
BookingRequest:
type: object
properties:
data:
type: object
properties:
productId:
type: string
description: The ID of the requested product in the supplier’s system. Please avoid using the character `%` in the `productId`.
reservationReference:
type: string
description: The identifier for the reservation in the supplier’s system as returned by the reserve call.
gygBookingReference:
type: string
description: The reference of this booking in GetYourGuide’s system.
gygActivityReference:
type: string
description: The reference of this activity in GetYourGuide’s system.
currency:
type: string
description: The currency of the retail prices in the request.
dateTime:
type: string
format: date-time
description: The date/time of the activity to be reserved (ISO 8601). The date/time of the activity (ISO 8601). Content of the time part is depending on the type (see time point vs time period above).
bookingItems:
type: array
items:
$ref: '#/components/schemas/BookingItem'
description: A list specifying the number of persons per category in this reservation. The data will be the same as in the corresponding field of the reservation call.
addonItems:
type: array
items:
$ref: '#/components/schemas/AddonItem'
description: A list of objects containing information about the addons of this booking.
language:
type: string
description: ISO 639-1 code of the language in which the product shall be booked.
travelers:
type: array
items:
$ref: '#/components/schemas/Traveler'
description: |
A list of objects containing information about the travelers of this booking. The number of elements does not necessarily match the total indicated by the bookingItems parameter.
As a default, only the lead traveler is sent, unless set up differently on the Supplier Admin. In which case, the details of all other passengers are part of the Comment field.
travelerHotel:
type: string
description: The traveler’s hotel. This is provided to facilitate pickup where applicable.
comment:
type: string
description: |
Additional information provided by the traveler, e.g., [pick up](https://supplier-support.getyourguide.com/en/support/solutions/articles/15000030542-setting-meeting-point-and-pickup), dietary restrictions, weight, passport, etc. Please note this parameter could contain several thousand characters of unstructured data (free text).