getAppeasement

get

/ccadmin/v1/appeasements/{id}

Get Appeasement. Gets the detailed appeasement information based on the appeasement ID provided.

Request

Supported Media Types
Path Parameters
  • ID corresponding to the appeasement to be fetched.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getAppeasement_response
Type: object
Show Source
Example:
{
    "reason":{
        "readableDescription":"Incorrect Item Received",
        "id":"incorrectItem"
    },
    "agentId":"service",
    "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
    "comments":[
        {
            "agentId":"service",
            "comment":"Appeasement to be settled on priority. Valued customer.",
            "id":100001,
            "creationDate":"2020-03-20T04:56:13.935Z"
        }
    ],
    "orderId":"o1234",
    "appeasementRefunds":[
        {
            "amount":20,
            "id":"ar1234",
            "state":"COMPLETE",
            "type":"externalRefund"
        }
    ],
    "lastModifiedDate":"2020-03-20T05:15:05.645Z",
    "type":{
        "displayName":"Order",
        "description":"Appeasement to be applied on a given order",
        "id":"order"
    },
    "creationDate":"2020-03-20T04:56:13.935Z",
    "profileId":"se-570031",
    "id":"app1234",
    "state":"SUBMITTED",
    "originOfAppeasement":"external"
}
Nested Schema : appeasementRefunds
Type: array
Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.
Show Source
Nested Schema : comments
Type: array
Array of comments given on an appeasement.
Show Source
Nested Schema : reason
Type: object
Reason for the appeasement, among the configured appeasement reason in the system.
Show Source
Nested Schema : type
Type: object
Type of appeasement, among the configured appeasement type in the system.
Show Source
Nested Schema : items
Type: object
Properties of the appeasement refund.
Show Source
Nested Schema : items
Type: object
Properties of the comments
Show Source

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| |------------------|------------------| |900001|An internal error occurred.| |900002|No Appeasement found with given appeasement id| |900004|An internal error occured while fetching the appeasement.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top