Retrieve a list of bookable tours
get
/spms/v2/ships/{shipId}/configurations/excursions/bookableTours
This is to retrieve a list of bookable tours
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: integer
ship Id
Query Parameters
-
bookableTourId: integer(int32)
Bookable Tour Id
-
date: string(yyyy-MM-dd)
Bookable Tour Date
-
limit: integer(int32)
Paging limit
-
offset: integer(int32)
Paging offset.
-
portCode: string
Bookablt Tour Port Code
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : List of bookable tours
Type:
object
Title:
List of bookable tours
List of bookable tours
Show Source
-
count(optional):
integer
Example:
18
-
hasMore(optional):
boolean
Example:
true
-
items(optional):
array items
-
limit(optional):
integer
Example:
10
-
links(optional):
array links
-
offset(optional):
integer
Example:
0
Nested Schema : ExcursionBookableTourSetupReturnSearchData
Type:
object
data return
Show Source
-
item(optional):
object Bookable Tours
Title:
Bookable Tours
Retrieve bookable tours -
links(optional):
links
Nested Schema : Bookable Tours
Type:
object
Title:
Bookable Tours
Retrieve bookable tours
Show Source
-
additionalInfo(optional):
object additionalInfo
-
capacity(optional):
object capacity
-
costs(optional):
object costs
-
details(optional):
object details
-
interfaces(optional):
object interfaces
-
linking(optional):
object linking
-
pricing(optional):
object pricing
-
promotion(optional):
object promotion
-
setup(optional):
object setup
-
time(optional):
object time
-
totalAdultBookedExcursion(optional):
integer
Total number of adult bookedExample:
10
-
totalChildBookedExcursion(optional):
integer
Total number of children bookedExample:
5
-
vendors(optional):
array vendors
Nested Schema : links
Match All
Show Source
-
object
linksBookableTour
links detail
-
object
links-allOf[1]
Nested Schema : additionalInfo
Type:
Show Source
object
-
comment1(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 1Example:comment1
-
comment10(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 10Example:comment10
-
comment2(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 2Example:comment2
-
comment3(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 3Example:comment3
-
comment4(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 4Example:comment4
-
comment5(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 5Example:comment5
-
comment6(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 6Example:comment6
-
comment7(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 7Example:comment7
-
comment8(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 8Example:comment8
-
comment9(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Label 9Example:comment9
-
value1(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 1Example:value1
-
value10(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 10Example:value10
-
value2(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 2Example:value2
-
value3(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 3Example:value3
-
value4(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 4Example:value4
-
value5(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 5Example:value5
-
value6(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 6Example:value6
-
value7(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 7Example:value7
-
value8(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 8Example:value8
-
value9(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Custom Comments Value 9Example:value9
Nested Schema : capacity
Type:
Show Source
object
-
isOneTicketPerPersonLimit(optional):
boolean
Switch to Enable / Disable 1 Ticket per Person limit for specific Tours (default value: false)Example:
true
-
isWeightLimitPerGuest(optional):
boolean
Weight limit is per tour or per Guest (default value: false)Example:
true
-
maximumAdultCapacity(optional):
number
Bookable Tour Maximum Adult CapacityExample:
40
-
maximumCapacity(optional):
number
Bookable Tour Maximum CapacityExample:
50
-
maximumChildCapacity(optional):
number
Bookable Tour Maximum Child CapacityExample:
10
-
minimumCapacity(optional):
number
Bookable Tour Minimum CapacityExample:
1
-
totalWeight(optional):
number
Bookable Tour Total Weight (default value: 0)Example:
300
Nested Schema : details
Type:
Show Source
object
-
bookableTourId(optional):
integer
Bookable Tour IdExample:
1234
-
brochureNumber(optional):
string
Bookable Tour Brochure NumberExample:
56680
-
code(optional):
string
Bookable Tour CodeExample:
FAN_TH
-
comments(optional):
string
Bookable Tour CommentsExample:
COMMENTS
-
countryCode(optional):
string
Bookable Tour Country CodeExample:
AS
-
cruiseDayId(optional):
integer
Cruise Day IdExample:
1
-
cruiseId(optional):
integer
Cruise IdExample:
1
-
date(optional):
string(yyyy-MM-dd)
Bookable Tour DateExample:
2021-10-18
-
externalId(optional):
string
External IdExample:
E12345
-
isOvernightTour(optional):
boolean
This is to indicate the tour is an overnight tour or not an overnight tour.Example:
true
-
isShowBookingScreenFirstPage(optional):
boolean
This is to indicate to show on the first page in Bookings screen instead of sorting alphabetically (default value: false)Example:
true
-
name(optional):
string
Bookable Tour NameExample:
Fantasia Tour
-
portCode(optional):
string
Bookable Tour Port CodeExample:
ATSEA
-
predefinedComments(optional):
string
Bookable Tour Predefined CommentsExample:
ID
-
predefinedRequiredClothes(optional):
string
Bookable Tour Predefined Required ClothesExample:
EXTRA
-
requiredClothes(optional):
string
Bookable Tour Required ClothesExample:
Casual Wear
Nested Schema : linking
Type:
Show Source
object
-
tourCategories(optional):
string
Bookable Tour Tour CategoriesExample:
T-CAT1,T-CAT2,
-
tourLanguage(optional):
string
Bookable Tour Tour LanguageExample:
EN
-
tourReportingCategories(optional):
string
Bookable Tour Tour Reporting CategoriesExample:
CITYTO,CULTHI,
-
tourReportingDifficultyLevels(optional):
string
Bookable Tour Tour Reporting Difficulty LevelsExample:
EASY
-
tourReportingTags(optional):
string
Bookable Tour Tour Reporting TagsExample:
01,05,
-
tourTransportationSharingGroupCode(optional):
string
Bookable Tour Tour Transportation Sharing Group CodeExample:
BUS
Nested Schema : pricing
Type:
Show Source
object
-
adultActualCounts(optional):
number
Bookable Tour Adult Actual CountsExample:
6
-
adultCost(optional):
number
Bookable Tour Adult CostExample:
6
-
adultPackagePrice(optional):
number
Bookable Tour Adult Package Price (default value: 0)Example:
70
-
adultRegularPrice(optional):
number
Bookable Tour Adult Regular PriceExample:
30
-
childActualCounts(optional):
number
Bookable Tour Child Actual CountsExample:
1
-
childCost(optional):
number
Bookable Tour Adult CostExample:
1
-
childPackagePrice(optional):
number
Bookable Tour Child Package Price (default value: 0)Example:
50
-
childRegularPrice(optional):
number
Bookable Tour Child Regular Price (default value: 0)Example:
14
-
isEnabledSalesStatus(optional):
boolean
This is to indicate switch to enable / disable all tour sales (default value: true)Example:
true
-
minimumAge(optional):
integer
Bookable Tour Minimum Age (allow integer value only)Example:
6
-
overweightPriceIncreaseType(optional):
string
Bookable Tour Overweight Price Increase TypeExample:
P
-
overweightPriceIncreaseValue(optional):
number
Bookable Tour Overweight Price Increase ValueExample:
20
Nested Schema : promotion
Type:
Show Source
object
-
isValidforPromotion(optional):
boolean
Is Bookable Tour Valid For PromotionExample:
true
-
promotionDiscountDeviationValue(optional):
number
Bookable Tour Promotion Deviation ValueExample:
1
Nested Schema : time
Type:
Show Source
object
-
durationDays(optional):
integer
Bookable Tour Duration DaysExample:
1
-
durationTime(optional):
string
Bookable Tour Duration TimeExample:
03:00
-
endTime(optional):
string
Bookable Tour End TimeExample:
13:00
-
meetingPointCode(optional):
integer
Bookable Tour Meeting Point CodeExample:
1
-
meetingTime(optional):
string
Bookable Tour Meeting TimeExample:
10:00
-
startTime(optional):
string
Bookable Tour Start TimeExample:
10:00
Nested Schema : getCostsResponse
Type:
Show Source
object
-
bookableTourId(optional):
integer
Bookable Tour IdExample:
1234
-
firstName(optional):
string
Costs First NameExample:
JAMES
-
fixedCostId(optional):
integer
Fixed Costs IdExample:
1234
-
itemType(optional):
string
Costs Item TypeExample:
MALTA
-
lastName(optional):
string
Costs Last NameExample:
LEE
-
price(optional):
number
Bookable Tour Costs PriceExample:
20
-
quantity(optional):
number
Bookable Tour Costs QuantityExample:
3
-
total(optional):
number
Bookable Tour Costs TotalExample:
60
-
vendorId(optional):
integer
Vendor IdExample:
123
Nested Schema : interactiveTV
Type:
Show Source
object
-
isEnabledChildBookingInInteractiveTV(optional):
boolean
This is to indicate enable child booking in Interactive TV (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)Example:
true
-
isMakeBookableInInteractiveTV(optional):
boolean
This is to indicate excursion is bookable in External Interactive TV System (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)Example:
true
-
isShowInInteractiveTV(optional):
boolean
This is to indicate to show excursion in Interactive TV (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)Example:
true
Nested Schema : kiosk
Type:
Show Source
object
-
isEnabledChildBookingInKiosk(optional):
boolean
This is to indicate enable child boooking in OHC Kiosk (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)Example:
true
-
isMakeBookableInKiosk(optional):
boolean
This is to indicate excursion is bookable in OHC Kiosk (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)Example:
true
-
isShowInKiosk(optional):
boolean
This is to indicate excursion to show in OHC Kiosk (default value is based on parameter 'disableFCUIAndKioskBookingOptions', if the parameter value is null then the default value will set to true)Example:
true
-
kioskDefaultAudioFileId(optional):
string
Bookable Tour Kiosk Default Audio File IdExample:
160000002481
-
kioskDefaultHTMLFileId(optional):
string
Bookable Tour Kiosk Default Html File IdExample:
160000002482
-
kioskDefaultPictureFileId(optional):
integer
Bookable Tour Kiosk Default Picture File IdExample:
1.60000001221E11
-
kioskDefaultVideoFileId(optional):
string
Bookable Tour Kiosk Default Video File IdExample:
160000002480
Nested Schema : printing
Type:
Show Source
object
-
defaultTicketReport(optional):
string
Bookable Tour Default Ticket ReportExample:
EXC01TICKET
-
isEnabledEInvoice(optional):
boolean
This is to indicate switch to enable / disable e-Invoice printing for specific Tours (default value: true)Example:
true
-
isPrintTicket(optional):
boolean
This is to indicate a switch to enable/disable Ticket Printing for each Tour (default value: true)Example:
true
-
isPrintTicketSummary(optional):
boolean
This is to indicate Print Tour Ticket Summary indicator (default value: true)Example:
true
Nested Schema : transferTour
Type:
Show Source
object
-
isTransferTour(optional):
boolean
This is to indicate to transfer tour or not to. (default value: false)Example:
true
-
transferFromLocationCode(optional):
string
Bookable Tour Transfer From Location CodeExample:
FOR DINNER
-
transferToLocationCode(optional):
string
Bookable Tour Transfer To Location CodeExample:
TTL02
-
transferToLocationDescription(optional):
string
Bookable Tour Transfer To Location DescriptionExample:
NIGHT MARKET
Nested Schema : salesPosting
Type:
Show Source
object
-
cancellationFeeSalesPostingDepartmentId(optional):
string
Bookable Tour Cancellation Fee Sales Posting Department IdExample:
8001
-
cancellationFeeSalesPostingDepartmentType(optional):
string
Bookable Tour Cancellation Fee Sales Posting Department TypeExample:
P
-
cancellationFeeSalesPostingDepartmentValue(optional):
integer
Bookable Tour Cancellation Fee Sales Posting Department ValueExample:
1
-
fcuiSalesPostingDepartment(optional):
string
Bookable Tour Fcui Sales Posting Department IdExample:
8001
-
kioskSalesPostingDepartment(optional):
string
Bookable Tour Kiosk Sales Posting DepartmentExample:
8001
-
prepaidSalesPostingDepartment(optional):
string
Bookable Tour Prepaid Sales Posting DepartmentExample:
8001
-
regularSalesPostingDepartmentId(optional):
string
Bookable Tour Regular Sales Posting Department IdExample:
8001
-
voidPrepaidSalesPostingDepartment(optional):
string
Bookable Tour Void Prepaid Sales Posting DepartmentExample:
8001
Nested Schema : salesTaxAndFees
Type:
Show Source
object
-
salesFeesPostingDepartmentId(optional):
string
Bookable Tour Sales Fees Posting Department IdExample:
8009
-
salesFeesPostingDepartmentType(optional):
string
Bookable Tour Sales Fees Posting Department TypeExample:
P
-
salesFeesPostingDepartmentValue(optional):
number
Bookable Tour Sales Fees Posting Department ValueExample:
5
-
salesTaxDepartment1Id(optional):
string
Bookable Tour Sales Tax Department 1 IdExample:
8006
-
salesTaxDepartment1Type(optional):
string
Bookable Tour Sales Tax Department 1 TypeExample:
P
-
salesTaxDepartment1Value(optional):
number
Bookable Tour Sales Tax Department 1 ValueExample:
10
-
salesTaxDepartment2Id(optional):
string
Bookable Tour Sales Tax Department 2 IdExample:
8007
-
salesTaxDepartment2Type(optional):
string
Bookable Tour Sales Tax Department 2 TypeExample:
P
-
salesTaxDepartment2Value(optional):
number
Bookable Tour Sales Tax Department 2 ValueExample:
1
Nested Schema : vatReportingSplit
Type:
Show Source
object
-
VATReportingSplit1Price(optional):
number
Bookable Tour Vat Reporting Split 1 PriceExample:
1
-
VATReportingSplit1Rate(optional):
number
Bookable Tour Vat Reporting Split 1 RateExample:
116.12
-
VATReportingSplit2Price(optional):
number
Bookable Tour Vat Reporting Split 2 PriceExample:
0.5
-
VATReportingSplit2Rate(optional):
number
Bookable Tour Vat Reporting Split 2 RateExample:
117.23
-
VATReportingSplit3Price(optional):
number
Bookable Tour Vat Reporting Split 3 PriceExample:
1
-
VATReportingSplit3Rate(optional):
number
Bookable Tour Vat Reporting Split 3 RateExample:
118.2
-
VATReportingSplit4Price(optional):
number
Bookable Tour Vat Reporting Split 4 PriceExample:
3
-
VATReportingSplit4Rate(optional):
number
Bookable Tour Vat Reporting Split 4 RateExample:
50
Nested Schema : getVendorResponse
Type:
Show Source
object
-
bookableTourId(optional):
integer
Bookable Tour IdExample:
1234
-
bookableTourVendorId(optional):
integer
Bookable Tour Vendor IdExample:
1233
-
company(optional):
string
Vendor CompanyExample:
TRAVEL INC
-
country(optional):
string
Vendor CountryExample:
US
-
firstName(optional):
string
Vendor First NameExample:
JAMES
-
lastName(optional):
string
Vendor Last NameExample:
LEE
-
tourTemplateId(optional):
integer
Tour Template IdExample:
120
-
vendorId(optional):
integer
Vendor IdExample:
123
Nested Schema : linksBookableTour
Type:
object
links detail
Show Source
-
method(optional):
string
Example:
get
-
rel(optional):
string
Example:
self
Nested Schema : links-allOf[1]
Type:
Show Source
object
-
href(optional):
string
Example:
http://[HOSTNAME]/spms/v2/ships/186000000117/configurations/excursions/bookableTours?bookableTourId=1234
-
operationId(optional):
string
Example:
findById
Nested Schema : items
Match All
Show Source
-
object
linksBookableTour
links detail
-
object
items-allOf[1]
Nested Schema : items-allOf[1]
Type:
Show Source
object
-
href(optional):
string
Example:
http://[HOSTNAME]/spms/v2/ships/186000000117/configurations/excursions/bookableTours?bookableTourId=1234&date=2021-01-26&portCode=ATSEA&offset=0&limit=10
-
operationId(optional):
string
Example:
nextPage
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Bad Request",
"detail":"Empty request body."
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
You are not authorized to use this API
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorized",
"detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
You are forbidden to use this API
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource was forbidden"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
This method is not available
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Allowed",
"detail":"HTTP method not supported for this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
"title":"Not Acceptable",
"detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
The media supplied is not supported
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"title":"Invalid content",
"detail":"Content type not supported",
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Error occurred while processing this request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Issue fulfilling request. Please retry or contact support"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service not available
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source