getReasons

get

/ccadmin/v1/reasons

Get Reasons. Gets the reasons based on the reason type provided.

Request

Supported Media Types
Query Parameters
  • type of the reason valid values are cancelReasons, priceOverrideReasons, returnReasons and returnItemDisposition
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getReasons_response
Show Source
Example Response (application/json)
[
    {
        "readableDescription":"Bad product review_updated",
        "active":true,
        "description":"badProductReview",
        "id":"badProductReview"
    },
    {
        "readableDescription":"NewCancelReason_updated_EN",
        "active":true,
        "description":"NewCancelReason",
        "id":"NewCancelReason"
    },
    {
        "readableDescription":"newDescriptionForCancel",
        "active":true,
        "description":"newDescriptionForCancel",
        "id":"100001"
    },
    {
        "readableDescription":"No longer needed",
        "active":true,
        "description":"noLongerNeeded",
        "id":"noLongerNeeded"
    },
    {
        "readableDescription":"No update on shipment status",
        "active":true,
        "description":"noUpdateOnShipmentStatus",
        "id":"noUpdateOnShipmentStatus"
    }
]

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| |------------------|------------------| |200215|Error while retrieving the reasons| |200213|Invalid reason type passed.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top