REST API for Oracle Commerce Cloud December 2017

getReturnReasons

get

/ccagent/v1/merchant/orderReturnReasons

Get Return Reasons. Lists the Disposition Reasons that can be given while receiving items against a return request

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getReturnReasons_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of all return reasons for return requests

Nested Schema : items

Type: array

The list of all return reasons for return requests

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

displayKey: Type: string

Display Key of the Return Reason
displayName: Type: string

Display Name of the Return Reason

Example application/json


[
    {
        "displayKey":"defective",
        "displayName":"Defective"
    },
    {
        "displayKey":"didNotLike",
        "displayName":"Did Not Like"
    },
    {
        "displayKey":"didNotMeetExpectations",
        "displayName":"Did Not Meet Expectations"
    },
    {
        "displayKey":"incorrectColor",
        "displayName":"Incorrect Color"
    },
    {
        "displayKey":"incorrectItem",
        "displayName":"Incorrect Item"
    },
    {
        "displayKey":"incorrectSize",
        "displayName":"Incorrect Size"
    }
]

Default Response

The error response

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:

[
  {
    "displayKey": "defective",
    "displayName": "Defective"
  },
  {
    "displayKey": "didNotLike",
    "displayName": "Did Not Like"
  },
  {
    "displayKey": "didNotMeetExpectations",
    "displayName": "Did Not Meet Expectations"
  },
  {
    "displayKey": "incorrectColor",
    "displayName": "Incorrect Color"
  },
  {
    "displayKey": "incorrectItem",
    "displayName": "Incorrect Item"
  },
  {
    "displayKey": "incorrectSize",
    "displayName": "Incorrect Size"
  }
]