Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 70 additions & 66 deletions docs/guides/plugins/getyourguide.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,99 @@
# GetYourGuide

!!! Note
The GetYourGuide integration is currently in beta.
Please contact <[email protected]> to enable the integration for your pretix.eu organizer account.
You can use third-party aggregators such as GetYourGuide to sell tickets not only through your own ticket shop, but also through the aggregator's website.
Using GetYourGuide entails costs, but it allows you to reach a larger audience that would otherwise not have found their way to your shop.
pretix offers an integration of GetYourGuide that allows you to profit from an additional sales and revenue channel, while keeping the effort for setting up and maintaining multiple ticket shops at a minimum.
This article is going to tell you how to do that.

## Introduction
## Prerequisites

Using third party aggregators, such als GetYourGuide, event organizers can sell tickets to their events not only on their own ticket shop but also on the aggregator's portal.
While this service is not for free, it allows event organizers to reach a larger audience that would otherwise not have found their way into the organizer's webshop.
If you want to use the GetYourGuide integration for pretix, then you need to have access to an active GetYourGuide supplier account.
The GetYourGuide integration is handled on the event level, so you have to create an event first.

Using pretix' integration with GetYourGuide, event organizers can profit from an additional sales and revenue channel, while keeping the effort for setting up and maintaining multiple ticket shops to a minimum.
## How to

## Preparing your organizer account
Setting up the GetYourGuide integration involves the following steps:

The first step in enabling the GetYourGuide integration is to setup a corresponding Sales Channel, which will be used to properly attribute the sales generated.
This needs to be done only once per organizer account.
1. Ask pretix support to [unlock the GetYourGuide plugin](getyourguide.md#setting-up-your-organizer-account-for-getyourguide) on your account.
2. Create a [sales channel]((getyourguide.md#setting-up-your-organizer-account-for-getyourguide))
3. Enable the [plugin](getyourguide.md#setting-up-your-event-for-getyourguide)
4. Configure [products](getyourguide.md#setting-up-products-for-getyourguide)
5. [Connect](getyourguide.md#connecting-to-getyourguide) to GetYourGuide

In order to do so, navigate to :navpath:Your Organizer → :fa3-wrench: Settings → Sales channels: and click the :btn-icon:fa3-plus:Add a new channel: button.
This article will guide you through those steps in detail.

On the following page, you will be able to select "GetYourGuide" as the sales channel type and give it a custom name.
### Setting up your organizer account for GetYourGuide

## Preparing your event
The pretix integration with GetYourGuide is currently in beta.
The pretix team has to activate it once for your organizer account before you can use it.
Contact support via [email](mailto:[email protected]) or [phone](tel:+4962213217750) and ask them to activate the GetYourGuide plugin.

In order to now sell your events on GetYourGuide, you will need to configure each event in question.
Before you can use GetYourGuide for any of your events, you need to create a corresponding sales channel on your organizer account.
pretix will use the sales channel to properly attribute sales via GetYourGuide.
Navigate to :navpath:Your organizer → :fa3-wrench: Settings → Sales channels:.
Click the :btn-icon:fa3-plus: Add a new channel: button.
On the page titled "Add sales channel", select :btn:GetYourGuide:.
Click the :btn:Save: button.

1. Enabling the plugin
Repeat these steps for every additional organizer account that you want to integrate with GetYourGuide.

Navigate to :navpath:Your Event → :fa3-wrench: Settings → Plugins: and switch to the :btn:Integrations: tab.
Click the :btn:Enable: button next to the "GetYourGuide" plugin.
### Setting up your event for GetYourGuide

2. Sell the event on the sales channel
In order to enable the GetYourGuide plugin, navigate to :navpath:Your event → :fa3-wrench: Settings → Plugins: and open the :btn:Integrations: tab.
Seek out the plugin labeled "GetYourGuide" in the list and click the :btn:Enable: button next to it.
Now that you have enabled the GetYourGuide plugin, the pretix integration with GetYourGuide and all settings associated with it are available.

Navigate to :navpath:Your Event → :fa3-wrench: Settings → General:
Check either the box next to "Sell on all sales channels" or at least one of the boxes next to "Restrict to specific sales channels".
In order to sell tickets for your event via the GetYourGuide sales channel, navigate to :navpath:Your Event → :fa3-wrench: Settings → General:.
Under "Sales channels", check the box next to "GetYourGuide" or the box next to "Sell on all sales channels".

3. Configure one or more products to be sold on GetYourGuide
In order to set up your offer for the GetYourGuide website, navigate to :navpath:Your Event → :fa3-wrench: Settings → GetYourGuide: and open the :btn:Configuration: tab.
Supply the required information and select the "Event time mode" as well as the "Booking mode".

Either create a new or edit an existing product that you would like to sell on GetYourGuide.
To do so, navigate to :navpath:Your Event → :fa3-ticket: Products: and select the product in question.
Switch to the :btn:Availability: tab and either check the box next to "Sell on all sales channels" or at least one of the boxes next to "Restrict to specific sales channels".
Then, switch to the :btn:Additional settings: tab and set the GetYourGuide equivalent ticket category.
Within your event, there can be only one product per ticket category.
Depending on your further configuration, you must at least select one product to be in the "Adult" or "Group" category.
For each of your events, you can only offer either individual tickets or group tickets through GetYourGuide.
For more information on individual vs. group tickets, see the [next section](getyourguide.md#setting-up-products-for-getyourguide).
Once you are happy with your choices, click the :btn:Save: button.

4. Configuring the GetYourGuide plugin
Repeat these steps for every additional event for which you want to make sales via GetYourGuide.

Once you have configured one or more products to be eligible to be sold on GetYourGuide, you'll need to configure a few basic settings within the event.
Navigate to :navpath:Your Event → :fa3-wrench: Settings → GetYourGuide: and open the :btn:Configuration: tab.
The most important settings, such as the location of the event on sale, can be found here.
### Setting up products for GetYourGuide

## Ticket Categories
Configure at least one product to be sold via GetYourGuide.
In order to do so, navigate to :navpath:Your Event → :fa3-ticket: Products: and create or edit a product.
Switch to the :btn:Availability: tab and under "Sales channels", check the box next to "GetYourGuide" or the box next to "Sell on all sales channels".

While pretix only uses the ticket category term loosely to group together multiple products for nicer display, GetYourGuide is relying on the ticket categories to price the tickets.
Then, switch to the :btn:GetYourGuide: tab and set the GetYourGuide equivalent ticket category.
This "Ticket Category" setting is only relevant for the sale through GetYourGuide.
It is completely separate from the "Categories" settings within pretix.

First of all, you need to make the decision on how you are planning on selling your tickets on GetYourGuide - in most cases, this will reflect your current sales strategy within your pretix shop.
There can only be one product per GetYourGuide ticket category for each one of your events.
For each one of your pretix events, you can only either sell individual tickets or group tickets via GetYourGuide—not both.

- Individual tickets
Every single person attending will need to purchase their own ticket.
A family of two adults and two children will have to purchase and pay for a total of 4 tickets.
In this case, you will need to offer *at least* a ticket of the "Adult" type, but may offer any other ticket category type (Child, Youth, Senior, ...) in addition.
But you cannot offer a "Group" ticket.
If you selected the booking mode or **"Group tickets"**, then you need to select the "Ticket Category" "Group".
You can only offer one product through GetYourGuide for this event.
You can use the fields "Minimal group size" and "Maximal group size" to place restrictions on the number of people for whom each ticket is valid.

- Group tickets
If you selected the booking mode **"Individual tickets"**, then you need to add one product to the "Adult" category.
You can also add other products to the other GetYourGuide categories ("Child", "Youth", "Senior", etc.), but **not** to the "Group" category.
Each GetYourGuide category may only contain a single product.

Two groups, consisting of 10 and 20 participants respectively, won't need to purchase a total of 30 tickets, but rather two group tickets.
It is up to you to configure the group size limits within the GetYourGuide-settings of your product.
Choosing this option, you cannot offer any other ticket categories besides "Group".
The pretix integration with GetYourGuide overwrites the price settings within GetYourGuide.
The prices you define for categories on the GetYourGuide website will **not** apply.
In order to set the price for a product you want to sell via GetYourGuide, edit the product and open the :btn:Price: tab.
Enter the intended price under "Default price".

## Setting up event dates and quotas
Just like with any other product, you also have to add the tickets you intend to sell via GetYourGuide to a quota in pretix before they become available in your shop.
If you want to learn more on how to handle categories in pretix, refer to the section on [categories](../products.md#creating-and-editing-categories).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note
When selling individual tickets through GetYourGuide, you will not be able to offer differing quantities for individual ticket categories.
GetYourGuide will always default to the smallest relevant quota, except if that quota is exhausted and another one is available.

Notiz hier, weil ich an gelöschte Zeilen nicht kommentieren kann: Diese Information war mal wichtig genug für eine Note; in der aktuellen Version hingegen finde ich sie gar nicht mehr wieder.
Wie kommt das?


Of course, in addition to creating products, you will also need to add them to a quota for them to be available for sale.
The process for doing this is the very same as for any regular event or event series.
If you want to learn more on how to handle taxes in pretix, refer to our guide on [products](../products.md).
### Connecting to GetYourGuide

!!! Note
When selling individual tickets through GetYourGuide, you will not be able to offer differing quantities for individual ticket categories.
GetYourGuide will always default to the smallest relevant quota, except if that quota is exhausted and another one is available.
The GetYourGuide backend refers to your pretix event as a "product".
Open the GetYourGuide [Supplier Portal](https://suppliers.getyourguide.com/) and connect it with your pretix shop.
In order to do so, follow the instructions for [Connecting a new product to your Reservation System](https://supply.getyourguide.support/hc/en-us/articles/18008029689373-Connecting-a-new-product-to-your-Reservation-system) in the GetYourGuide Supply Partner Help Center.
Select "pretix.eu" as your "reservation system".
You can find the required "product ID" by navigating to :navpath:Your Event → :fa3-wrench: Settings → GetYourGuide: and opening the :btn:Configuration: tab.
It is displayed in the infobox at the bottom of the page as soon as you have entered and saved all mandatory information.

For this reason, we recommend placing all GetYourGuide-eligible products into the same quota.
Should you however opt to create multiple quotas which create an imbalance, pretix will report only the available number of tickets for the lowest relevant quota.

## Connecting your event to GetYourGuide

Once you have set up your event and products and performed all necessary configuration, you may want to use the Analyzer feature of the GetYourGuide plugin.
If you want to do so, navigate to :navpath:Your Event → :fa3-wrench: Settings → GetYourGuide: and open the :btn:Analyzer: tab.

The Analyzer should not display any blocking error messages and at least one event date that is ready for publishing on the GetYourGuide platform.

At this point, you will need to setup your event (called "product" in the GetYourGuide universe) on their [Supplier Portal](https://suppliers.getyourguide.com/) and connect it with your pretix shop.
To do so, please follow the instructions for [Connecting a new product to your Reservation System](https://supply.getyourguide.support/hc/en-us/articles/18008029689373-Connecting-a-new-product-to-your-Reservation-system) on the GetYourGuide Supply Partner Help Center.

Select "pretix.eu" as your reservation system; the required "product ID" can be found in the "Configuration" tab of the GetYourGuide plugin settings page.

From this point on, GetYourGuide will automatically import the availabilities and products and offer them for sale.
From this point on, GetYourGuide will automatically import products along with their availability status and offer them for sale.
Once your shop is live and connected to GetYourGuide, you can use the analyzer feature.
Navigate to :navpath:Your Event → :fa3-wrench: Settings → GetYourGuide: and open the :btn:Analyzer: tab.
This page displays the availability information that pretix has communicated to GetYourGuide for each product.