Sign in

v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
External Orders

Cancel external order

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

Cancels an external order and its fulfillments. Payment is not processed since external orders are paid on the marketplace. Use forceCancel=true to bypass IN_PRODUCTION and ON_HOLD restrictions (cannot bypass PACKAGED or SHIPPED statuses).

post/open-api/v1.0/external-orders/{externalSource}/{externalOrderId}/cancel

Path parameters

externalSourcestring required

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

externalOrderIdstring required

The marketplace's order ID

Request body

reasonstring required

Reason for cancellation (for audit purposes)

forceCancelboolean required

If true, bypasses IN_PRODUCTION and ON_HOLD restrictions (cannot bypass PACKAGED or SHIPPED)

Example request

{
  "reason": "Customer requested cancellation on marketplace"
}

Response

OK

externalOrderIdstring required
externalSourcestring required
fourthwallOrderIdstring uuid required
statusstring required

Overall cancellation status

Example response

{
  "externalOrderId": "ETSY-123456789",
  "externalSource": "ETSY",
  "fourthwallOrderId": "b1a5c9d2-3e4f-5a6b-7c8d-9e0f1a2b3c4d",
  "status": "CANCELLED",
  "cancelledFulfillments": [
    {
      "fulfillmentId": "ful_EdJvIXu3SEiXe_QkPavHSA",
      "previousStatus": "ACCEPTED",
      "provider": "PRINTFUL",
      "itemCount": 1
    }
  ],
  "skippedFulfillments": [
    {
      "fulfillmentId": "ful_EdJvIXu3SEiXe_QkPavHSA",
      "status": "PACKAGED",
      "reason": "PACKAGED",
      "itemCount": 1
    }
  ]
}