Notes for partners integration APIs partially

For partners integrating our apis partially and sending traffic to our web app. Here are some important things to note.

1. Landing page

You can send users directly to our product page with headout.com/tour/<productId> as the link. If user selected variantId, date and time on your platform, you can send user to checkout page in Headout directly using headout.com/book/<productId>/checkout?date=<YYYY-MM-DD>&time=<HH:MM:SS>&variantId=<variantId>. If user selected only partially (any of date, time, variantId), you can optionally send user to our booking page using headout.com/book/<productId>/variant?date=<YYYY-MM-DD>&time=<HH:MM:SS>&variantId=<variantId> (Note: remove the params that user didnt select. Ex: if user only selected date and time but not variant on your site, the above url will be headout.com/book/<productId>/variant?date=<YYYY-MM-DD>&time=<HH:MM:SS>

2. Tracking

We don't have complete tracking suite for Partial integration as of yet. Tracking needs to be setup using utm parameters as explained below.

• Use a unique affiliate name. (Ask your BD POC for one)
• These utm params are to be appended to the landing page urls

So if your affiliate unique id is affiliate_name and you want to send user to headout.com/tour/512, the final url you need to use will be: headout.com/tour/512?utm_source={affiliate_name}&utm_medium=affiliate&utm_campaign={preferred_campaign_name}

"utm_medium=affiliate" is mandatory here.

utm_source={you_affiliate_name} is mandatory and you must convey the affiliate name to your BD POC for us to start tracking the bookings.

utm_campaign is optional. You can ignore this or send a dummy value.

3. Invoice

The bookings data (bookings done by customers who came from partners portal) will be conveyed by your BD POC on a monthly basis (or per contract). We don't have a realtime method to track this.

A better suit is a WIP. We will get back on this later.