Documentation
Preparing search index...
utils/SABRE/types/orderCancel
operations
Interface operations
interface
operations
{
cancelOrder
:
{
parameters
:
{
cookie
?:
never
;
header
?:
never
;
path
?:
never
;
query
?:
never
;
}
;
requestBody
:
{
content
:
{
"application/json"
:
{
diagnostics
?:
(
|
"ORDER_VIEW_REQUEST"
|
"ORDER_VIEW_RESPONSE"
|
"OFFER_STORE_ID_REQUEST"
|
"OFFER_STORE_ID_RESPONSE"
|
"OFFER_STORE_PUT_REQUEST"
|
"OFFER_STORE_PUT_RESPONSE"
|
"NDCC_ORDER_RESHOP_REQUEST"
|
"NDCC_ORDER_RESHOP_RESPONSE"
|
"ESSM_RESPONSE"
|
"ESSM_TJR_REQUEST"
|
"ESSM_TJR_RESPONSE"
|
"ESSM_JWT_REQUEST"
|
"ESSM_JWT_RESPONSE"
|
"SPR_REQUEST"
|
"SPR_RESPONSE"
)
[]
;
payloadAttributes
?:
{
baseline
?:
string
;
echoToken
?:
string
;
host
?:
string
;
timeStamp
?:
string
;
trxId
?:
string
;
version
?:
string
;
}
;
request
:
{
orderId
:
string
}
;
}
;
}
;
}
;
responses
:
{
"200"
:
{
content
:
{
"application/json"
:
{
diagnostics
?:
{
body
?:
string
;
customId
?:
string
;
headers
?:
{
[
key
:
string
]:
string
}
;
name
?:
|
"ORDER_VIEW_REQUEST"
|
"ORDER_VIEW_RESPONSE"
|
"OFFER_STORE_ID_REQUEST"
|
"OFFER_STORE_ID_RESPONSE"
|
"OFFER_STORE_PUT_REQUEST"
|
"OFFER_STORE_PUT_RESPONSE"
|
"NDCC_ORDER_RESHOP_REQUEST"
|
"NDCC_ORDER_RESHOP_RESPONSE"
|
"ESSM_RESPONSE"
|
"ESSM_TJR_REQUEST"
|
"ESSM_TJR_RESPONSE"
|
"ESSM_JWT_REQUEST"
|
"ESSM_JWT_RESPONSE"
|
"SPR_REQUEST"
|
"SPR_RESPONSE"
;
}
[]
;
errors
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
payloadAttributes
?:
{
baseline
?:
string
;
echoToken
?:
string
;
host
?:
string
;
timeStamp
?:
string
;
trxId
?:
string
;
version
?:
string
;
}
;
response
:
{
reshopOffers
?:
{
offerExpirationDateTime
?:
string
;
offerId
:
string
;
offerItems
?:
{
differentialAmountDue
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
mandatoryInd
?:
boolean
;
newOfferItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
offerItemId
?:
string
;
originalOrderItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
penaltyDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
}
[]
;
offerType
?:
"VOID"
|
"REFUND"
;
ownerCode
:
string
;
}
[]
;
warnings
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
}
;
}
;
}
;
headers
:
{
[
name
:
string
]:
unknown
}
;
}
;
"400"
:
{
content
:
{
"application/json"
:
{
diagnostics
?:
{
body
?:
string
;
customId
?:
string
;
headers
?:
{
[
key
:
string
]:
string
}
;
name
?:
|
"ORDER_VIEW_REQUEST"
|
"ORDER_VIEW_RESPONSE"
|
"OFFER_STORE_ID_REQUEST"
|
"OFFER_STORE_ID_RESPONSE"
|
"OFFER_STORE_PUT_REQUEST"
|
"OFFER_STORE_PUT_RESPONSE"
|
"NDCC_ORDER_RESHOP_REQUEST"
|
"NDCC_ORDER_RESHOP_RESPONSE"
|
"ESSM_RESPONSE"
|
"ESSM_TJR_REQUEST"
|
"ESSM_TJR_RESPONSE"
|
"ESSM_JWT_REQUEST"
|
"ESSM_JWT_RESPONSE"
|
"SPR_REQUEST"
|
"SPR_RESPONSE"
;
}
[]
;
errors
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
payloadAttributes
?:
{
baseline
?:
string
;
echoToken
?:
string
;
host
?:
string
;
timeStamp
?:
string
;
trxId
?:
string
;
version
?:
string
;
}
;
response
:
{
reshopOffers
?:
{
offerExpirationDateTime
?:
string
;
offerId
:
string
;
offerItems
?:
{
differentialAmountDue
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
mandatoryInd
?:
boolean
;
newOfferItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
offerItemId
?:
string
;
originalOrderItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
penaltyDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
}
[]
;
offerType
?:
"VOID"
|
"REFUND"
;
ownerCode
:
string
;
}
[]
;
warnings
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
}
;
}
;
}
;
headers
:
{
[
name
:
string
]:
unknown
}
;
}
;
"500"
:
{
content
:
{
"application/json"
:
{
diagnostics
?:
{
body
?:
string
;
customId
?:
string
;
headers
?:
{
[
key
:
string
]:
string
}
;
name
?:
|
"ORDER_VIEW_REQUEST"
|
"ORDER_VIEW_RESPONSE"
|
"OFFER_STORE_ID_REQUEST"
|
"OFFER_STORE_ID_RESPONSE"
|
"OFFER_STORE_PUT_REQUEST"
|
"OFFER_STORE_PUT_RESPONSE"
|
"NDCC_ORDER_RESHOP_REQUEST"
|
"NDCC_ORDER_RESHOP_RESPONSE"
|
"ESSM_RESPONSE"
|
"ESSM_TJR_REQUEST"
|
"ESSM_TJR_RESPONSE"
|
"ESSM_JWT_REQUEST"
|
"ESSM_JWT_RESPONSE"
|
"SPR_REQUEST"
|
"SPR_RESPONSE"
;
}
[]
;
errors
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
payloadAttributes
?:
{
baseline
?:
string
;
echoToken
?:
string
;
host
?:
string
;
timeStamp
?:
string
;
trxId
?:
string
;
version
?:
string
;
}
;
response
:
{
reshopOffers
?:
{
offerExpirationDateTime
?:
string
;
offerId
:
string
;
offerItems
?:
{
differentialAmountDue
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
mandatoryInd
?:
boolean
;
newOfferItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
offerItemId
?:
string
;
originalOrderItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
penaltyDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
}
[]
;
offerType
?:
"VOID"
|
"REFUND"
;
ownerCode
:
string
;
}
[]
;
warnings
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
}
;
}
;
}
;
headers
:
{
[
name
:
string
]:
unknown
}
;
}
;
}
;
}
;
}
Index
Properties
cancel
Order
Properties
cancel
Order
cancelOrder
:
{
parameters
:
{
cookie
?:
never
;
header
?:
never
;
path
?:
never
;
query
?:
never
;
}
;
requestBody
:
{
content
:
{
"application/json"
:
{
diagnostics
?:
(
|
"ORDER_VIEW_REQUEST"
|
"ORDER_VIEW_RESPONSE"
|
"OFFER_STORE_ID_REQUEST"
|
"OFFER_STORE_ID_RESPONSE"
|
"OFFER_STORE_PUT_REQUEST"
|
"OFFER_STORE_PUT_RESPONSE"
|
"NDCC_ORDER_RESHOP_REQUEST"
|
"NDCC_ORDER_RESHOP_RESPONSE"
|
"ESSM_RESPONSE"
|
"ESSM_TJR_REQUEST"
|
"ESSM_TJR_RESPONSE"
|
"ESSM_JWT_REQUEST"
|
"ESSM_JWT_RESPONSE"
|
"SPR_REQUEST"
|
"SPR_RESPONSE"
)
[]
;
payloadAttributes
?:
{
baseline
?:
string
;
echoToken
?:
string
;
host
?:
string
;
timeStamp
?:
string
;
trxId
?:
string
;
version
?:
string
;
}
;
request
:
{
orderId
:
string
}
;
}
;
}
;
}
;
responses
:
{
"200"
:
{
content
:
{
"application/json"
:
{
diagnostics
?:
{
body
?:
string
;
customId
?:
string
;
headers
?:
{
[
key
:
string
]:
string
}
;
name
?:
|
"ORDER_VIEW_REQUEST"
|
"ORDER_VIEW_RESPONSE"
|
"OFFER_STORE_ID_REQUEST"
|
"OFFER_STORE_ID_RESPONSE"
|
"OFFER_STORE_PUT_REQUEST"
|
"OFFER_STORE_PUT_RESPONSE"
|
"NDCC_ORDER_RESHOP_REQUEST"
|
"NDCC_ORDER_RESHOP_RESPONSE"
|
"ESSM_RESPONSE"
|
"ESSM_TJR_REQUEST"
|
"ESSM_TJR_RESPONSE"
|
"ESSM_JWT_REQUEST"
|
"ESSM_JWT_RESPONSE"
|
"SPR_REQUEST"
|
"SPR_RESPONSE"
;
}
[]
;
errors
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
payloadAttributes
?:
{
baseline
?:
string
;
echoToken
?:
string
;
host
?:
string
;
timeStamp
?:
string
;
trxId
?:
string
;
version
?:
string
;
}
;
response
:
{
reshopOffers
?:
{
offerExpirationDateTime
?:
string
;
offerId
:
string
;
offerItems
?:
{
differentialAmountDue
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
mandatoryInd
?:
boolean
;
newOfferItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
offerItemId
?:
string
;
originalOrderItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
penaltyDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
}
[]
;
offerType
?:
"VOID"
|
"REFUND"
;
ownerCode
:
string
;
}
[]
;
warnings
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
}
;
}
;
}
;
headers
:
{
[
name
:
string
]:
unknown
}
;
}
;
"400"
:
{
content
:
{
"application/json"
:
{
diagnostics
?:
{
body
?:
string
;
customId
?:
string
;
headers
?:
{
[
key
:
string
]:
string
}
;
name
?:
|
"ORDER_VIEW_REQUEST"
|
"ORDER_VIEW_RESPONSE"
|
"OFFER_STORE_ID_REQUEST"
|
"OFFER_STORE_ID_RESPONSE"
|
"OFFER_STORE_PUT_REQUEST"
|
"OFFER_STORE_PUT_RESPONSE"
|
"NDCC_ORDER_RESHOP_REQUEST"
|
"NDCC_ORDER_RESHOP_RESPONSE"
|
"ESSM_RESPONSE"
|
"ESSM_TJR_REQUEST"
|
"ESSM_TJR_RESPONSE"
|
"ESSM_JWT_REQUEST"
|
"ESSM_JWT_RESPONSE"
|
"SPR_REQUEST"
|
"SPR_RESPONSE"
;
}
[]
;
errors
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
payloadAttributes
?:
{
baseline
?:
string
;
echoToken
?:
string
;
host
?:
string
;
timeStamp
?:
string
;
trxId
?:
string
;
version
?:
string
;
}
;
response
:
{
reshopOffers
?:
{
offerExpirationDateTime
?:
string
;
offerId
:
string
;
offerItems
?:
{
differentialAmountDue
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
mandatoryInd
?:
boolean
;
newOfferItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
offerItemId
?:
string
;
originalOrderItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
penaltyDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
}
[]
;
offerType
?:
"VOID"
|
"REFUND"
;
ownerCode
:
string
;
}
[]
;
warnings
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
}
;
}
;
}
;
headers
:
{
[
name
:
string
]:
unknown
}
;
}
;
"500"
:
{
content
:
{
"application/json"
:
{
diagnostics
?:
{
body
?:
string
;
customId
?:
string
;
headers
?:
{
[
key
:
string
]:
string
}
;
name
?:
|
"ORDER_VIEW_REQUEST"
|
"ORDER_VIEW_RESPONSE"
|
"OFFER_STORE_ID_REQUEST"
|
"OFFER_STORE_ID_RESPONSE"
|
"OFFER_STORE_PUT_REQUEST"
|
"OFFER_STORE_PUT_RESPONSE"
|
"NDCC_ORDER_RESHOP_REQUEST"
|
"NDCC_ORDER_RESHOP_RESPONSE"
|
"ESSM_RESPONSE"
|
"ESSM_TJR_REQUEST"
|
"ESSM_TJR_RESPONSE"
|
"ESSM_JWT_REQUEST"
|
"ESSM_JWT_RESPONSE"
|
"SPR_REQUEST"
|
"SPR_RESPONSE"
;
}
[]
;
errors
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
payloadAttributes
?:
{
baseline
?:
string
;
echoToken
?:
string
;
host
?:
string
;
timeStamp
?:
string
;
trxId
?:
string
;
version
?:
string
;
}
;
response
:
{
reshopOffers
?:
{
offerExpirationDateTime
?:
string
;
offerId
:
string
;
offerItems
?:
{
differentialAmountDue
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
mandatoryInd
?:
boolean
;
newOfferItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
offerItemId
?:
string
;
originalOrderItemDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
penaltyDifferential
?:
{
amount
:
...
;
taxSummary
?:
...
}
;
}
[]
;
offerType
?:
"VOID"
|
"REFUND"
;
ownerCode
:
string
;
}
[]
;
warnings
?:
{
code
?:
string
;
message
?:
string
;
service
?:
string
}
[]
;
}
;
}
;
}
;
headers
:
{
[
name
:
string
]:
unknown
}
;
}
;
}
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
cancel
Order
Documentation
Loading...