Jump to

• Request
• Response

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(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

Body ()

Root Schema : checkRequiresApproval_request

Type: object

Show Source

• orderId: string
  the order ID for the order which is to be checked for approval requirement.

{
    "properties":{
        "orderId":{
            "description":"the order ID for the order which is to be checked for approval requirement.",
            "type":"string"
        }
    },
    "required":[
        "orderId"
    ],
    "example":{
        "orderId":"o30411"
    }
}

Example:

{
    "orderId":"o30411"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : checkRequiresApproval_response

Type: object

Show Source

• requireApprovalReasons(optional): string
  The reason that order requires approval.
• requiresApproval(optional): boolean
  True if order requires approval else False.

{
    "properties":{
        "requiresApproval":{
            "description":"True if order requires approval else False.",
            "type":"boolean"
        },
        "requireApprovalReasons":{
            "description":"The reason that order requires approval.",
            "type":"string"
        }
    }
}

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:

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:

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top