Articles in this section

Cruises API Version 2: Fields Explained

Avatar
Celine Ladoire
  • Updated
Follow

 This articles explains the fields in the Cruises API Version 2 for the following requests:

cruises/get_all and cruises/get requests

Field Information Note
fly_cruise_price Price of the lowest available cabin grade + flight price  
cruise_only_price Price of the lowest cabin grade (flights not included)  
inside_price Price of the lowest inside cabin grade (flights not included)  
outside_price Price of the lowest outside cabin grade (flights not included)  
balcony_price Price of the lowest balcony grade (flights not included)  
suite_price Price of the lowest suite cabin grade (flights not included)  
vendor_id Official ID from the cruise line Only available for integrated cruise lines
cruise_nights Length of the cruise in nights  
cruise_theme Theme of the cruise Only available for some integrated cruise lines
cruise_type Whether the cruise is Ocean, or River  
description Official description for the cruise Only available for some integrated cruise lines
ends_at Last port in the itinerary, where the cruise ends  
ends_on Date of the last port visit in the itinerary, when the cruise ends  
hotel_nights Total amount of nights spent in a hotel before the cruise starts  
name Name of the cruise  
post_cruise Total amount of nights spent in a hotel after the cruise ends  
rating Rating of the cruise line  
region Region(s) where the cruise is taking place. If multiple regions, they will be split by commas
starts_at First port in the itinerary, where the cruise start  
starts_on Date when the cruise starts  
stay_at Information on where a pre-cruise package takes place  
stay_post Information on where a post-cruise package takes place  
travel_type Whether the cruise is 'cruise only' or a 'fly cruise'  
vacation_days Length of the cruise in days  
official_link Link to the cruise on the official vendor website Only available for some integrated cruise lines
ref ID of the cruise on the Widgety system  
arrives_on    
ship Link to the API request to get the information on the Ship  
ship_title Name of the Ship  
operator Link to the API request to get the information on the Operator  
operator_title Name of the Operator  
is_charter Whether the cruise is a chartered cruise  
fare_sets Detailed pricing  More information available below


fare_sets

Fare_sets are all the information available in regards to pricing when information about an integrated line is requested. Non integrated lines will only have the basic pricing fields available:

  • fly_cruise_price
  • cruise_only_price
  • inside_price
  • outside_price
  • balcony_price
  • suite_price 

Some cruise lines may provide multiple fare_sets if they have multiple promotions running on the same cruise. Each fare_set has the following fields:

Field Information Note
name Name of the fare_set For example 'Early Booking Savings'
port_charge Price of any port charges that might need to be added to the cruise price  
grade_code Official cabin grade code the pricing is for  
grade_name Name of the cabin grade  
price Cruise price per person based on 2 passenger occupancy An exception to this is when the fare is specific to single occupancy cabins. Single cabins usually have Single in the name
price_3_4_pax Cruise price per person for third and fourth passengers  
flight_price Flight price per person based on 2 passenger occupancy  
flight_price_3_4_pax Flight price per person for third and fourth passengers Only available for some integrated cruise lines
availability Indicated whether the grade is still available to book.  
non_comm_charges Non-comissionable charges. Travel agent will not be able to make a commission on this amount out of the total price of the cruise Only available for some integrated cruise lines


cruises/port_visits

Field Information Note
id Internal ID for this Port Visit  
day Number of the day on which this port is visited  
notes Notes in regard to this port  
arrives_on Arrival date and time of the Ship in this port Time may not always be accurate or provided
departs_on Depart date and time of the Ship in this port  
port/unlocode Internal Code for the port This can be used to map ports into other database
port/name Name of the port  
port/country Country in which the port is located  
port/summary Short summary about the city in which the port is located  
port/latitude Latitude of the city the port is located in  
port/longitude Longitude of the city the port is located in  


Non-port cruise days

These are items in the itinerary which are not actual ports, but items relating to visas. They are often the 'Cruising X' that are available in the itinerary on the official cruise line's website, such as 'Cruising the Panama Canal.' Because they aren't actual ports, they have slightly different fields:

Field Information Note
id Internal ID for this Port Visit  
day Day on the cruise during which this non-port cruise day is happening  
name Name of the non-port cruise day. This can include words such as 'Cruising'  
location Area in which this non-port cruise day is happening.  
notes Notes in regards to this non-port cruise day  
arrives_on Arrival date and time of the Ship in this port Time may not always be accurate or provided
departs_on Depart date and time of the Ship in this port  

Please note that Non-Port Cruise Days are only available for some integrated cruise lines.

Related articles

Comments

0 comments

Please sign in to leave a comment.