The Order Appeasement Notification is triggered when an appeasement is created for an order. It provides similar information to that returned by Appeasement API responses.
Notification Parameters
The basic information that return notifications provide is outlined below, though some notifications may include an additional parameter to provide details specific to that step of the return process. These cases are noted above the relevant example below.
| Field | Type | Description |
| eventTypeID | string | Always shown as ’create_appeasement.’ |
| orderID | integer | The identifier of the order the return is being created on |
| externalOrderID | string | Client-generated unique identifier for the Order sent to Kibo |
| orderAppeasementID | integer | A unique identifier for the appeasement. |
| creditPayee | enum | The entity who will pay for the credit (KIBO, SHOPATRON, MANUFACTURER, or RETAILER). |
| creditAmount | number | The amount to be credited. |
| creditDescription | string | The reason for the credit. |
| creditCreationTimestamp | string | The creation time of the credit. Supports date-time format. |
| scope | object | Contains the mfgID, catalogID, and fulfillerID that the order belongs to. |
The following example shows what a standard appeasement notification may look like.
{
"eventTypeID":"create_appeasement",
"orderID":"0123456",
"externalOrderID":"TestOrder-822",
"orderAppeasementID": 00000,
"creditPayee": "MANUFACTURER",
"creditAmount": 1,
"creditDescription": "No Inventory",
"creditCreationTimestamp": "2017-08-24T22:40:42+00:00",
"scope":{
"mfgID":"11111",
"catalogID":"0",
"fulfillerID":"22222"
}
}