POST api/salesorder/cancelBookingExt
Request Information
URI Parameters
None.
Body Parameters
CancellationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| BookingId | integer |
None. |
|
| SalesOrderId | integer |
None. |
|
| User | User |
None. |
|
| CancelDespiteOfInternalCancellationPolicies | boolean |
None. |
|
| CancelAnyway | boolean |
None. |
|
| CancelBypassType | BypassViolationTransactionTypes |
None. |
|
| Reason | string |
None. |
|
| SalesChannelId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"bookingId": 1,
"salesOrderId": 1,
"user": {
"id": 1,
"name": "sample string 2",
"customerInfo": {
"customerName": "sample string 1",
"customerEmail": "sample string 2",
"customerPhoneNumber": "sample string 3"
}
},
"cancelDespiteOfInternalCancellationPolicies": true,
"cancelAnyway": true,
"cancelBypassType": 0,
"reason": "sample string 4",
"salesChannelId": 1
}
Response Information
Resource Description
CancellationResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| CancelledAnyWay | boolean |
None. |
|
| ErrorCode | CancellationErrorCodes |
None. |
|
| THErrorCode | THErrorCodes |
None. |
|
| ErrorMessage | string |
None. |
|
| NonRefundableProducts | Collection of ProductSO |
None. |
Response Formats
application/json, text/json
Sample:
{
"success": true,
"cancelledAnyWay": true,
"errorCode": 0,
"thErrorCode": 0,
"errorMessage": "sample string 3",
"nonRefundableProducts": [
{
"productId": 1,
"attractionId": 2,
"productName": "sample string 3",
"translationId": 1,
"isCapacityProduct": true,
"accountId": 5,
"validTimeInMinutes": 1,
"status": 0,
"capacityResourceId": 1,
"showUnitIds": [
"sample string 1",
"sample string 2"
],
"printBarcode": true,
"doNotPrintTicket": true,
"productHandlingType": 0,
"productConfigurationId": 1,
"printTicketInfo": "sample string 8",
"isRefundable": true,
"packageTimeslotGroupId": 1,
"cancellationPolicyId": 1,
"saleCutoffTimePolicyId": 1,
"cancellationPolicyForAllAdministration": true,
"saleCutoffTimePolicyForAllAdministration": true,
"productDetails": [
{
"productDetailId": 1,
"accountId": 2,
"productId": 3,
"cutOffTime": 1,
"rebookCutOffTime": 1,
"kioskMemo": "sample string 4",
"packageTimeslotGroupId": 1,
"cancellationPolicyId": 1,
"defaultPickupLocationId": 1,
"saleCutoffTimePolicyId": 1
},
{
"productDetailId": 1,
"accountId": 2,
"productId": 3,
"cutOffTime": 1,
"rebookCutOffTime": 1,
"kioskMemo": "sample string 4",
"packageTimeslotGroupId": 1,
"cancellationPolicyId": 1,
"defaultPickupLocationId": 1,
"saleCutoffTimePolicyId": 1
}
],
"productConfiguration": {
"productConfigurationId": 1,
"description": "sample string 2",
"externalCapacityResourceId": "sample string 3",
"capacityProviderId": 4,
"externalCacheEnabled": true,
"externalCacheReloadInterval": 1,
"externalCacheDays": 1,
"loadExternalRetailPrices": true,
"autoUpLoadExternalRetailPrices": true,
"externalPricesRefreshInterval": 1,
"retailPricesDifferenceTreshold": 1.0,
"doNotBookOverInternalTotalCapacity": true,
"productConfigurationDetails": [
{
"productConfigurationDetailId": 1,
"productConfigurationId": 2,
"ticketCategoryId": 3,
"externalTicketCategoryId": "sample string 4",
"externalPrice": 1.0,
"currency": "sample string 5"
},
{
"productConfigurationDetailId": 1,
"productConfigurationId": 2,
"ticketCategoryId": 3,
"externalTicketCategoryId": "sample string 4",
"externalPrice": 1.0,
"currency": "sample string 5"
}
]
},
"externalId": "sample string 12"
},
{
"productId": 1,
"attractionId": 2,
"productName": "sample string 3",
"translationId": 1,
"isCapacityProduct": true,
"accountId": 5,
"validTimeInMinutes": 1,
"status": 0,
"capacityResourceId": 1,
"showUnitIds": [
"sample string 1",
"sample string 2"
],
"printBarcode": true,
"doNotPrintTicket": true,
"productHandlingType": 0,
"productConfigurationId": 1,
"printTicketInfo": "sample string 8",
"isRefundable": true,
"packageTimeslotGroupId": 1,
"cancellationPolicyId": 1,
"saleCutoffTimePolicyId": 1,
"cancellationPolicyForAllAdministration": true,
"saleCutoffTimePolicyForAllAdministration": true,
"productDetails": [
{
"productDetailId": 1,
"accountId": 2,
"productId": 3,
"cutOffTime": 1,
"rebookCutOffTime": 1,
"kioskMemo": "sample string 4",
"packageTimeslotGroupId": 1,
"cancellationPolicyId": 1,
"defaultPickupLocationId": 1,
"saleCutoffTimePolicyId": 1
},
{
"productDetailId": 1,
"accountId": 2,
"productId": 3,
"cutOffTime": 1,
"rebookCutOffTime": 1,
"kioskMemo": "sample string 4",
"packageTimeslotGroupId": 1,
"cancellationPolicyId": 1,
"defaultPickupLocationId": 1,
"saleCutoffTimePolicyId": 1
}
],
"productConfiguration": {
"productConfigurationId": 1,
"description": "sample string 2",
"externalCapacityResourceId": "sample string 3",
"capacityProviderId": 4,
"externalCacheEnabled": true,
"externalCacheReloadInterval": 1,
"externalCacheDays": 1,
"loadExternalRetailPrices": true,
"autoUpLoadExternalRetailPrices": true,
"externalPricesRefreshInterval": 1,
"retailPricesDifferenceTreshold": 1.0,
"doNotBookOverInternalTotalCapacity": true,
"productConfigurationDetails": [
{
"productConfigurationDetailId": 1,
"productConfigurationId": 2,
"ticketCategoryId": 3,
"externalTicketCategoryId": "sample string 4",
"externalPrice": 1.0,
"currency": "sample string 5"
},
{
"productConfigurationDetailId": 1,
"productConfigurationId": 2,
"ticketCategoryId": 3,
"externalTicketCategoryId": "sample string 4",
"externalPrice": 1.0,
"currency": "sample string 5"
}
]
},
"externalId": "sample string 12"
}
]
}