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
- application/json
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request. E.g., en,de,fr_CA.
-
X-CCOrganization(optional): string
The organization Id on which the appeasement is being submitted.
-
X-CCSite(optional): string
The site Id on which the appeasement is being submitted.
Root Schema : submitAppeasement_request
Type:
Show Source
object
-
appeasementRefunds(optional):
array appeasementRefunds
Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.
-
comments(optional):
array comments
Array of comments given on an appeasement.
-
id(optional):
string
Appeasement ID of the appeasement to be submitted. Optional. Required in case an existing appeasement needs to be submitted.
-
notes(optional):
string
Notes to describe the appeasement.
-
orderId(optional):
string
Id of the order in SUBMITTED or FULFILLED state, to which appeasement is given. Required when a new order based appeasement is submitted
-
profileId(optional):
string
Id of an registered user, to whom appeasement is given.
-
reason(optional):
string
Reason to create appeasement, among the configured appeasement reason in the system. Required when a new appeasement is submitted.
-
type(optional):
string
Type of appeasement, among the configured appeasement type in the system.
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
-
Array of:
object 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
-
Array of:
object items
Properties of the comments
Nested Schema : items
Type:
object
Properties of the appeasement refund. Required in case a new appeasement needs to be submitted.
Show Source
-
amount(optional):
number
Appeasement refund amount to be given to the customer. Required for OOTB refunds.
-
currencyCode(optional):
string
Curency code in which the amount should be refunded. Required when refund is not related to a payment group.
-
id(optional):
string
Id of the Appeasement refund to be updated, in case an existing appeasement is being updated.
-
paymentGroupId(optional):
string
Payment group id of the refund type. Required for OOTB refunds.
-
refundType:
string
Type of appeasement refund, among the predefined appeasement refund types.
Nested Schema : items
Type:
object
Properties of the comments
Show Source
-
comment:
string
Comment text.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : submitAppeasement_response
Type:
Show Source
object
-
agentId(optional):
string
Id of the agent who created the appeasement.
-
appeasementRefunds(optional):
array appeasementRefunds
Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.
-
comments(optional):
array comments
Array of comments given on an appeasement.
-
creationDate(optional):
string
Date and timestamp when the appeseasement is created.
-
id(optional):
string
Id of the appeasement.
-
lastModifiedDate(optional):
string
Date and timestamp when the appeseasement is modified recently.
-
notes(optional):
string
Notes to describe the appeasement.
-
orderId(optional):
string
Id of the order in SUBMITTED or FULFILLED state, to which appeasement is given.
-
originOfAppeasement(optional):
string
Origin of appeasement signifies the channel of appeasement created.
-
profileId(optional):
string
Id of an registered user, to whom appeasement is given.
-
reason(optional):
string
appeasement reason
-
state(optional):
string
Current state of the appeasement. It is among the predefined appeasement states.
-
submittedDate(optional):
string
Date and timestamp when the appeseasement is submitted
-
type(optional):
string
appeasement type
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
-
Array of:
object items
Properties of the appeasemen refund.
Nested Schema : comments
Type:
array
Array of comments given on an appeasement.
Show Source
-
Array of:
object items
Properties of the comments
Nested Schema : items
Type:
object
Properties of the appeasemen refund.
Show Source
-
amount(optional):
number
Appeasement refund amount issued to the customer.
-
currencyCode(optional):
string
Currency code for the appeasement refund amount.
-
id(optional):
string
Id of the Appeasement refund associated to an appeasement.
-
paymentGroupId(optional):
string
Current state of the appeasement refund. It is among the predefined appeasement refund states.
-
refundType(optional):
string
Type of appeasement refund, among the predefined appeasement refund types.
-
state(optional):
string
Current state of the appeasement refund. It is among the predefined appeasement refund states.
Nested Schema : items
Type:
object
Properties of the comments
Show Source
-
agentId(optional):
string
Agent who saved the comment.
-
comment(optional):
string
Comment text.
-
creationDate(optional):
string
Date and timestamp of the comment.
-
id(optional):
string
Id of the comment associated to the appeasement.
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|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code