API Documentation

Supplier (Cruise Line) API Documentation

Sending your Availability and Rate Data to GalapagosGDS 

This document describes the process of using the GalapagosGDS Supplier API to send Availability and Rate data from your internal availability and rate system to the GalapagosGDS server. 

VoyagePort provides a REST API to send updates to GalapagosGDS about availability and rates automatically. 

Step 1) You will initially need to post the availability data of all of your departures of all of your cabins of all of your vessels and the corresponding price data to the GalapagosGDS server. 

Step 2) After Galapagos GDS has received all of your availability and price data, you will need to create a trigger that sends every change in availability and price in your reservation system to update your changes in the GalapgosGDS server in real-time or as close to real-time as possible.

Update availability / price Sample Request and Response: 

RQ 

{ 

“Username”: “[email protected]”, 

“Password”: “asdxrted”, “boat”: ocean_spray, “Cabin_type”:deluxe_cabin_twin, 

“Departures”: [ 

{ 

“departure_date”: “2019-09-02”, “arrival_date”: “2019-09-06”, “days”:5 “available”: 11, “hold”: 2 “adult_price”: 2000 “children_price”: 1500 “promotion_name”: “Last minute $100 off” “promotion_type”: “last_minute” “promotion_description”: “Save $100 in your purchase” “promotion_policies”: “Must purchase by November 28” 

}, { 

“departure_date”: “2019-09-16”, “arrival_date”: “2019-09-21”, “days”:6 “available”: 7, “hold”: 3 “adult_price”: 2010 “children_price”: 1510 “promotion_name”: “10% Off” “promotion_type”: “promotion” “promotion_description”: “Save 10% if you purchase by 

November 28″ “promotion_policies”: “Must purchase by November 28” } ] } { 

“success”: “Successfully Updated” } 

Connect To Production 

When Boat Search partners are ready to start sending UA request messages to Boat Search API to update their availability they should contact their Connectivity Account Manager or reach us to obtain the right to use Availabiilty/Price API. Boat Search will then provide the necessary information for connecting to our live environment. 

update availability Request (UA RQ) 

UA RQ Schema Complete Definition

Legend: O = Optional R=Required

Level	Legend	Element/ @Atribute	Type	Description
0	R	user	string	User name on Gds System
0	R	password	string	Password in GDS
0	O	boat	string	Boat name or code (Must be  mapped in boat_api table)
0	O	departures array	array	Array of departures Boat and Cabin Foreach
1	R	departure_date	date	Start Date of the tour
1	O*	arrival_date	date	Finish Date of the tour. EITHER arrival_date OR days are required
1	O*	days	number	Total number of the days of the tour including the first and last days. (ie “departure_date”: “2019-09-16”,  “arrival_date”: “2019-09-21” = 6 days, not 5,EITHER arrival_date OR days are required
1	R	available	number	Number of spaces available of this cabin type
1	R	hold	number	Number of spaces on hold  (Send 0 ifn case of don’t exists)
1	O	adult_price	float	Price of Adults in this departure
1	O	children_price	float	Price of children in this  departure
1	O	promotion_name	string	Name of Promotion
1	O	promotion_type	string	Type of promotion (Options promotion, last_minute, other)
1	O	promotion_description	string	Details of the promotion
1	O	promotions_policies	string	Policies of The Promotion

Sample Messages 

This section contains sample messages illustrating how to interact with the update availability API. 

UA Response: Errors The following is a sample error response message: in this case there are mistakes in the request of UA request. 

{ 

“error”: { 

“code”: 401, “description”: “Unauthorized Access: Invalid API Key” } } { 

“error”: { 

“code”: 415, “description”: “Unsupported data for {field}” } } { 

“error”: { 

“code”: 500, “description”: “Internal server error” } } { 

“error”: { 

“code”: 404, “description”: “{field} not found” } 

} {field} will be the json key of the request sent to Availability API.