Sign in

v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
External Orders

Get cancellation summary for external order

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Returns whether the external order can be cancelled and a preview of affected fulfillments. Use this before calling the cancel endpoint to understand what will be affected.

get/open-api/v1.0/external-orders/{externalSource}/{externalOrderId}/cancellation-summary

Path parameters

externalSourcestring required

The marketplace source (e.g., etsy, amazon, ebay)

externalOrderIdstring required

The marketplace's order ID

Response

OK

externalOrderIdstring required
externalSourcestring required
fourthwallOrderIdstring uuid required
cancellableboolean required

Whether the order can be cancelled (with or without forceCancel)

cancellableItemCountinteger required

Number of items in cancellable fulfillments

notCancellableItemCountinteger required

Number of items in non-cancellable fulfillments

Example response

{
  "externalOrderId": "ETSY-123456789",
  "externalSource": "ETSY",
  "fourthwallOrderId": "b1a5c9d2-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
  "cancellable": true,
  "notCancellableReason": {
    "code": "ALL_FULFILLMENTS_IN_PRODUCTION",
    "message": "All fulfillments are in production. Use forceCancel=true to cancel."
  },
  "fulfillments": [
    {
      "fulfillmentId": "ful_EdJvIXu3SEiXe_QkPavHSA",
      "status": "ACCEPTED",
      "cancellable": true,
      "cancellableWithForce": true,
      "notCancellableReason": "IN_PRODUCTION",
      "itemCount": 1,
      "provider": "PRINTFUL"
    }
  ],
  "cancellableItemCount": 2
}