Update a bookable tour details
put
/spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/common
This is to update a bookable tour details
Request
Supported Media Types
- application/json
Path Parameters
-
bookableTourId: integer
bookable tour Id
-
shipId: integer
ship Id
Root Schema : Update bookable tours setup common
Type:
objectTitle:
Show Source
Update bookable tours setup commonNested Schema : capacity
Type:
Show Source
object-
isOneTicketPerPersonLimit(optional):
boolean
Switch to Enable / Disable 1 Ticket per Person limit for specific ToursExample:
true -
isWeightLimitPerGuest(optional):
boolean
Weight limit is per tour or per GuestExample:
true -
maximumAdultCapacity(optional):
integer(int64)
Minimum Value:
0Maximum Value:1000000Bookable Tour Maximum Adult CapacityExample:40 -
maximumCapacity:
integer(int64)
Minimum Value:
0Maximum Value:1000000Bookable Tour Maximum CapacityExample:50 -
maximumChildCapacity(optional):
integer(int64)
Minimum Value:
0Maximum Value:1000000Bookable Tour Maximum Child CapacityExample:10 -
minimumCapacity:
integer(int64)
Minimum Value:
0Maximum Value:1000000Bookable Tour Minimum CapacityExample:1 -
totalWeight(optional):
number
Minimum Value:
0Maximum Value:1000000Bookable Tour Total WeightExample:300
Nested Schema : details
Type:
Show Source
object-
brochureNumber(optional):
string
Minimum Length:
0Maximum Length:40Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Brochure NumberExample:56680 -
code:
string
Minimum Length:
0Maximum Length:20Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour CodeExample:FAN_TH -
comments(optional):
string
Minimum Length:
0Maximum Length:2000Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour CommentsExample:COMMENTS -
countryCode(optional):
string
Minimum Length:
0Maximum Length:6Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Country CodeExample:AS -
cruiseDayId(optional):
integer(int64)
Minimum Value:
0Maximum Value:1.0E38Cruise Day IdExample:1 -
cruiseId(optional):
integer(int64)
Minimum Value:
0Maximum Value:1.0E38Cruise IdExample:1 -
date:
string(ISO 8601)
Bookable Tour DateExample:
2021-10-18 -
externalId(optional):
string
Minimum Length:
0Maximum Length:20Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'External IdExample:E12345 -
isOvernightTour(optional):
boolean
Is Bookable Tour Overnight TourExample:
true -
isShowBookingScreenFirstPage(optional):
boolean
Show on the first page in Bookings screen instead of sorting alphabeticallyExample:
true -
name:
string
Minimum Length:
0Maximum Length:100Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour NameExample:Fantasia Tour -
portCode(optional):
string
Minimum Length:
0Maximum Length:40Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Port CodeExample:ATSEA -
predefinedComments(optional):
string
Minimum Length:
0Maximum Length:6Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Predefined CommentsExample:ID -
predefinedRequiredClothes(optional):
string
Minimum Length:
0Maximum Length:6Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Predefined Required ClothesExample:EXTRA -
requiredClothes(optional):
string
Minimum Length:
0Maximum Length:100Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Required ClothesExample:Casual Wear
Nested Schema : linking
Type:
Show Source
object-
tourCategories(optional):
string
Minimum Length:
0Maximum Length:75Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Tour CategoriesExample:T-CAT1,T-CAT2, -
tourLanguage(optional):
string
Minimum Length:
0Maximum Length:100Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Tour LanguageExample:EN -
tourReportingCategories(optional):
string
Minimum Length:
0Maximum Length:100Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Tour Reporting CategoriesExample:CITYTO,CULTHI, -
tourReportingDifficultyLevels(optional):
string
Minimum Length:
0Maximum Length:100Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Tour Reporting Difficulty LevelsExample:EASY -
tourReportingTags(optional):
string
Minimum Length:
0Maximum Length:100Pattern:[a-zA-Z0-9 ] ~!@#$%^&*()_+-?/\|,.":;{}[]=<>`'Bookable Tour Tour Reporting TagsExample:01,05, -
tourTransportationSharingGroupCode(optional):
string
Minimum Length:
0Maximum Length:6Pattern:[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:
1Maximum Length:1000000Bookable Tour Adult Actual CountsExample:6 -
adultPackagePrice(optional):
number
Minimum Value:
0Maximum Value:1.0E18Bookable Tour Adult Package PriceExample:70 -
adultRegularPrice:
number
Minimum Value:
0Maximum Value:1.0E18Bookable Tour Adult Regular PriceExample:30 -
childActualCounts(optional):
integer(int64)
Minimum Length:
1Maximum Length:1000000Bookable Tour Child Actual CountsExample:1 -
childPackagePrice(optional):
number
Minimum Value:
0Maximum Value:1.0E18Bookable Tour Child Package PriceExample:50 -
childRegularPrice(optional):
number
Minimum Value:
0Maximum Value:1.0E18Bookable Tour Child Regular PriceExample:14 -
isEnabledSalesStatus(optional):
boolean
Switch to enable / disable all tour salesExample:
true -
minimumAge(optional):
integer
Minimum Value:
0Maximum Value:200Bookable Tour Minimum AgeExample:6 -
overweightPriceIncreaseType(optional):
string
Minimum Length:
1Maximum Length:1Pattern:^[P|V]$Bookable Tour Overweight Price Increase TypeExample:P -
overweightPriceIncreaseValue(optional):
number
Minimum Value:
0Maximum Value:1.0E21Bookable 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
Minimum Value:
-100Maximum Value:100Bookable Tour Promotion Deviation ValueExample:1
Nested Schema : time
Type:
Show Source
object-
durationDays:
integer(int64)
Minimum Value:
0Maximum Value:100Bookable 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:
0Maximum Value:1.0E38Bookable 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
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Bookable Tour Details
Type:
objectTitle:
Bookable Tour DetailsRetrieve Bookable Tour Details
Show Source
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(ISO 8601)
Bookable Tour DateExample:
2021-10-18 -
externalId(optional):
string
External IdExample:
E12345 -
isOvernightTour(optional):
boolean
Is Bookable Tour Overnight Tour (default value: false)Example:
true -
isShowBookingScreenFirstPage(optional):
boolean
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
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
Is Bookable Tour Valid For Promotion (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
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
409 Response
Conflict
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error ResponseError 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:
objectTitle:
Error ResponseError Response returned when encountered error
Show Source