1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Agent
  4. Appeasement

submitAppeasement

post

/ccagent/v1/appeasements/submit

Submits an Appeasement. Submits an existing appeasement if an Id is provided in the payload. Creates and submits a new appeasement altogether otherwise. Custom properties are supported directly at both appeasement level and each appeasementRefund level.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : submitAppeasement_request
Type: object
Show Source
Example:
{
    "reason":"itemArrivedDamaged",
    "notes":"Customer complained that the order has arrived damaged, and asked for a refund. Providing 15 USD.",
    "comments":[
        {
            "comment":"Appeasement to be settled on priority. Valued customer."
        }
    ],
    "damagedLineItemId":"ci123547",
    "appeasementRefunds":[
        {
            "paymentGroupId":1223434,
            "refundType":"externalRefund",
            "amount":5,
            "customerPreferredGiftCardId":"GC12345",
            "currencyCode":"USD"
        },
        {
            "paymentGroupId":1223434,
            "refundType":"creditCard",
            "amount":10,
            "customerPreferredGiftCardId":"GC12345"
        }
    ],
    "orderId":"o10068",
    "profileId":"se-570031",
    "type":"order"
}
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
  • items
    Properties of the appeasement refund. Required in case a new appeasement needs to be submitted.
Nested Schema : comments
Type: array
Array of comments given on an appeasement.
Show Source
Nested Schema : items
Type: object
Properties of the appeasement refund. Required in case a new appeasement needs to be submitted.
Show Source
Nested Schema : items
Type: object
Properties of the comments
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : submitAppeasement_response
Type: object
Show Source
Example:
{
    "reason":"itemArrivedDamaged",
    "agentId":"service",
    "notes":"Customer complained that the order has arrived damaged, and asked for a refund. Providing 15 USD.",
    "comments":[
        {
            "agentId":"service",
            "comment":"Appeasement to be settled on priority. Valued customer.",
            "id":100001,
            "creationDate":"2020-03-20T04:56:13.935Z"
        }
    ],
    "orderId":"o10068",
    "damagedLineItemId":"ci123547",
    "lastModifiedDate":"2020-04-05T15:52:22.622Z",
    "appeasementRefunds":[
        {
            "paymentGroupId":123556,
            "refundType":"creditCard",
            "amount":5,
            "id":"3200006",
            "state":"INCOMPLETE",
            "currencyCode":"USD"
        },
        {
            "paymentGroupId":123456,
            "refundType":"externalRefund",
            "amount":10,
            "customerPreferredGiftCardId":null,
            "id":"3200007",
            "state":"INCOMPLETE",
            "currencyCode":"USD"
        }
    ],
    "submittedDate":"2020-04-05T15:52:22.622Z",
    "creationDate":"2020-04-05T15:52:22.622Z",
    "type":"order",
    "profileId":"se-570031",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/appeasements/submit"
        }
    ],
    "state":"SUBMITTED",
    "id":"app370003",
    "originOfAppeasement":"agent"
}
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 : items
Type: object
Properties of the appeasemen refund.
Show Source
Nested Schema : items
Type: object
Properties of the comments
Show Source

Default Response

The error response. The following are the error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |900000|When an internal error occurs| |13001|When the input is invalid| |900015|When an internal error occurs with the appeasementValidation webhook| |900016|When the appeasement is invalid according to the appeasementValidation webhook| |900017|When the invalid refundType is passed for an appeasement refund| |900001|If an internal error occurs with the repository| |900002|When the given appeasement Id is invalid or not found| |30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
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