Jump to

• Request
• Response

getReasons

get

/ccadmin/v1/reasons

Get Reasons. Gets the reasons based on the reason type provided. eg. /ccadmin/v1/reasons?type=cancelReasons

Request

Supported Media Types

• application/json

Query Parameters

• type(required): string
  type of the reason valid values are appeasementReason, cancelReasons, priceOverrideReasons, returnReasons and returnItemDisposition

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getReasons_response

Type: object

Show Source

• active: boolean
  Indicates whether reason is enabled or disabled.
• description: string
  Description of the reason.
• id: string
  Id of the reason.
• readableDescription: string
  Name of the reason.

{
    "properties":{
        "readableDescription":{
            "description":"Name of the reason.",
            "type":"string"
        },
        "description":{
            "description":"Description of the reason.",
            "type":"string"
        },
        "active":{
            "description":"Indicates whether reason is enabled or disabled.",
            "type":"boolean"
        },
        "id":{
            "description":"Id of the reason.",
            "type":"string"
        }
    },
    "example":[
        {
            "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"
        }
    ]
}

Example:

[
    {
        "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

• 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

{
    "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: 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

{
    "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