Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"kind": {
"enum": [
"ocean",
"river"
],
"type": "string",
"description": "ocean or river cruises only"
},
"sort": {
"enum": [
"departure",
"price",
"price_per_night",
"nights",
"newest"
],
"type": "string",
"description": "departure (default), price, price_per_night, nights (shortest first) or newest"
},
"query": {
"type": "string",
"maxLength": 200,
"description": "Free text, read into the fields above: \"a week in the fjords from Southampton next June\". Structured fields win where both are given. Leave it out when paging."
},
"ships": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"description": "Ship names or slugs"
},
"cursor": {
"type": "string",
"maxLength": 64,
"description": "next_cursor from the previous page. It holds only the page number, so send it with that page's applied_filters"
},
"months": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{4}-(?:0[1-9]|1[0-2])$"
},
"maxItems": 24,
"description": "Departure months, YYYY-MM"
},
"no_fly": {
"type": "boolean",
"description": "true: only cruises leaving from a UK port"
},
"date_to": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "Latest departure date, YYYY-MM-DD"
},
"date_from": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
"description": "Earliest departure date, YYYY-MM-DD"
},
"nights_max": {
"type": "integer",
"maximum": 365,
"minimum": 1,
"description": "Longest length, in nights"
},
"nights_min": {
"type": "integer",
"maximum": 365,
"minimum": 1,
"description": "Shortest length, in nights"
},
"round_trip": {
"type": "boolean",
"description": "true: round trips only; false: one-way only"
},
"cruise_lines": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"description": "Cruise line names, slugs or short names: \"P&O\", \"fred-olsen\""
},
"destinations": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"description": "Destination names or slugs: \"Caribbean\", \"norwegian-fjords\" (list_destinations has them all)"
},
"max_price_gbp": {
"type": "integer",
"maximum": 1000000,
"minimum": 1,
"description": "Highest price per person, in pounds"
},
"departure_ports": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"description": "Departure port names or slugs: \"Southampton\" (list_departure_ports has them all)"
}
},
"additionalProperties": false
}