The Get Appeasement API retrieves information about an appeasement. The request requires for the appeasement to be in existence, so the Create Appeasement API must have been called first.
The data returned by this request is the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.
| Production URL | https://{tenantId}-translation.mozu.com/api/v2/orderAppeasement/{orderAppeasementID} |
| Sandbox URL | https://{tenantId}-translation.sandbox.mozu.com/api/v2/orderAppeasement/{orderAppeasementID} |
| Supported Formats | JSON |
| HTTP Method | GET |
Example
The Get Appeasement API call requires only one additional piece of data: the Appeasement ID that was generated when the order was placed with the Create Appeasement API. Otherwise, it is a standard GET call as defined with the above table. In this example, the appeasement included these particular properties:
- $1 refund
- Payee – Manufacturer
- Reason – Lack of inventory
General Information
The response only returns one block of general information about the appeasement, not a deep dive into the order. Besides the three key properties mentioned above, the other elements include:
- Order ID
- External Order ID
- Credit Creation Timestamp
- Manufacturer ID
- Catalog ID
The Full Request
Using the URL format as outlined above, the entire call is simple to put together. This will return all of the information for the payment with the above example ID.
https://{tenantId}-translation.mozu.com/api/v2/orderAppeasement/00000The Full Response
This is the full response returned by the API.
{
"orderAppeasementID": 00000,
"orderID": 1234567,
"externalOrderID": "Order_XX_111_222333444",
"creditPayee": "MANUFACTURER",
"creditAmount": 1,
"creditDescription": "No Inventory",
"creditCreationTimestamp": "2017-08-24T22:40:42+00:00",
"manufacturerID": 55555,
"catalogID": 0
}