Create a new bookable tour
post
/spms/v2/ships/{shipId}/configurations/excursions/bookableTours
This is to create a new bookable tour
Request
Supported Media Types
- application/json
Path Parameters
-
shipId: integer
ship Id
Root Schema : Create new bookable tours
Type:
object
Title:
Show Source
Create new bookable tours
-
additionalInfo(optional):
object additionalInfo
-
capacity(optional):
object capacity
-
costs(optional):
object costs
-
details(optional):
object details
-
groupLinkings(optional):
array groupLinkings
-
interfaces(optional):
object interfaces
-
linking(optional):
object linking
-
packageLinkings(optional):
array packageLinkings
-
pricing(optional):
object pricing
-
promotion(optional):
object promotion
-
setup(optional):
object setup
-
time(optional):
object time
-
vendors(optional):
array vendors
Nested Schema : additionalInfo
Type:
Show Source
object
-
value1(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 1Example:Wonderful view
-
value10(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 10Example:Superb
-
value2(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 2Example:Nice
-
value3(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 3Example:Beautiful
-
value4(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 4Example:Relaxing
-
value5(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 5Example:Lovely
-
value6(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 6Example:Pleasing
-
value7(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 7Example:Marvelous
-
value8(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 8Example:Amazing
-
value9(optional):
string
Minimum Length:
0
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 9Example:Awesome
Nested Schema : capacity
Type:
Show Source
object
-
isOneTicketPerPersonLimit(optional):
boolean
This is to indicate switch to Enable / Disable 1 Ticket per Person limit for specific Tours (default value: false)Example:
true
-
isWeightLimitPerGuest(optional):
boolean
This is to indicate weight limit is per tour or per Guest (default value: false)Example:
true
-
maximumAdultCapacity(optional):
integer(int64)
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Maximum Adult CapacityExample:40
-
maximumCapacity:
integer(int64)
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Maximum CapacityExample:50
-
maximumChildCapacity(optional):
integer(int64)
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Maximum Child CapacityExample:10
-
minimumCapacity:
integer(int64)
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Minimum CapacityExample:1
-
totalWeight(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Total Weight (default value: 0)Example:300
Nested Schema : details
Type:
Show Source
object
-
brochureNumber(optional):
string
Minimum Length:
0
Maximum Length:40
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Brochure NumberExample:56680
-
code:
string
Minimum Length:
0
Maximum Length:20
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour CodeExample:FAN_TH
-
comments(optional):
string
Minimum Length:
0
Maximum Length:2000
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour CommentsExample:COMMENTS
-
countryCode(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Country CodeExample:AS
-
cruiseDayId(optional):
integer(int64)
Minimum Value:
0
Maximum Value:1.0E38
Cruise Day IdExample:1
-
cruiseId(optional):
integer(int64)
Minimum Value:
0
Maximum Value:1.0E38
Cruise IdExample:1
-
date:
string(ISO:8601)
Bookable Tour Date. ISO:8601: Date format is YYYY-MM-DDExample:
2021-10-18
-
externalId(optional):
string
Minimum Length:
0
Maximum Length:20
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
External IdExample:E12345
-
isOvernightTour(optional):
boolean
This is to indicate the tour is an overnight tour or not an overnight tour. (default value: false)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:
string
Minimum Length:
0
Maximum Length:100
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour NameExample:Fantasia Tour
-
portCode(optional):
string
Minimum Length:
0
Maximum Length:40
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Port CodeExample:ATSEA
-
predefinedComments(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Predefined CommentsExample:ID
-
predefinedRequiredClothes(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Predefined Required ClothesExample:EXTRA
-
requiredClothes(optional):
string
Minimum Length:
0
Maximum Length:100
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Required ClothesExample:Casual Wear
Nested Schema : linking
Type:
Show Source
object
-
tourCategories(optional):
string
Minimum Length:
0
Maximum Length:75
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Tour CategoriesExample:T-CAT1,T-CAT2,
-
tourLanguage(optional):
string
Minimum Length:
0
Maximum Length:100
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Tour LanguageExample:EN
-
tourReportingCategories(optional):
string
Minimum Length:
0
Maximum Length:100
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Tour Reporting CategoriesExample:CITYTO,CULTHI,
-
tourReportingDifficultyLevels(optional):
string
Minimum Length:
0
Maximum Length:100
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Tour Reporting Difficulty LevelsExample:EASY
-
tourReportingTags(optional):
string
Minimum Length:
0
Maximum Length:100
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Tour Reporting TagsExample:01,05,
-
tourTransportationSharingGroupCode(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Tour Transportation Sharing Group CodeExample:BUS
Nested Schema : pricing
Type:
Show Source
object
-
adultActualCounts(optional):
integer(int64)
Minimum Length:
1
Maximum Length:1000000
Bookable Tour Adult Actual CountsExample:6
-
adultPackagePrice(optional):
number
Minimum Value:
0
Maximum Value:1.0E18
Bookable Tour Adult Package Price (default value: 0)Example:70
-
adultRegularPrice:
number
Minimum Value:
0
Maximum Value:1.0E18
Bookable Tour Adult Regular PriceExample:30
-
childActualCounts(optional):
integer(int64)
Minimum Length:
1
Maximum Length:1000000
Bookable Tour Child Actual CountsExample:1
-
childPackagePrice(optional):
number
Minimum Value:
0
Maximum Value:1.0E18
Bookable Tour Child Package Price (default value: 0)Example:50
-
childRegularPrice(optional):
number
Minimum Value:
0
Maximum Value:1.0E18
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
Minimum Value:
0
Maximum Value:200
Bookable Tour Minimum AgeExample:6
-
overweightPriceIncreaseType(optional):
string
Minimum Length:
1
Maximum Length:1
Pattern:^[P|V]$
Bookable Tour Overweight Price Increase Type (default value: P)Example:P
-
overweightPriceIncreaseValue(optional):
number
Minimum Value:
0
Maximum Value:1.0E21
Bookable Tour Overweight Price Increase ValueExample:20
Nested Schema : promotion
Type:
Show Source
object
-
isValidforPromotion(optional):
boolean
This is to indicate Is Bookable Tour Valid For Promotion (default value: false)Example:
true
-
promotionDiscountDeviationValue(optional):
number
Minimum Value:
-100
Maximum Value:100
Bookable Tour Promotion Deviation ValueExample:1
Nested Schema : time
Type:
Show Source
object
-
durationDays:
integer(int64)
Minimum Value:
0
Maximum Value:100
Bookable Tour Duration DaysExample:1
-
durationTime(optional):
string(ISO 8601)
Pattern:
[0-2][0-3]:[0-5][0-9]
Bookable Tour Duration TimeExample:03:00
-
endTime(optional):
string(ISO 8601)
Pattern:
[0-2][0-3]:[0-5][0-9]
Bookable Tour End TimeExample:13:00
-
meetingPointCode(optional):
integer(int64)
Minimum Value:
0
Maximum Value:1.0E38
Bookable Tour Meeting Point CodeExample:1
-
meetingTime(optional):
string(ISO 8601)
Pattern:
[0-2][0-3]:[0-5][0-9]
Bookable Tour Meeting TimeExample:10:00
-
startTime(optional):
string(ISO 8601)
Pattern:
[0-2][0-3]:[0-5][0-9]
Bookable Tour Start TimeExample:10:00
Nested Schema : fixedCostsRequest
Type:
Show Source
object
-
itemType:
string
Minimum Length:
0
Maximum Length:1000
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Costs Item TypeExample:MALTA
-
price(optional):
number
Minimum Value:
0
Maximum Value:1.0E18
Costs PriceExample:20
-
quantity(optional):
integer
Minimum Value:
0
Maximum Value:1000000
Costs QuantityExample:3
-
vendorId:
integer(int64)
Minimum Value:
0
Maximum Value:1.0E38
Vendor IdExample:123
Nested Schema : variableCostsRequest
Type:
Show Source
object
-
adultCost:
number
Minimum Value:
0
Maximum Value:1.0E18
Variable cost for adult costExample:20.5
-
childCost:
number
Minimum Value:
0
Maximum Value:1.0E18
Variable cost for child costExample:10.5
-
range:
number(int64)
Minimum Value:
1
Maximum Value:999999999
Max number of people price can be applied toExample:20
Nested Schema : groupLinkingRequest
Type:
Show Source
object
-
groupProfileId:
integer(int64)
Minimum Value:
1
Maximum Value:999999999
Group Account Reference (Only accept group with a reservation status that is either reservation, embark today, no show, checked in or leaving today)Example:1234567
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 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
Minimum Length:
0
Maximum Length:50
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Kiosk Default Audio File IdExample:160000002481
-
kioskDefaultHTMLFileId(optional):
string
Minimum Length:
0
Maximum Length:500
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Kiosk Default Html File IdExample:160000002482
-
kioskDefaultPictureFileId(optional):
integer(int64)
Minimum Value:
0
Maximum Value:1.0E38
Bookable Tour Kiosk Default Picture File IdExample:1.60000001221E11
-
kioskDefaultVideoFileId(optional):
string
Minimum Length:
0
Maximum Length:50
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Kiosk Default Video File IdExample:160000002480
Nested Schema : printing
Type:
Show Source
object
-
defaultTicketReport(optional):
string
Minimum Length:
0
Maximum Length:20
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
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 : packageLinkingRequest
Type:
Show Source
object
-
packageId:
integer(int64)
Minimum Value:
1
Maximum Value:999999999
Package ID reference (only accept enabled package)Example:1234567
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
Minimum Length:
0
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Transfer To Location CodeExample:TTL01
-
transferFromLocationDescription(optional):
string
Minimum Length:
0
Maximum Length:40
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Transfer From Location DescriptionExample:FOR DINNER
-
transferToLocationCode(optional):
string
Minimum Length:
0
Maximum Length:6
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Transfer To Location CodeExample:TTL02
-
transferToLocationDescription(optional):
string
Minimum Length:
0
Maximum Length:40
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Bookable Tour Transfer To Location DescriptionExample:NIGHT MARKET
Nested Schema : salesPosting
Type:
Show Source
object
-
cancellationFeeSalesPostingDepartmentId(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Cancellation Fee Sales Posting Department IdExample:8001
-
cancellationFeeSalesPostingDepartmentType(optional):
string
Minimum Length:
1
Maximum Length:1
Pattern:^[P|V]*$
Bookable Tour Cancellation Fee Sales Posting Department Type. 'P' is Percentage or 'V' is Value. (default value: P)Example:P
-
cancellationFeeSalesPostingDepartmentValue(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Cancellation Fee Sales Posting Department ValueExample:1
-
fcuiSalesPostingDepartment(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Fcui Sales Posting Department IdExample:8001
-
kioskSalesPostingDepartment(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Kiosk Sales Posting DepartmentExample:8001
-
prepaidSalesPostingDepartment(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Prepaid Sales Posting DepartmentExample:8001
-
regularSalesPostingDepartmentId(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Regular Sales Posting Department IdExample:8001
-
voidPrepaidSalesPostingDepartment(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Void Prepaid Sales Posting DepartmentExample:8001
Nested Schema : salesTaxAndFees
Type:
Show Source
object
-
salesFeesPostingDepartmentId(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Sales Fees Posting Department IdExample:8009
-
salesFeesPostingDepartmentType(optional):
string
Minimum Length:
1
Maximum Length:1
Pattern:^[P|V]$
Bookable Tour Sales Fees Posting Department Type (default value: P)Example:P
-
salesFeesPostingDepartmentValue(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Sales Fees Posting Department ValueExample:5
-
salesTaxDepartment1Id(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Sales Tax Department 1 IdExample:8006
-
salesTaxDepartment1Type(optional):
string
Minimum Length:
1
Maximum Length:1
Pattern:^[P|V]$
Bookable Tour Sales Tax Department 1 Type (default value: P)Example:P
-
salesTaxDepartment1Value(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Sales Tax Department 1 ValueExample:10
-
salesTaxDepartment2Id(optional):
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
Bookable Tour Sales Tax Department 2 IdExample:8007
-
salesTaxDepartment2Type(optional):
string
Minimum Length:
1
Maximum Length:1
Pattern:^[P|V]$
Bookable Tour Sales Tax Department 2 Type (default value: P)Example:P
-
salesTaxDepartment2Value(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Sales Tax Department 2 ValueExample:1
Nested Schema : vatReportingSplit
Type:
Show Source
object
-
vatReportingSplit1Price(optional):
number
Minimum Value:
0
Maximum Value:1.0E20
Bookable Tour Vat Reporting Split 1 PriceExample:1
-
vatReportingSplit1Rate(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Vat Reporting Split 1 RateExample:116.12
-
vatReportingSplit2Price(optional):
number
Minimum Value:
0
Maximum Value:1.0E20
Bookable Tour Vat Reporting Split 2 PriceExample:0.5
-
vatReportingSplit2Rate(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Vat Reporting Split 2 RateExample:117.23
-
vatReportingSplit3Price(optional):
number
Minimum Value:
0
Maximum Value:1.0E20
Bookable Tour Vat Reporting Split 3 PriceExample:1
-
vatReportingSplit3Rate(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Vat Reporting Split 3 RateExample:118.2
-
vatReportingSplit4Price(optional):
number
Minimum Value:
0
Maximum Value:1.0E20
Bookable Tour Vat Reporting Split 4 PriceExample:3
-
vatReportingSplit4Rate(optional):
number
Minimum Value:
0
Maximum Value:1000000
Bookable Tour Vat Reporting Split 4 RateExample:50
Nested Schema : items
Type:
Show Source
object
-
bookingType:
string
Minimum Length:
1
Maximum Length:14
Pattern:^[a-zA-Z0-9 ]*$
Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitiveExample:Regular
-
vatAmountAdult:
number
Minimum Value:
1.0E-4
Maximum Value:1.0E18
VAT Amount for adultExample:20.5
-
vatAmountChild:
number
Minimum Value:
1.0E-4
Maximum Value:1.0E18
VAT Amount for childExample:10.5
-
vatPostingDepartmentCode:
string
Minimum Length:
0
Maximum Length:10
Pattern:^[a-zA-Z0-9 ]*$
VAT Posting Department Code (must be debit department and cannot be disabled)Example:8007
Nested Schema : vendorRequest
Type:
Show Source
object
-
vendorId:
integer(int64)
Minimum Value:
0
Maximum Value:1.0E38
Vendor IdExample:123
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : Bookable Tour Setup Response
Type:
object
Title:
Bookable Tour Setup Response
Retrieve Bookable Tour Setup
Show Source
-
additionalInfo(optional):
object additionalInfo
-
capacity(optional):
object capacity
-
costs(optional):
object costs
-
details(optional):
object details
-
groupLinkings(optional):
array groupLinkings
-
interfaces(optional):
object interfaces
-
linking(optional):
object linking
-
packageLinkings(optional):
array packageLinkings
-
pricing(optional):
object pricing
-
promotion(optional):
object promotion
-
setup(optional):
object setup
-
time(optional):
object time
-
vendors(optional):
array vendors
Nested Schema : additionalInfo
Type:
Show Source
object
-
value1(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 1Example:Wonderful view
-
value10(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 10Example:Superb
-
value2(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 2Example:Nice
-
value3(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 3Example:Beautiful
-
value4(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 4Example:Relaxing
-
value5(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 5Example:Lovely
-
value6(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 6Example:Pleasing
-
value7(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 7Example:Marvelous
-
value8(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 8Example:Amazing
-
value9(optional):
string
Minimum Length:
1
Maximum Length:200
Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'
Comment for bookable tour custom comments 9Example:Awesome
Nested Schema : capacity
Type:
Show Source
object
-
isOneTicketPerPersonLimit(optional):
boolean
This is to indicate switch to Enable / Disable 1 Ticket per Person limit for specific Tours (default value: false)Example:
true
-
isWeightLimitPerGuest(optional):
boolean
This is to indicate 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(ISO:8601)
Bookable Tour Date. ISO:8601: Date format is YYYY-MM-DDExample:
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. (default value: false)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(int64)
Bookable Tour Minimum AgeExample:
6
-
overweightPriceIncreaseType(optional):
string
Bookable Tour Overweight Price Increase TypeExample:
P
-
overweightPriceIncreaseValue(optional):
number
Bookable Tour Overweight Price Increase ValueExample:
22
Nested Schema : promotion
Type:
Show Source
object
-
isValidforPromotion(optional):
boolean
This is to indicate whether this bookable tour valid for promotion or not (default value: false)Example:
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 : costsResponse
Type:
Show Source
object
-
bookableTourId(optional):
integer
Bookable Tour IdExample:
1234
-
fixedCostId(optional):
integer
Fixed Costs IdExample:
1234
-
itemType(optional):
string
Costs Item TypeExample:
MALTA
-
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 : variableCostsResponse
Type:
Show Source
object
-
adultCost(optional):
number
Variable cost for adult costExample:
20.5
-
childCost(optional):
number
Variable cost for child costExample:
10.5
-
range(optional):
number
Max number of people price can be applied toExample:
20
-
variableCostId(optional):
number
Variable cost idExample:
1234567
Nested Schema : groupLinkingResponse
Type:
Show Source
object
-
groupLinkingId(optional):
integer
Group linking idExample:
1234567
-
groupName(optional):
string
Group nameExample:
Red Group
-
groupNumber(optional):
string
Group numberExample:
12345678
-
groupProfileId(optional):
integer
Group Account ReferenceExample:
1234567
-
groupReservationStatus(optional):
string
Group reservation status: Reservation, Cancelled, Embark today, No Show, Checked In, Leaving today, Disembarked, ErrorExample:
Checked-in
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 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 whether need to print Tour Ticket Summary or not (default value: true)Example:
true
Nested Schema : packageLinkingResponse
Type:
Show Source
object
-
code(optional):
string
Package codeExample:
PCK01
-
combinationTypeCode(optional):
string
Package combination type codeExample:
PCB-01
-
combinationTypeName(optional):
string
Package combination type nameExample:
Package Combination 01
-
name(optional):
string
Package nameExample:
Diving
-
packageAdultPrice(optional):
integer
Package adult priceExample:
70
-
packageChildPrice(optional):
integer
Package child priceExample:
50
-
packageId(optional):
integer
Package ID referenceExample:
1234567
-
packageLinkingId(optional):
integer
Package linking idExample:
1234567
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 : items
Type:
Show Source
object
-
bookingType(optional):
string
Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitiveExample:
Regular
-
vatAmountAdult(optional):
number
VAT Amount for adultExample:
20.5
-
vatAmountChild(optional):
number
VAT Amount for childExample:
10.5
-
vatPostingDepartmentCode(optional):
string
VAT Posting Department Code.Example:
8007
-
vatPostingDepartmentName(optional):
string
VAT Posting Department NameExample:
American Express
-
vatPostingSplitId(optional):
number
VAT posting split idExample:
12345678
-
vatTaxRate(optional):
number
VAT percentageExample:
3
Nested Schema : vendorResponse
Type:
Show Source
object
-
bookableTourId(optional):
integer
Bookable Tour IdExample:
1234
-
bookableTourVendorId(optional):
integer
Bookable Tour Vendor IdExample:
1233
-
vendorId(optional):
integer
Vendor IdExample:
123
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.1",
"title":"Bad Request",
"detail":[
{
"errorPath":"date",
"message":"must not be null"
}
]
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
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
Forbidden
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.4.4",
"title":"Forbidden",
"detail":"Access to this resource is forbidden"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
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.5",
"title":"Not Found",
"detail":"Ship Id could not be found"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
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 Supported",
"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":"System not allows officers to schedule a tour before the current date"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
409 Response
Conflict
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.10",
"title":"Conflict",
"detail":"This Bookable Tour Code is already in use on the specified Date."
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
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.16",
"title":"Invalid content",
"detail":"Content type Not supported"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
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.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 Unavailable
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