Release Credit Hold
POST/api/sales-orders/:salesOrder/release-credit-hold
Releases a pending credit hold on a sales order. Credit-held orders sit in Reserved with credit_hold_status: "pending"; releasing the hold records the releasing user and timestamp (credit_hold_released_at) and opens the order for fulfillment unless another hold still gates it — when the order is also reserved on a payment-pending hold it stays reserved, and the response message says so ("Credit hold released. The order remains reserved on a payment-pending hold.").
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token with the orders scope (write).
No request body.
Path parameters:
- salesOrder (required): Sales order ID.
Errors:
- 400 when the order is not currently held for credit.
Requires permission: sales_orders.release_credit_hold
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Bad Request
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.