This article discusses the differences between Version 1 and Version 2 of the Cruises API in the following sections:
Understanding the comparison tables:
- Cell is empty >> field doesn't exist in this version
- Information goes across both columns >> field is the same across both versions
General Cruise Information
This information is available in the cruises/get and cruises/get_all requests
| Field |
V1 Information |
V2 Information |
| vendor_id |
|
Official ID from the cruise line
Note: 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 where the cruise is taking place. |
Region(s) where the cruise is taking place. Multiple regions may be available |
| 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 |
Pricing
The following 'basic' pricing fields are available in the cruises/get and cruises/get_all requests in both Version 1 and Version 2:
| Field |
V1 Information |
V2 Information |
| 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) |
In the Version 2 of the API however, detailed pricing is also available for integrated cruise lines in a new section called fare_sets.
| Field |
V1 Information |
V2 Information |
| name |
|
Name of the fare_set |
| 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 |
| 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 |
| 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 |
You can find more information about fare_sets here.
Itinerary
| Field |
V1 Information |
V2 Information |
| 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 |
| departs_on |
Depart date and time of the Ship in this port |
| port_code |
Choosing Cruising's port code for this port |
|
| port_name |
Choosing Cruising's name for this port |
|
| location |
Choosing Cruising's country for this port |
|
| port/unlocode |
|
Internal Code for the port. This can be used to map ports into other database |
| port/name |
|
Internal Name for the port |
| port/country |
|
Internal Country for the port |
V1: summary
V2: port/summary |
Short summary about the city in which the port is located |
V1: latitude
V2: port/latitude |
Latitude of the city the port is located in |
V1: longitude
V2: port/longitude |
Longitude of the city the port is located in |
In the Version 2 of the API the itinerary may also include Non-Port Cruise Days for some integrated cruise lines. These are items which are not proper ports, as the ship doesn't anchor, but are vistas the ship cruises by. These are often the 'Cruising X' available on the itinerary on the official cruise line's website. You can find more information about Non-Port Cruise Days here.
Comments
0 comments
Please sign in to leave a comment.