REST API for Oracle Commerce Cloud December 2017

getOrderStates

get

/ccagent/v1/merchant/orderStates

Get Order States. Lists the order States that can be used for searching for 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 : getOrderStates_response

Properties

items: Type: array items

Additional Properties Allowed:

The list of all Order States

Nested Schema : items

Type: array

The list of all Order States

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

displayKey: Type: string

Display Key of the Order State
displayName: Type: string

Display Name of the Order State

Example application/json


[
    {
        "displayKey":"PROCESSING",
        "displayName":"Being processed"
    },
    {
        "displayKey":"NO_PENDING_ACTION",
        "displayName":"Fulfilled"
    },
    {
        "displayKey":"INCOMPLETE",
        "displayName":"Incomplete"
    },
    {
        "displayKey":"PENDING_REMOVE",
        "displayName":"Pending removal"
    },
    {
        "displayKey":"REMOVED",
        "displayName":"Removed"
    },
    {
        "displayKey":"SUBMITTED",
        "displayName":"Submitted to fulfillment"
    }
]

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": "PROCESSING",
    "displayName": "Being processed"
  },
  {
    "displayKey": "NO_PENDING_ACTION",
    "displayName": "Fulfilled"
  },
  {
    "displayKey": "INCOMPLETE",
    "displayName": "Incomplete"
  },
  {
    "displayKey": "PENDING_REMOVE",
    "displayName": "Pending removal"
  },
  {
    "displayKey": "REMOVED",
    "displayName": "Removed"
  },
  {
    "displayKey": "SUBMITTED",
    "displayName": "Submitted to fulfillment"
  }
]