Skip to main content
POST
/
orders
/
order-number
/
{orderNumber}
/
actions
/
create-appeasement
Create appeasement by order number
curl --request POST \
  --url https://api.fabric.inc/v3/orders/order-number/{orderNumber}/actions/create-appeasement \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "source": "Storefront",
  "userId": "12",
  "appeasements": [
    {
      "amount": 34.56,
      "amountInCurrencies": [
        {
          "currency": "USD",
          "group": "SHOPPER",
          "amount": 123.45
        }
      ],
      "appeasementCounter": 1,
      "attributes": {
        "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
      },
      "invoicedAmount": 34.56,
      "invoicedAmountInCurrencies": [
        {
          "currency": "USD",
          "group": "SHOPPER",
          "amount": 123.45
        }
      ],
      "payments": [
        {
          "paymentCounter": 1,
          "refundAmount": 34.56,
          "refundAmountInCurrencies": [
            {
              "currency": "USD",
              "group": "SHOPPER",
              "amount": 123.45
            }
          ]
        }
      ],
      "reasonCode": "Incorrect Item",
      "refunds": [
        {
          "amount": "-10.",
          "amountInCurrencies": [
            {
              "currency": "USD",
              "group": "SHOPPER",
              "amount": 123.45
            }
          ],
          "name": "Name",
          "type": "ITEM"
        }
      ],
      "source": "CSR",
      "subReasonCode": "Late shipping"
    }
  ],
  "customer": {
    "accountId": "62272e917b12209e68751d94",
    "company": "Demo Inc",
    "email": "[email protected]",
    "employeeId": "62272e917b12209e68751d94",
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    },
    "userId": "62272e917b12209e68751d94"
  },
  "items": [
    {
      "appeasements": [
        {
          "amount": 34.56,
          "amountInCurrencies": [
            {
              "currency": "USD",
              "group": "SHOPPER",
              "amount": 123.45
            }
          ],
          "appeasementCounter": 1,
          "attributes": {
            "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
          },
          "invoicedAmount": 34.56,
          "invoicedAmountInCurrencies": [
            {
              "currency": "USD",
              "group": "SHOPPER",
              "amount": 123.45
            }
          ],
          "payments": [
            {
              "paymentCounter": 1,
              "refundAmount": 34.56,
              "refundAmountInCurrencies": [
                {
                  "currency": "USD",
                  "group": "SHOPPER",
                  "amount": 123.45
                }
              ]
            }
          ],
          "reasonCode": "Incorrect Item",
          "refunds": [
            {
              "amount": "-10.",
              "amountInCurrencies": [
                {
                  "currency": "USD",
                  "group": "SHOPPER",
                  "amount": 123.45
                }
              ],
              "name": "Name",
              "type": "ITEM"
            }
          ],
          "source": "CSR",
          "subReasonCode": "Late shipping"
        }
      ],
      "lineItemId": "d538b1f1-0e45-43c6-bfc6-9666fc1188ca"
    }
  ],
  "orderExternalId": "191763090_O1231"
}
'
{
  "orderNumber": "12",
  "totalAmountRefunded": 25.5,
  "totalAmountRefundedInCurrencies": [
    {
      "currency": "USD",
      "group": "SHOPPER",
      "amount": 123.45
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-fabric-tenant-id
string
required

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
string
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.

​
x-fabric-request-id
string

Unique request ID

Path Parameters

​
orderNumber
string
required

Merchant-defined order identifier

Body

application/json

Appeasement request

​
source
string
required

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.

Example:

"Storefront"

​
userId
string
required

Identifier of the logged in user who initiated the request. This could be from either fabric Identity service or an external Identity service.

Example:

"12"

​
appeasements
object[]

Order-level appeasement details. At least one order-level or item-level appeasement must be added.

​
customer
object

Invoice customer

​
items
object[]

Item-level appeasements. At least one order-level or item-level appeasement must be added.

​
orderExternalId
string

A merchant-defined external order identifier.
This field is optional and can be used to reference the order in external systems such as an ERP, OMS, or CRM.

Example:

"191763090_O1231"

Response

OK

Appeasement info

​
orderNumber
string

Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service

Example:

"12"

​
totalAmountRefunded
number<double>

Total refunded amount

Example:

25.5

​
totalAmountRefundedInCurrencies
object[]

The total amount that has been refunded, represented in one or more currencies.
Each entry provides the total refunded value and its corresponding currency code,
using the structure defined in the amountInCurrency schema.
This field enables tracking of cumulative refunds across multiple currencies.