POST
/
orders
/
{orderId}
/
actions
/
cancel
curl --request POST \
  --url https://api.fabric.inc/v3/orders/{orderId}/actions/cancel \
  --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 '{
  "attributes": {
    "isPerishable": "false"
  },
  "employeeId": "12312232",
  "items": [
    {
      "itemUnitNumber": 1,
      "lineItemId": "12",
      "quantity": 1,
      "reasonCode": "Incorrect item",
      "subReasonCode": "Not the right color"
    }
  ],
  "note": "This is a note",
  "policyCode": "RC1",
  "reasonCode": "Incorrect order",
  "releaseSoftReservation": true,
  "source": "CSR",
  "subReasonCode": "Incorrect specification"
}'
{
  "adjustmentTotal": 123.45,
  "adjustments": [
    {
      "adjustmentCounter": 1,
      "amount": 2.4,
      "attributes": {
        "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
      },
      "cancelQuantity": 2,
      "invoiceQuantity": 10,
      "notes": "Any additional info",
      "quantity": 2,
      "reasonCode": "RFC",
      "returnQuantity": 1,
      "subReasonCode": "Late shipping"
    }
  ],
  "allocatedAt": "2022-05-12T09:30:31.198Z",
  "appeasementTotal": 12.34,
  "appeasements": [
    {
      "amount": 34.56,
      "appeasementCounter": 1,
      "attributes": {
        "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
      },
      "invoicedAmount": 34.56,
      "payments": [
        {
          "paymentCounter": 1,
          "refundAmount": 34.56
        }
      ],
      "reasonCode": "Incorrect Item",
      "subReasonCode": "Late shipping"
    }
  ],
  "attributes": {
    "fraudCheckStatus": "UPDATED",
    "loyaltyStatus": "N"
  },
  "auditLogs": [
    {
      "amount": 2.4,
      "attributes": {
        "key": "value"
      },
      "auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
      "auditType": "CANCEL",
      "auditedAt": "2023-03-12T09:24:54.804Z",
      "employeeId": "6227",
      "isSuccess": true,
      "lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "lineItemNumber": 1,
      "note": "Note",
      "paymentToken": {
        "paymentType": "VISA",
        "token": "pi_34tr6787rt"
      },
      "policyCode": "POS",
      "quantity": 1,
      "reasonCode": "Scratched item",
      "sku": "SKU0023",
      "source": "POS",
      "subReasonCode": "Scratched item",
      "updatedFields": [
        {
          "fieldName": "UOM",
          "fieldOriginalValue": "PK"
        }
      ]
    }
  ],
  "cancelTotal": 12.34,
  "cancelledAt": "2022-05-12T09:30:31.198Z",
  "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  "channelId": "12",
  "createdAt": "2022-05-12T09:30:31.198Z",
  "currency": "USD",
  "customer": {
    "accountId": "62272e917b12209e68751d94",
    "company": "Demo Inc",
    "email": "test@example.com",
    "employeeId": "62272e917b12209e68751d94",
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    },
    "userId": "62272e917b12209e68751d94"
  },
  "discounts": [
    {
      "amount": 2.99,
      "invoiceQuantity": 10,
      "promotionCode": "HNY2022",
      "promotionId": "HNY2022",
      "promotionName": "New Year",
      "quantity": 1,
      "unit": "AMOUNT_OFF",
      "value": 10
    }
  ],
  "employeeId": "43278",
  "erroredFields": [
    {
      "amended": false,
      "errorMessage": "Invalid email address",
      "fieldName": "shipInfo.shipToAddress.email"
    }
  ],
  "feeTotal": 12.34,
  "fees": [
    {
      "amount": 34.56,
      "attributes": {},
      "currency": "USD",
      "invoicedAmount": 34.56,
      "name": "STATE",
      "rate": 10,
      "rateType": "PERCENTAGE",
      "taxCode": "FR01"
    }
  ],
  "invoiceTotal": 12.34,
  "items": [
    {
      "adjustments": [
        {
          "adjustmentCounter": 1,
          "amount": 2.4,
          "attributes": {
            "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
          },
          "cancelQuantity": 2,
          "invoiceQuantity": 10,
          "notes": "Any additional info",
          "quantity": 2,
          "reasonCode": "RFC",
          "returnQuantity": 1,
          "subReasonCode": "Late shipping"
        }
      ],
      "appeasementTotal": 5.5,
      "appeasements": [
        {
          "amount": 34.56,
          "appeasementCounter": 1,
          "attributes": {
            "number": "XlQZTmFDFtPFGMxJP6oiAqN3vo+qKZ"
          },
          "invoicedAmount": 34.56,
          "payments": [
            {
              "paymentCounter": 1,
              "refundAmount": 34.56
            }
          ],
          "reasonCode": "Incorrect Item",
          "subReasonCode": "Late shipping"
        }
      ],
      "attributes": {
        "colorCode": "001",
        "isDonation": "false",
        "style": "570223020"
      },
      "backOrderedQuantity": 10,
      "cancelledAmount": 12.4,
      "cancelledQuantity": 10,
      "channelId": "WHBM",
      "currency": "USD",
      "deliveredQuantity": 10,
      "discounts": [
        {
          "amount": 2.99,
          "invoiceQuantity": 10,
          "promotionCode": "HNY2022",
          "promotionId": "HNY2022",
          "promotionName": "New Year",
          "quantity": 1,
          "unit": "AMOUNT_OFF",
          "value": 10
        }
      ],
      "employeeId": "5345HJH",
      "exchangeQuantity": 13,
      "fees": [
        {
          "amount": 34.56,
          "attributes": {},
          "currency": "USD",
          "invoiceQuantity": 10,
          "name": "STATE",
          "quantity": 12,
          "refundAmount": 21.5,
          "taxCode": "FR01"
        }
      ],
      "hasInfiniteConsent": true,
      "invoiceTotal": 800,
      "invoicedQuantity": 10,
      "isBackorder": true,
      "isDonation": true,
      "isExchangeItem": true,
      "isGifting": true,
      "isPreorder": true,
      "itemAdjustmentTotal": 123.45,
      "itemDiscountsTotal": 80,
      "itemFeeTotal": 200,
      "itemId": 1234,
      "itemName": "Item",
      "itemShippingTotal": 10,
      "itemSubtotal": 600,
      "itemSubtype": "Borderfree",
      "itemTaxTotal": 80,
      "itemTotal": 800,
      "itemUnitPrice": 10,
      "lineItemId": "d538b1f1-0e45-43c6-bfc6-9666fc1188ca",
      "lineItemNumber": 1,
      "lineOrderStatus": "VALID",
      "notes": [
        {
          "createdAt": "2022-05-12T09:30:31.198Z",
          "notes": "Fragile - handle with care",
          "user": "62272e917b12209e68751d94"
        }
      ],
      "orderedQuantity": 60,
      "orderedQuantityToShip": 10,
      "originalDiscounts": 50,
      "originalFeeTotal": 300,
      "originalItemSubtotal": 800,
      "originalItemTotal": 500,
      "originalShippingTotal": 80,
      "originalTaxTotal": 90,
      "parentLineItemNumber": 12,
      "pendingExchangeQuantity": 12,
      "pendingReturnQuantity": 10,
      "pendingShippedBackOrderQuantity": 10,
      "processingReturnQuantity": 10,
      "quantityInStatus": {
        "cancelled": 10,
        "created": 10,
        "delivered": 10,
        "hold": 10,
        "pendingShipped": 10,
        "returned": 10,
        "shipped": 10
      },
      "refundAmount": 21.5,
      "rejectedReturnQuantity": 10,
      "reshippedQuantity": 10,
      "returnedQuantity": 10,
      "returns": [
        {
          "exchangeLineItemId": "62f3dfc438bcab1951be0a19",
          "fees": [
            {
              "amount": 34.56,
              "name": "RETURN_FEE",
              "reason": "Return fee",
              "type": "FEE"
            }
          ],
          "invoicedAmount": 11.29,
          "isExchangeItemReturned": true,
          "reasonCode": "Incorrect item",
          "refundAmount": 11.29,
          "refunds": [
            {
              "amount": 34.56,
              "name": "RETURN_FEE",
              "reason": "Return fee",
              "type": "FEE"
            }
          ],
          "returnRequestCounter": 1,
          "returnsReceivedAt": "2022-09-14T14:07:36.861Z",
          "shipmentId": "62b37697c67b204dd18a7465",
          "shipmentInvoice": {
            "invoiceId": "62ff5c0bec0aed3c86202c32",
            "invoiceNumber": "23940791",
            "invoicedAt": "2022-08-01T20:03:28.483971941Z"
          },
          "shipmentLineItemId": "234",
          "shipmentQuantity": 1
        }
      ],
      "shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "shippedQuantity": 10,
      "sku": "P1234",
      "taxCode": "FR01",
      "taxDetails": [
        {
          "amount": 34.56,
          "attributes": {},
          "currency": "USD",
          "name": "STATE",
          "rate": 10,
          "rateType": "PERCENTAGE",
          "taxCode": "FR01"
        }
      ],
      "type": "WEB_SHIP",
      "uom": "EA",
      "vendorId": "P1234"
    }
  ],
  "notes": [
    {
      "createdAt": "2022-05-12T09:30:31.198Z",
      "notes": "Fragile - handle with care",
      "user": "62272e917b12209e68751d94"
    }
  ],
  "orderDiscount": 1.23,
  "orderId": "5349b4ddd2781d08c09890f4",
  "orderNumber": "309019176",
  "orderReleasedAt": "2022-05-12T09:30:31.198Z",
  "orderSubtotal": 123.45,
  "orderTotal": 146.9,
  "orderedAt": "2022-05-12T09:30:31.198Z",
  "originalDiscount": 1.45,
  "originalFeeTotal": 12.34,
  "originalOrderTotal": 146.9,
  "originalSubtotal": 113.45,
  "originalTaxTotal": 12.34,
  "payments": [
    {
      "attributes": {
        "captureCurrencyCode": "USD",
        "payerId": "M7AWTK3YK3B46",
        "referenceId": "4DY41894J2904533S"
      },
      "authorizationAttempts": 0,
      "authorizedAmount": 123.2,
      "billToAddress": {
        "addressLine1": "123 Main St.",
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Kake",
        "city": "Seattle",
        "countryCode": "US",
        "email": "test@example.com",
        "latitude": 47.6205,
        "longitude": -122.3493,
        "name": {
          "firstName": "Alex",
          "lastName": "Doe",
          "middleName": "E"
        },
        "phone": {
          "number": "123-456-7890",
          "type": "MOBILE"
        },
        "postalCode": "98121",
        "region": "WA",
        "type": "Home"
      },
      "chargedAmount": 60,
      "currency": "USD",
      "isFinalCapture": false,
      "isPartialCapture": false,
      "paidAt": "2022-01-27T16:15:58-05:00",
      "paymentCounter": 1,
      "paymentIdentifier": {
        "cardIdentifier": "3456",
        "expirationMonth": "12",
        "expirationYear": "2029",
        "fabricPaymentReference": "f886c96c-5f65-11ed-9b6a-0242ac120002",
        "paymentId": "62272e917b12209e68751d94"
      },
      "paymentLogs": [
        {
          "amount": -12.4,
          "attributes": {
            "key": "value"
          },
          "data": {
            "body": {
              "attributes": {
                "key": "value"
              },
              "errors": [
                {
                  "key": "value"
                }
              ],
              "responseCode": "OK",
              "status": "Authorized",
              "transactionId": "328942333412",
              "transactionTimestamp": "2022-04-10T23:00:45:12.111Z"
            },
            "paymentStatusCode": "200"
          },
          "id": "328942333412",
          "paymentId": "328942333412",
          "paymentLogId": "328942333412",
          "paymentLogRefId": "328942333412",
          "status": "Authorized",
          "type": "REFUND"
        }
      ],
      "paymentMethod": "CREDIT_CARD",
      "paymentProvider": "stripe",
      "paymentStatus": "Paid",
      "paymentToken": {
        "paymentType": "VISA",
        "token": "pi_34tr6787rt"
      },
      "reauthorizationAttempts": 0,
      "refundAmount": 21.5
    }
  ],
  "retail": {
    "cashierId": "C-123",
    "locationNumber": 334,
    "registerId": "113",
    "transactionId": "328942333412"
  },
  "returnTotal": 12.34,
  "returns": [
    {
      "fees": [
        {
          "amount": 34.56,
          "name": "RETURN_FEE",
          "reason": "Return fee",
          "type": "FEE"
        }
      ],
      "invoicedAmount": 11.29,
      "paymentCounterRefundDetails": [
        {
          "amount": 34.56,
          "paymentCounter": 1
        }
      ],
      "refunds": [
        {
          "amount": 34.56,
          "name": "RETURN_FEE",
          "reason": "Return fee",
          "type": "FEE"
        }
      ],
      "returnCounter": 1,
      "totalRefundAmount": 11.29
    }
  ],
  "shipInfo": [
    {
      "attributes": {
        "giftMessage": "[]"
      },
      "discounts": [
        {
          "amount": 2.99,
          "promotionCode": "SHIPFREE",
          "promotionId": "SHIPFREE",
          "promotionName": "Free Shipping",
          "quantity": 1,
          "unit": "AMOUNT_OFF",
          "value": 10
        }
      ],
      "estimatedDeliveryDate": "2022-05-12T09:30:31.198Z",
      "estimatedShipDate": "2022-05-12T09:30:31.198Z",
      "isInvoiced": true,
      "locationNumber": "123",
      "pickups": [
        {
          "email": "test@example.com",
          "name": {
            "firstName": "Alex",
            "lastName": "Doe",
            "middleName": "E"
          },
          "phone": {
            "number": "123-456-7890",
            "type": "MOBILE"
          },
          "pickupType": "PRIMARY"
        }
      ],
      "shipMethod": "Parcel post delivery",
      "shipToAddress": {
        "addressLine1": "123 Main St.",
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Kake",
        "city": "Seattle",
        "countryCode": "US",
        "email": "test@example.com",
        "latitude": 47.6205,
        "longitude": -122.3493,
        "name": {
          "firstName": "Alex",
          "lastName": "Doe",
          "middleName": "E"
        },
        "phone": {
          "number": "123-456-7890",
          "type": "MOBILE"
        },
        "postalCode": "98121",
        "region": "WA",
        "type": "Home"
      },
      "shipToDiscount": 12.6,
      "shipToId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "shipToPrice": 20,
      "shipToTaxTotal": 12.6,
      "shipToType": "SHIP_TO_ADDRESS",
      "shipToUnitPrice": 20,
      "shipmentInstructions": "Handle with care",
      "taxCode": "FR01",
      "taxDetails": [
        {
          "amount": 34.56,
          "attributes": {},
          "currency": "USD",
          "name": "STATE",
          "rate": 10,
          "rateType": "PERCENTAGE",
          "taxCode": "FR01"
        }
      ]
    }
  ],
  "statusCode": "ORDER_CREATED",
  "statusDescription": "Order Created",
  "subtype": "INTERNATIONAL",
  "taxTotal": 12.34,
  "type": "WEB",
  "updatedAt": "2022-05-12T09:30:31.198Z",
  "version": 2
}

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

​
orderId
string
required

24-character system-generated order ID returned in the response of Create Order - POST /orders endpoint.

Body

application/json

Order cancellation request

Response

200
application/json
OK

Order details