Update sales for bookable tours
put
/spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/setup/sales
This is to update sales for bookable tour
Request
Supported Media Types
- application/json
Path Parameters
-
bookableTourId: integer
bookableTour Id
-
shipId: integer
ship Id
Root Schema : Update sales for bookable tours
Type:
object
Title:
Show Source
Update sales for bookable tours
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 TypeExample: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 TypeExample: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 TypeExample: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 TypeExample: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
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Bookable Tour Sales
Type:
object
Title:
Bookable Tour Sales
Bookable Tour Sales
Show Source
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
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":"regularSalesPostingDepartmentId",
"message":"is invalid."
}
]
}
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
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