REST API for Oracle Commerce Cloud December 2017

checkRequiresApproval

post

/ccagent/v1/orders/checkRequiresApproval

Check Requires Approval. Check for an order if it requires an approval or not. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.

Request

Supported Media Types

application/json

Header Parameters

X-CCOrganization: Type: string

the organization Id in which order should be created
X-CCSite: Type: string

the site Id in which order should be created

Body Parameter

Root Schema : checkRequiresApproval_request

Example


{
    "orderId":"o30411"
}

Properties

orderId: Type: string

Required: true

the order id for the order which is to be checked for approval requirement.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : checkRequiresApproval_response

Properties

requiresApproval: Type: boolean

True if order requires approval else False.

Example application/json


{
    "requiresApproval":"True",
    "requireApprovalReasons":"Order is pending approval because total is greater than the approved order limit."
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |100094|Organization passed in the header is currently inactive| |100095|The order or return request does not belong to the current organization of the shopper profile| |100096|The organization associated to the order or return request was deleted / does not exist| |100097|The organization associated to the order or return request is currently inactive| |100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization| |100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization| |100101|The shopper profile does not belong to organization passed in the header|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: 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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{"orderId": "o30411"}

Sample Response Payload returned by endpoint:

{
  "requiresApproval": "True",
  "requireApprovalReasons": "Order is pending approval because total is greater than the approved order limit."
}