REST API for Oracle Commerce Cloud December 2017

getReturnStates

get

/ccagent/v1/merchant/returnStates

Get Return States. Lists the Order States when Return action will be allowed against orders

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 : getReturnStates_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of all states of a Return Request.

Nested Schema : items

Type: array

The list of all states of a Return Request.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

displayKey: Type: string

Display Key of the state of a Return Request
displayName: Type: string

Display Name of the state of a Return Request

Example application/json


[
    {
        "displayKey":"PENDING_CUSTOMER_ACTION",
        "displayName":"Approved"
    },
    {
        "displayKey":"COMPLETE",
        "displayName":"Complete"
    },
    {
        "displayKey":"FULL_RETURN",
        "displayName":"Full return"
    },
    {
        "displayKey":"PARTIAL_RETURN",
        "displayName":"Partial return"
    },
    {
        "displayKey":"PENDING_REFUND",
        "displayName":"Pending Refund"
    }
]

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": "PENDING_CUSTOMER_ACTION",
    "displayName": "Approved"
  },
  {
    "displayKey": "COMPLETE",
    "displayName": "Complete"
  },
  {
    "displayKey": "FULL_RETURN",
    "displayName": "Full return"
  },
  {
    "displayKey": "PARTIAL_RETURN",
    "displayName": "Partial return"
  },
  {
    "displayKey": "PENDING_REFUND",
    "displayName": "Pending Refund"
  }
]