REST API for Oracle Commerce Cloud December 2017

createReason

post

/ccadmin/v1/reasons

Create Reason. Create the reason of given type with the given data.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : createReason_request

Example


[
    "POST /ccadmin/v1/reasons?type=returnItemDisposition",
    {
        "readableDescription":"accepted",
        "active":false,
        "description":"accepted",
        "updateInventory":true
    }
]

Properties

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

Properties

Example application/json


[
    {
        "readableDescription":"accepted",
        "description":"accepted",
        "active":false,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadmin/v1/reasons?type=returnItemDisposition"
            }
        ],
        "id":"200001"
    }
]

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| |------------------|------------------| |200217|Error while validating the input reason json| |200211|Error while creating the reason| |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 Request:

[
  "POST /ccadmin/v1/reasons?type=returnItemDisposition",
  {
    "readableDescription": "accepted",
    "active": false,
    "description": "accepted",
    "updateInventory": true
  }
]

Sample Response Payload returned by endpoint:

[{
  "readableDescription": "accepted",
  "description": "accepted",
  "active": false,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadmin/v1/reasons?type=returnItemDisposition"
  }],
  "id": "200001"
}]