1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Agent
  4. Appeasement

updateAppeasement

put

/ccagent/v1/appeasements/{id}

Updates an Appeasement.

Request

Supported Media Types
Path Parameters
  • ID corresponding to the appeasement to be updated.
Header Parameters
Body ()
Root Schema : updateAppeasement_request
Type: object
Show Source
Example:
{
    "reason":"incorrectItem",
    "agentId":"service",
    "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
    "comments":[
        {
            "agentId":"AgentBob",
            "comment":"Appeasement to be settled on priority. Valued customer.",
            "id":100001,
            "creationDate":"2020-03-20T04:56:13.935Z"
        },
        {
            "agentId":"AgentBob",
            "comment":"Appeasement settled",
            "creationDate":"2020-04-20T04:56:13.935Z"
        }
    ],
    "orderId":"o1234",
    "appeasementRefunds":[
        {
            "paymentGroupId":"pg1001",
            "refundType":"externalRefund",
            "amount":20,
            "id":"ar1234",
            "state":"COMPLETE",
            "currencyCode":"USD"
        }
    ],
    "profileId":"se-570031",
    "state":"SUBMITTED",
    "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
Nested Schema : comments
Type: array
Array of comments given on an appeasement.
Show Source
Nested Schema : items
Type: object
Properties of the appeasement refund.
Show Source
  • Appeasement refund amount to be given to the customer.
  • Currency code for the appeasement refund amount.
  • Id of the Appeasement refund to be updated. If not provided, a new appeasement refund will be created, removing unmatched refund(s).
  • Payment group id associated to order, to which appeasement is to be issued. It is a required property for out-of-the-box refund type.
  • Type of appeasement refund, among the predefined appeasement refund types.
  • Current state of the appeasement refund. It is among the predefined appeasement refund states. By default, it is "INCOMPLETE".
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 : updateAppeasement_response
Type: object
Show Source
Example:
{
    "reason":"incorrectItem",
    "agentId":"service",
    "notes":"Providing an appeasement of 20 USD which is 20% of the Order Total, according to the appeasement policy.",
    "comments":[
        {
            "agentId":"AgentBob",
            "comment":"Appeasement to be settled on priority. Valued customer.",
            "id":100001,
            "creationDate":"2020-03-20T04:56:13.935Z"
        },
        {
            "agentId":"AgentBob",
            "comment":"Appeasement settled",
            "id":100010,
            "creationDate":"2020-04-20T04:56:13.935Z"
        }
    ],
    "orderId":"o1234",
    "appeasementRefunds":[
        {
            "paymentGroupId":"pg1001",
            "amount":20,
            "id":"ar1234",
            "state":"COMPLETE",
            "type":"externalRefund",
            "currencyCode":"USD"
        }
    ],
    "lastModifiedDate":"2020-03-20T05:15:05.645Z",
    "type":"order",
    "creationDate":"2020-03-20T04:56:13.935Z",
    "submittedDate":"2020-04-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 : 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