Partner API

The Partner API (page title Partner Availability API) is for agency partners whose own website or system should show your departures live, instead of importing a file. It answers with your published departures, the cabins still available and their prices. It is read-only: nothing a partner does through it can create or change a booking.

It belongs to the Partner Feeds & Integrations module, on by default (see Optional modules). It is also the Partner API tab of Feeds & Integrations.

Open the API to a partner

1. Click Enable API. If there is no token yet, one is generated for you.

2. Copy the Access token.

3. Send your partner the token and the instructions under How to use it — send this to your partner: the address to call, how to pass the token, the optional filters and an example of the answer.

The page also explains to your partner how to read the prices: the price per person in a shared cabin, the price for one guest alone in the cabin, and the lowest price on the departure.

Change or withdraw access

• Regenerate creates a new token. The old one stops working at once, so send the new one to every partner who uses it.
• Revoke deletes the token: every call is refused until you generate a new one.
• Disable API closes the API for everyone. The token is kept for when you enable it again.

Good to know

• There is one token for all partners. Anyone holding it can read your availability and prices: treat it like a password.
• Only published departures are returned, and only cabins that can really be booked at the price shown.
• Mandatory fees paid on board (for example marine park fees) are not included in the prices.
• Partners cannot book through the API: they send their customers to the booking link of each departure, or use the agency portal (see Agency Hub).
• There are no notifications to partners: they ask the API again when they need fresh data, at most 60 times a minute.