createAppeasement
post
/ccadmin/v1/appeasements
Create Appeasement. Creates a new appeasement.
Request
Supported Media Types
- application/json
Root Schema : createAppeasement_request
Type:
Show Source
object-
agentId:
string
Id of the agent who is creating appeasement. It is an optional property.
-
appeasementRefunds:
array appeasementRefunds
Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.
-
comments:
array comments
Array of comments given on an appeasement.
-
creationDate:
string
Date and timestamp when the appeseasement is created.
-
id:
string
Appeasement ID of the appeasement to be created. By default, a system generated appeasement id will be considered, if not provided explicitly.
-
notes:
string
Notes to describe the appeasement.
-
orderId:
string
Id of the order, to which appeasement is associated. OrderId is required only in case of certain appeaesement types which are configured to mandate order as required.
-
originOfAppeasement:
string
Origin of appeasement signifies the channel of appeasement creation. By default, it is "external".
-
profileId:
string
Id of the user, to whom appeasement is given. It can be any valid string.
-
reason(required):
string
Reason to create appeasement, among the configured appeasement reason in the system.
-
state:
string
Current state of the appeasement. It is among the predefined appeasement states. By default, it is "INCOMPLETE".
-
type(required):
string
Type of appeasement, among the configured appeasement type in the system.
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.",
"creationDate":"2020-03-20T04:56:13.935Z"
}
],
"orderId":"o1234",
"appeasementRefunds":[
{
"paymentGroupId":"pg1001",
"refundType":"externalRefund",
"amount":20,
"id":"ar1234",
"state":"COMPLETE",
"currencyCode":"USD"
}
],
"profileId":"se-570031",
"id":"app1234",
"state":"SUBMITTED",
"type":"order"
}Nested Schema : appeasementRefunds
Type:
arrayArray 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.
Nested Schema : comments
Type:
arrayArray of comments given on an appeasement.
Show Source
-
Array of:
object items
Properties of the comments
Nested Schema : items
Type:
objectProperties of the appeasement refund.
Show Source
-
amount:
number
Appeasement refund amount to be given to the customer.
-
currencyCode:
string
Currency code for the appeasement refund amount.
-
id:
string
Id of the Appeasement refund to be created. By default, a system generated id will be considered, if not provided explicitly.
-
paymentGroupId:
string
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.
-
refundType(required):
string
Type of appeasement refund, among the predefined appeasement refund types.
-
state:
string
Current state of the appeasement refund. It is among the predefined appeasement refund states. By default, it is "INCOMPLETE".
Nested Schema : items
Type:
objectProperties of the comments
Show Source
-
agentId:
string
Agent who saved the comment.
-
comment(required):
string
Comment text.
-
creationDate:
string
Date and timestamp of the comment. If creation date is not provided in the input, system date will be considered by default.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createAppeasement_response
Type:
Show Source
object-
agentId:
string
Id of the agent who created the appeasement.
-
appeasementRefunds:
array appeasementRefunds
Array of appeasement Refunds represents the list of payment instrument details that we want to use for giving the appeasement.
-
comments:
array comments
Array of comments given on an appeasement.
-
creationDate:
string
Date and timestamp when the appeseasement is created.
-
id:
string
Id of the appeasement.
-
lastModifiedDate:
string
Date and timestamp when the appeseasement is modified recently.
-
notes:
string
Notes to describe the appeasement.
-
orderId:
string
Id of the order, to which appeasement is given.
-
originOfAppeasement:
string
Origin of appeasement signifies the channel of appeasement created.
-
profileId:
string
Id of the user, to whom appeasement is given.
-
reason:
string
Reason for the appeasement, among the configured appeasement reason in the system.
-
state:
string
Current state of the appeasement. It is among the predefined appeasement states.
-
submittedDate:
string
Date and timestamp when the appeseasement is submitted.
-
type:
string
Type of appeasement, among the configured appeasement type in the system.
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"
}
],
"orderId":"o1234",
"appeasementRefunds":[
{
"paymentGroupId":"pg1001",
"refundType":"externalRefund",
"amount":20,
"id":"ar1234",
"state":"COMPLETE",
"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:
arrayArray 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:
arrayArray of comments given on an appeasement.
Show Source
-
Array of:
object items
Properties of the comments
Nested Schema : items
Type:
objectProperties of the appeasemen refund.
Show Source
-
amount:
number
Appeasement refund amount issued to the customer.
-
currencyCode:
string
Currency code for the appeasement refund amount.
-
id:
string
Id of the Appeasement refund associated to an appeasement.
-
paymentGroupId:
string
Payment group id associated to order, to which appeasement is issued.
-
refundType:
string
Type of appeasement refund, among the predefined appeasement refund types.
-
state:
string
Current state of the appeasement refund. It is among the predefined appeasement refund states.
Nested Schema : items
Type:
objectProperties of the comments
Show Source
-
agentId:
string
Agent who saved the comment.
-
comment:
string
Comment text.
-
creationDate:
string
Date and timestamp of the comment.
-
id:
string
Id of the comment associated to the appeasement.
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.|
|900005|An internal error occured while processing the input request|
|900009|An error for appeasement id duplication.|
|13001|Input validation error.|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code