REST API for Oracle Commerce Cloud December 2017

listCancelReasons

get

/ccagent/v1/merchant/orderCancelReasons

List Cancel Reasons. Lists the Cancel Reasons for cancelling an order

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

Properties

items: Type: array items

Additional Properties Allowed:

The list of all Cancel Reasons

Nested Schema : items

Type: array

The list of all Cancel Reasons

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

displayValue: Type: string

Display Name of the cancel reason
Key: Type: string

Display Key of the cancel reason

Example application/json


[
    {
        "displayValue":"Bad product review",
        "key":"badProductReview"
    },
    {
        "displayValue":"Better competitor price",
        "key":"betterCompetitorPrice"
    },
    {
        "displayValue":"Change of mind",
        "key":"changeOfMind"
    },
    {
        "displayValue":"Item available at discount currently",
        "key":"itemAvailableAtDiscountCurrently"
    },
    {
        "displayValue":"No longer needed",
        "key":"noLongerNeeded"
    },
    {
        "displayValue":"No update on shipment status",
        "key":"noUpdateOnShipmentStatus"
    }
]

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:

[
  {
    "displayValue": "Bad product review",
    "key": "badProductReview"
  },
  {
    "displayValue": "Better competitor price",
    "key": "betterCompetitorPrice"
  },
  {
    "displayValue": "Change of mind",
    "key": "changeOfMind"
  },
  {
    "displayValue": "Item available at discount currently",
    "key": "itemAvailableAtDiscountCurrently"
  },
  {
    "displayValue": "No longer needed",
    "key": "noLongerNeeded"
  },
  {
    "displayValue": "No update on shipment status",
    "key": "noUpdateOnShipmentStatus"
  }
]