Check an order requires approval
post
/ccstore/v1/orders/checkRequiresApproval
Checks if the specified order requires approval before it can be submitted.
This tends to be functionality that is used in B2B use cases, for example, where a supervisor needs to approve and order because of a purchase limit.
The endpoint returns a result indicating if the order requires approval and the reason(s) it requires approval.
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCAsset-Language: 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: string
Current organization context of the logged in user
Root Schema : checkRequiresApproval_request
Type:
Show Source
object
-
orderId(required):
string
the order id for the order which is to be checked for approval requirement.
Example:
{
"orderId":"o30411"
}
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : checkRequiresApproval_response
Type:
Show Source
object
-
requireApprovalReasons:
string
The reason why the order has been moved to pending approval
-
requiresApproval:
boolean
True if order requires approval else False.
Example Response (application/json)
{
"requiresApproval":true,
"requireApprovalReasons":"Order is pending approval because total is greater than the approved order limit."
}
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 |
---|---|---|
28358 | Order not found. | Please ensure that valid order ID is specified that the current profile has access to. |
The error response:
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code