Check Fulfillments Deletable
POST/api/sales-order-fulfillments/deletable
Check whether fulfillments can be voided (deleted). A fulfillment is not deletable when its linked shipping-provider order is already marked as shipped at the provider.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body:
ids(array of integers, required, min 1) — fulfillment IDs to check. Unknown IDs fail validation with 422.
Returns one entry per fulfillment with deletable and, when not deletable, a human-readable reason. Use before calling the void (DELETE) endpoint.
Read-only — no external calls and no changes. Requires the orders:write token scope.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.