listAppeasements
get
/ccagent/v1/appeasements
List Appeasements. Get appeasements by the search criteria entered. The search criteria includes appeasement properties and sub-items(appeasementRefunds, profile & order) properties like refund types, amount, first name, email, order state etc. Details are mentioned below in parameter description
Request
Supported Media Types
- application/json
Query Parameters
-
fields(optional): string
This controls which fields are returned in the response body.
-
limit(optional): integer
This is the field to specify the number of records to be fetched per REST call.
-
offset(optional): integer
This field specifies the offset/starting index from which data to be fetched.
-
q: string
Search criteria - Following are the examples to include the respective properties of the item/sub-items of appeasements in the query: |Field|Type|Description| |------------------|------------------|------------------| |type|string|Type of the appeasement| |appeasementRefunds.refundType|string|Type of the appeasement refund| |profile.firstName|string|First name of the profile| |order.state|string|State of the order.| Search criteria in SCIM Format should be as: type eq "order", appeasementRefunds.refundType eq "creditCard", profile.firstName co "kim", order.state ne "INCOMPLETE" etc. All the supported properties can be included in SCIM search criteria. However, few suggestions are: Appeasement properties: type, reason, orderId, profileId, state, agentId etc. Appeasement refund properties: refundType, amount, currencyCode etc. Profile properties: firstName, lastName, email etc. Order properties: state, creationDate etc. Searching with custom properties: Use the custom property name as the search criteria field without any prefix. For example: For a custom property with name as isVipCustomer, use search criteria field as isVipCustomer. Note: SCIM search supports custom properties on item type, and not on its sub-types. e.g. Custom properties created on appeasementRefunds, which will be available to its sub-types like externalAppeasementRefund, creditCardAppeasementRefund etc. can be included in search criteria, whereas custom properties created specific to any of its sub-types should not be included in the search criteria.
-
sort(optional): string
This field specifies the sort order of the list to be fetched.
-
totalResults(optional): boolean
Indicates if the total results should be included in the response.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listAppeasements_response
Type:
Show Source
object
-
items(optional):
array items
Array containing the object representations of appeasements. See getAppeasement for a description of the values of each appeasement.
-
limit(optional):
integer
Limit of number of appeasements.
-
offset(optional):
integer
Numeric offset of the first appeasement item returned.
-
sort(optional):
array sort
An array that specifies the sort order.
-
total(optional):
integer
Total number of appeasements. Deprecated.
-
totalResults(optional):
integer
Total number of appeasements.
Example:
{
"total":1,
"totalResults":1,
"offset":0,
"limit":250,
"sort":[
{
"property":"id",
"order":"asc"
}
],
"items":[
{
"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",
"currencyCode":"USD"
}
],
"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 : items
Type:
array
Array containing the object representations of appeasements. See getAppeasement for a description of the values of each appeasement.
Show Source
Nested Schema : getAppeasement_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 creation.
-
profileId(optional):
string
Id of an registered user, to whom appeasement is given.
-
reason(optional):
object reason
Reason for the appeasement, among the configured appeasement reason in the system.
-
state(optional):
string
Current state of the appeasement. It is among the predefined appeasement states.
-
type(optional):
object type
Type of appeasement, among the configured appeasement type in the system.
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
-
Array of:
object items
Properties of the appeasement 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 : reason
Type:
object
Reason for the appeasement, among the configured appeasement reason in the system.
Show Source
-
id(optional):
string
Id of the appeasement reason.
-
readableDescription(optional):
string
Description of the appeasement reason.
Nested Schema : type
Type:
object
Type of appeasement, among the configured appeasement type in the system.
Show Source
-
description(optional):
string
Description of the appeasement type.
-
displayName(optional):
string
Name of the appeasement type.
-
id(optional):
string
Id of the appeasement type.
Nested Schema : items
Type:
object
Properties of the appeasement refund.
Show Source
-
amount(optional):
number
Appeasement refund amount issued to the customer.
-
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 associated to an appeasement.
-
paymentGroupId(optional):
string
Payment group id of the refund type. Required for OOTB refunds.
-
state(optional):
string
Current state of the appeasement refund. It is among the predefined appeasement refund states.
-
type(optional):
string
Type of appeasement refund, among the predefined appeasement refund types.
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.
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Whether this property should be sorted ascending ("asc") or descending ("dsc").
-
property(optional):
string
The name of the property to use for sorting.
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:
Below is the list of error codes:
|Error Code|Description|
|------------------|------------------|
|85003|Invalid attribute in query|
|900013|Invalid search criteria.|
|900014|An internal error occured while processing the input request|
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