Create appeasement by order ID
When customer is dissatisfied with their shopping experience, you may want to offer an appeasements amount such as partial refund to keep them happy.
This endpoint is used to create appeasement request by order ID
. Note: If you do not have an order ID, but have an order number, use the order number-based endpoint - POST /orders/order-number/{orderNumber}/actions/create-appeasement.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Path Parameters
24-character system-generated ID. It is returned in the response of Create Order - POST /orders endpoint.
Body
Appeasement request
Merchant-defined source from where the appeasement request was initiated. There are no pre-defined values; possible values are Customer Service Representative (CSR), point-of-sale (POS), etc.
Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.
Order-level appeasement details. At least one order-level or item-level appeasement must be added.
Invoice customer
Item-level appeasements. At least one order-level or item-level appeasement must be added.
Response
Appeasement info
Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service
Total refunded amount
Was this page helpful?