GetYourGuide IntegrationSetup Guide

How to Get Approved by GetYourGuide

Step-by-step setup for the GetYourGuide Integration add-on, from creating your Integrator Portal account to passing live testing.

Introduction

GetYourGuide approves your connection, not each trip. You set it up once: create an Integrator Portal account, point GetYourGuide at your site, pass their tests, then link your real trips. Plan on a couple of hours for setup and about a week for GetYourGuide's review.

This guide covers the approval process. For what each plugin setting does, see the GetYourGuide Integration settings guide.

Note: The practice trips you create along the way exist only to get you approved. Delete them afterward. Once you are approved, adding a new trip takes two steps: create it on GetYourGuide, then link it in Trip Mapping.

Before You Begin

  1. You have a staging or test copy of your website. GetYourGuide makes real test bookings during setup, and you do not want those among your genuine ones.
  2. You have at least one product published on GetYourGuide.
  3. You have installed and activated the GetYourGuide Integration add-on and the Fixed Starting Dates add-on.
  4. You have installed and activated the Group Discount add-on if you sell tickets priced per group instead of per person.

When something does not work at any point, open WP Travel Engine > Settings > Extensions > Get Your Guide >

Logs:It records every exchange between your site and GetYourGuide.

Creating Your GetYourGuideAccount

Setup happens in the Integrator Portal, which is separate from the supplier portal where you manage your listings.

  1. Go to https://integrator.getyourguide.com/signup
  2. Fill in the form.
  3. Tick the terms, clear the reCAPTCHA, and click Sign up.
  4. Confirm your email address.
4a3c476a d955 4818 a9f2 5d039faf48a9
4a3c476a d955 4818 a9f2 5d039faf48a9
FieldWhat to enter
Your Full NameThe person who will own this connection
Your Job TitleFor example, Plugin developer
Company NameYour registered business name
Integration NameThe name other suppliers see when they search for your system. Choose something recognizable.
EmailYour login. You can add more people later.
PasswordAt least 8 characters, with an uppercase letter, a lowercase letter, a number, and one of !@#$%^&*

Sign up with a company email, not a personal one. This login controls your live bookings, so it should outlast any one team member.

Turning On Two-Factor Authentication

GetYourGuide requires this and prompts you at your first sign-in.

  1. Scan the code with an authenticator app such as Google Authenticator, Authy, or 1Password.
  2. Enter the six-digit code to confirm.
  3. Save the recovery codes somewhere safe.

Without the recovery codes, losing your phone means losing access to the account.

Setting Up the Testing Configuration

Understanding the Setup Checklist

After you sign in, you land on the setup checklist at https://integrator.getyourguide.com/setup#/test_configuration. The list on the left is your whole journey. It unlocks in order, so only the first item is open at the start.

StepOpens when
Set up your testing configurationAvailable now
Test your integrationYou have submitted the testing configuration
Set up your production configurationTesting has passed
Test your integration on productionYou have submitted the production configuration
Test GetYourGuide endpointsCovered in Skipping the Optional Steps below
Test additional featuresCovered in Skipping the Optional Steps below
Live testingEverything above has passed

You cannot skip ahead. You will switch between this page and your WordPress settings at almost every step.

Using Your Staging Site

Do this on a staging or test site, never your live one. GetYourGuide runs a full booking cycle against whatever site you give them: they reserve seats, confirm a booking, then cancel it. On a live site, those become real bookings among your genuine ones, with seat numbers moving on trips you sell.

Point GetYourGuide at a copy of your site, finish testing there, and set up your live site later as its own step.

Giving GetYourGuide Your Site's Login

The Username and Password at the top of the page are the login GetYourGuide uses to reach your site. The add-on has already created them.

  1. In WordPress, go to WP Travel Engine > Settings > Extensions > Get Your Guide and copy Inbound Key and Inbound Secret.
  2. In the portal, paste them into the testing credentials.
In WordPressIn the portal
Inbound KeyUsername
Inbound SecretPassword

For more detail, see the Inbound Key and Inbound Secret section of the settings guide.

Telling GetYourGuide Where Your Site Is

FieldWhat to enter
HostYour staging web address without https://, for example staging.example.com
Port443
PathThe Endpoint Path shown in your plugin settings: /wp-json/wptravelengine-gyg/1/

Your staging site has to be reachable online. An address that works only on your own computer will not do. Use a real staging domain or a tunnelling service such as ngrok.

Choosing Your System Type

This decides which kinds of products GetYourGuide expects you to handle. Read both options before you choose.

Option A: Reservation System

Choose this if you are a system that serves multiple tour & activity operators, or the attraction ticketing equivalent, and you commit to all four product types. The tick boxes fill in on their own and cannot be changed.

Product typeWhat it means
Time point for IndividualsSet departure times, one ticket per person
Time point for GroupsSet departure times, one ticket for a whole group
Time period for IndividualsOpening hours, one ticket per person
Time period for GroupsOpening hours, one ticket for a whole group

Both group types need the Group Discount add-on. Choose this option only if you have it and your trips use group pricing.

Option B: Custom System for a Single Supplier

Choose this option if you are a custom system built for a single supplier, and you tick only what you sell. If you do not have Group Discount, or you do not sell group tickets, leave both Groups boxes empty:

This is the right choice for a single website that sells per-person trips.

A red notice appears here. You need at least one product live on GetYourGuide before you can finish, so publish one on their side first.

Submitting the Configuration

With the login copied, the address filled in, and a system type chosen, click Submit. Test your integration now unlocks in the list on the left.

Collecting GetYourGuide's Login

After you submit, a GetYourGuide Credentials section appears at the bottom of the page. This is the login in the other direction: GetYourGuide issues it, and your site uses it to send them availability updates.

  1. Click Show to reveal the password.
  2. Copy the username and password.
  3. In WordPress, go to WP Travel Engine → Settings → Extensions → Get Your Guide and paste them into GYG Username and GYG Password.
  4. Click Save Settings.
In the portalIn WordPress
UsernameGYG Username
PasswordGYG Password

Copy the password before you leave the page. GetYourGuide hides it afterward and does not show it again.

Both directions are now connected. GetYourGuide can reach your site, and your site can reach GetYourGuide.

Running the Self-Test

Test your integration is now unlocked in the sidebar. Open it to reach the Self-testing tool, where GetYourGuide books against your site and checks every reply.

The Test run status table lists the product types you chose earlier, and every row must reach Completed before you move on.

  • If you chose Reservation System, all four rows must pass.
  • If you chose custom system for a single supplier, only the rows you ticked must pass.

Each row is its own test, so you fill in the form below more than once.

Creating Practice Trips

GetYourGuide asks for a product number, and your site has to recognize it. That means a WP Travel Engine trip linked to the number you type into the portal. Use a separate trip for each product type. A real GetYourGuide product is only one thing, and a failed test is easy to repeat on its own trip.

  1. In WP Travel Engine > Trips, add one trip per product type and give each a name that shows its type.
    Product typeSuggested trip nameSuggested product number
    Time point for IndividualsGYG TEST - Point / Individualprod-point-ind
    Time period for IndividualsGYG TEST - Period / Individualprod-period-ind
    Time period for GroupsGYG TEST - Period / Groupprod-period-grp
    Time point for GroupsGYG TEST - Point / Groupprod-point-grp
    If you skip the group types, create the first two trips only.
  2. Give each trip its own product number. Type the matching one into the portal's Valid product ID box before each test.

Link every trip. Go to WP Travel Engine > Settings > Extensions > Get Your Guide > Trip Mapping, add a row for each trip, choose the trip under Trip, type the same number under GYG Product ID, and click Save Settings.

The two must match exactly, letter for letter. This is how GetYourGuide's
request finds your package. A typo means the test fails with an unknown product.

The simplest product number is the package's own ID. Click the copy
icon under Action and paste it into GYG Product ID and into the portal.
The screenshots use 218923; substitute your own.

What actually gets sent. Only seat availability and prices. Trip descriptions, photos, and itineraries stay on GetYourGuide and are never overwritten. You can switch off per package. See Linking Your Trip Packages for more details

Settings That Stay the Same

Three fields lower in the form get the same answer every time.

  • A ticket type you sell: Choose one besides ADULT. CHILD is the usual pick. GetYourGuide checks that your site returns a price for it.
  • A ticket type you do not sell: Choose MILITARY. GetYourGuide checks that your site turns it down.
  • Product timezone: Select the same timezone as your website. Find yours under Settings > General > Timezone in WordPress. The screenshot shows Asia/Kathmandu, and yours will differ.

Note: A wrong timezone shifts every departure time, and the tests fail.

GetYourGuide never converts prices, so your site's currency must match your GetYourGuide listing.

Matching Dates on Both Sides

The portal asks for two sets of dates. Whatever you enter there must also exist on your trips, or the tests find nothing to book.

Portal fieldWhat to enter
Dates your product is availableAbout five days starting next week. You choose the length, but it needs at least two bookable times.
Dates your product is NOT availableA short range further ahead to block off, for example 2027-01-01 to 2027-01-02

Add the available dates to each practice trip:

  1. Open the trip and go to Date & Price > Packages.
  2. Create a package and set your prices.
  3. Under Dates, add the same range you gave the portal.

Repeat for every practice trip. The same range works for all of them.

Then add the blocked dates:

  1. Still under Date & Price, open Date Settings.
  2. Scroll to Excluded Dates.
  3. Add the dates you blocked in the portal, again on every practice trip.

GetYourGuide checks both sides: the available dates must be bookable, and the blocked ones must not be. A date in the portal with no package behind it fails.

Your trips are ready. Work through each product type in turn.

Product Type 1: Time Point for Individuals

Set departure times, one ticket per person.

In the portal, answer the form like this:

QuestionAnswer
Time availableAt fixed starting times (Time point)
Price set upPrice per individual
What do you want to configure automatically?Availability only
What do you want to configure the availability type as?Availability By Ticket Category

On your site

On the practice trip, go to Date & Price > Packages. Under GetYourGuide Product Mapping, click the gear icon on the Point / Individual package's row.

FieldValue
Availability TypeTime Point
Vacancy ReportingPer category

Check that the GYG Product ID on the row is this type's product number. If it looks wrong, go back to 5.1.

The notice on this tab confirms which product number the trip is linked to. If it looks wrong, go back to Creating Practice Trips.

To run the test, click Test your integration.

A pass reads Success with nothing failed, and shows each stage on its own:

  • Get-Availabilities: your site listed the right open dates.
  • Reserve Flow: seats were held.
  • Booking Flow: the hold became a booking.

The Time point for Individuals row now reads Completed.

Note: If the test fails, the usual causes are a product number that does not match Trip Mapping, a timezone that differs from your website's, or portal dates with no package behind them. Open the failed stage to see what went wrong, fix it, then run the test again.

Product Type 2: Time Period for Individuals

Opening hours, one ticket per person.

In the portal, the form is the same as before with one answer changed:

QuestionAnswer
Time availableDuring operation hours (Time period) (changed)
Price set upPrice per individual
What do you want to configure automatically?Availability only
What do you want to configure the availability type as?Availability By Ticket Category

In the trip, open Period / Individual, go to Advanced Settings → Get Your Guide and set Availability Type to Time Period. Two time boxes appear.

FieldValue
Availability TypeTime Period (changed)
Opens09:00
Closes17:00
Vacancy ReportingPer category

Tip: Any sensible opening hours work for testing. For real trips, use the hours on your GetYourGuide product.

To run the test, click Test your integration. On success, Time period for Individuals reads Completed.

Note: If the test fails, check the setting you just changed. Time Period on the trip must go with During operation hours in the portal.

Group Ticket Types

Product types 3 and 4 cover group products, where one ticket covers a whole party.

Note: Skip both if you do not sell group departures. If you chose custom system build for a single supplier and left the Groups boxes empty, go straight to Moving to Your Live Site. These two types apply only if you chose Reservation System or Attraction Ticketing System, which cover all four types.

Group prices come from the Group Discount add-on. Install and activate it before you start, or there is no group price to send.

Product Type 3: Time Period for Groups

Opening hours, one ticket for a whole group. This needs the Group Discount add-on.

In the portal, change the price answer:

QuestionAnswer
Time availableDuring operation hours (Time period)
Price set upPrice per group (changed)
What do you want to configure automatically?Availability only
What do you want to configure the availability type as?Availability By Ticket Category

In the trip, open Period / Group, go to Advanced Settings → Get Your Guide, set Availability Type to Time Period and Vacancy Reporting to Per category, as in the previous type.

Then set the price. On the same trip, go to Date & Price → Packages → Price Categories, open a category and set Pricing Type to Per Group.

FieldValue
Regular PriceYour group price, 50 in the example. Use whatever your GetYourGuide product charges for a group.
Pricing TypePer Group, instead of Per Person

To run the test, click Test your integration. On success, Time period for Groups reads Completed.

Note: If the test fails, check that the Group Discount add-on is active and that the price saved. The category heading should read $50 / Group.

Product Type 4: Time Point for Groups

Set departure times, one ticket for a whole group. This needs the Group Discount add-on.

In the portal, change the time answer back:

QuestionAnswer
Time availableAt fixed starting times (Time point) (changed)
Price set upPrice per group
What do you want to configure automatically?Availability only
Participants configuration (optional)Leave Max empty, or set a limit if your groups have one

In the trip, open Point / Group and go to Advanced Settings → Get Your Guide:

FieldValue
Availability TypeTime Point
Vacancy ReportingPer category

Then set the price to Per Group as in the previous type, under Date & Price → Packages → Price Categories → Pricing Type.

To run the test, click Test your integration. On success, Time point for Groups reads Completed, and with it every row in the table.

Note: If the test fails, check that Time Point on the trip goes with At fixed starting times in the portal, and that you used the right trip's product number.

Confirming All Tests Passed

Reload the page. Every row now has a green tick, and Set up your production configuration is unlocked.

Everything so far ran against your staging site. Next, you repeat the setup for your live one.

Moving to Your Live Site

Setting Up the Production Configuration

Open Set up your production configuration. It is the testing configuration again, pointed at your live site. The fields are the same and only the address changes.

FieldWhat to enter
UsernameThe Inbound Key from your live site's plugin settings
PasswordThe Inbound Secret from your live site
HostYour live web address, for example example.com
Port443
PathThe Endpoint Path from your live site: /wp-json/wptravelengine-gyg/1/
Recipient email addressWhere GetYourGuide sends notifications
Recipient TypeTechnical for a developer, Business for an account owner. Click Add a notification recipient to add more.

Each WordPress site creates its own login, so your live site's key and secret are not the staging ones. Copy them from the live site's own settings page.

Note: Keep the /1/ at the end of the Path. Without it, GetYourGuide's requests arrive nowhere.

Click Submit.

Next, turn off Sandbox Mode in your live site's plugin settings. Until you do, your updates keep going to GetYourGuide's test environment and your live listing never changes. See the Sandbox Mode section of the settings guide.

Tip: Reload the portal page after you submit. The next step often still looks locked until you do. The page is out of date, and your submission went through.

This is setup, not going live. That comes later.

Testing Your Live Site

This repeats the self-test against your live site, with the same table, product types and form. Work through whichever types apply, with portal settings on one side, trip settings on the other and Test your integration after each. Go back to Running the Self-Test if you need the detail.

Two things differ:

  • Your practice trips must exist on the live site this time. Create the same set, give each its product number, link them in Trip Mapping, and set up the timezone and dates there too.
  • An extra Integration feature status table appears. Those features are optional and not needed to pass this step.

When every row reads Completed, reload the page.

Skipping the Optional Steps

Test GetYourGuide endpoints and Test additional features do not apply to you. The WP Travel Engine team already completed them when the add-on was built.

The features listed are optional extras that improve your standing in GetYourGuide's partner program. You do not need them to start selling. Go straight to Live testing.

Live Testing and Going Live

Everything so far used practice trips. Live testing uses actual products on GetYourGuide, each linked to a real trip on your site.

GetYourGuide connects a product, makes a test booking and issues a ticket, moves it to another date, cancels it, and checks that your site sends availability updates.

What You Need

You need one live GetYourGuide product option for each type you sell, each linked to a matching trip. The form has a row for each type:

  • Time Period Individual
  • Time Point Individual
  • Time Period Group
  • Time Point Group

Tip: If you do not sell group departures, fill in the two Individual rows and leave the Group rows empty.

Matching GetYourGuide's Wording

GetYourGuide's supplier portal does not say "time point" and "time period". This causes more mistakes than anything else in the setup.

On your siteOn GetYourGuideWhat the customer sees
Time PointTime slotsThey pick a specific departure time
Time PeriodOpening hoursThey can start any time within a window

Prices use different words too:

On your siteOn GetYourGuide
Pricing Type Per PersonPrice per person
Pricing Type Per GroupPrice per group/vehicle

Creating the Products on GetYourGuide

In the supplier portal, open your activity and create one option for each type you sell. An option is GetYourGuide's version of a WP Travel Engine package.

Work through the wizard to Availability & Pricing and answer the two questions to match the type the option represents.

OptionHow do you set your availability?How do you set your prices?
Time Point IndividualTime slotsPrice per person
Time Period IndividualOpening hoursPrice per person
Time Point GroupTime slotsPrice per group/vehicle
Time Period GroupOpening hoursPrice per group/vehicle

The screenshot shows Time Period Group, which is opening hours with a group price. Repeat the wizard for the other types and change only those two answers.

Note: Write down each option's Option ID and Title. You need both in a later step.

Linking Each Product to Its Trip

  1. In WP Travel Engine → Settings → Extensions → Get Your Guide → Trip Mapping, add a row for each product.
  2. Use the real product number from GetYourGuide this time, not a practice one.
  3. Click Save Settings.

Each trip must be set up to match the product it is linked to:

TripGetYourGuide optionAvailability TypePricing Type
Time Point (Individual)Time slots, per personTime PointPer Person
Opening Hours (Individual)Opening hours, per personTime PeriodPer Person
Time Point (Group)Time slots, per groupTime PointPer Group
Opening Hours (Group)Opening hours, per groupTime PeriodPer Group

Note: A trip and its GetYourGuide product must describe the same thing. A trip set to Time Period and linked to an option that uses Time slots fails live testing. Once live, it would also sell the wrong departures.

Submitting Your Product Details

With the products created and the trips linked, go to https://integrator.getyourguide.com/setup#/live_testing. Fill in one row per type and click Submit.

FieldWhere to find it
Product IDThe GetYourGuide product number, the same one you used in Trip Mapping
Option IDThe option in the supplier portal
Option TitleThe option's title, as written in the supplier portal

Leave the Group rows empty if you do not sell group departures.

Waiting for GetYourGuide

From here, GetYourGuide takes over. Their team runs the live tests and reports back.

  • They reply to the email address you signed up with.
  • If everything is set up right, expect to hear within about a week. Mistakes mean another round and a longer wait.
  • If you hear nothing, email supplier-api@getyourguide.com.

Once GetYourGuide confirms the tests passed, your connection is approved and appears in their supplier portal as a reservation system.

Adding Trips After Approval

You were approved as a system, not as a product, so you never repeat this guide. Each new trip needs three fields in the option wizard, under Connectivity Settings:

  1. Set Do you use an online reservation system? to Yes, I use a reservation system.
  2. Select your reservation system under Select your Reservation System.
  3. Enter the trip's product number from Trip Mapping under External product ID.

Add each real trip the same way you added the practice ones: create the option with the matching availability and price type, then link the trip in WP Travel Engine. Availability, prices and bookings then stay in step on their own.

You can delete the practice trips whenever you like.

If you're still stuck or have a question we didn't cover, our support team is happy to help. Reach out at our support page and we'll get you sorted.