Get valid actions
get
/ccstore/v1/orders/validActions/{id}
Verifies whether the specified order can be cancelled or returned.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
the ID of the order to retrieve.
Header Parameters
-
X-CCAsset-Language(optional): string
Instructs the endpoint to use the specified locale code for content returned in the response. The locale supplied in the header must be supported by your store.
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : getValidActions_response
Type:
Show Source
object
-
cancel(optional):
object cancel
cancel information
-
return(optional):
object return
return information
Nested Schema : cancel
Type:
object
cancel information
Show Source
-
isCancelAllowed(optional):
boolean
returns true if cancel is allowed for the order
-
isInitialValForCancelInFlightPassed(optional):
boolean
returns true if cancel inflight allowed for the order
Nested Schema : return
Type:
object
return information
Show Source
-
isReturnAllowed(optional):
boolean
returns true if return is allowed for the order
Example Response (application/json)
{
"cancel":{
"isInitialValForCancelInFlightPassed":false,
"isCancelAllowed":true
},
"returns":{
"isReturnAllowed":false
}
}
Default Response
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
210105 | Order not found. | Ensure that you enter a valid order ID. |
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