submitCancelOrder
put
/ccagent/v1/orders/submitCancelOrder
This is used to submit the cancel order.
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCAgentContext.shopperProfileId: string
the profile id from which the order was placed
-
X-CCOrganization(optional): string
Current organization context of the logged in user
-
x-ccsite: string
the site id on which the orders needs to be placed
Root Schema : submitCancelOrder_request
Type:
Show Source
object
-
orderId:
string
The cancel order ID for which we want to submit cancel order.
Example:
{
"orderId":"o30411"
}
Response
Supported Media Types
- application/json
200 Response
Following result is returned when operation succeeds.
Root Schema : submitCancelOrder_response
Type:
Show Source
object
-
orderCancelled(optional):
boolean
True if order is cancelled else False
-
orderId(optional):
string
The original order ID which has been cancelled.
Example Response (application/json)
{
"orderCancelled":true,
"orderId":"o10004"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code