REST API for Oracle Commerce Cloud December 2017

getReasons

get

/ccadmin/v1/reasons

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

Request

Supported Media Types

application/json

Query Parameters

type: Type: string

Required: true

type of the reason valid values are cancelReasons, priceOverrideReasons, returnReasons and returnItemDisposition

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getReasons_response

Properties

Example 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

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 Response Payload returned by endpoint:

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