Get Channel Refund Context
GET/api/sales-orders/:salesOrder/channel-refund/context
Returns the refund capabilities and current refundable state for a sales order's channel: per-line refundable quantities and amounts (net of refunds already recorded on the channel), refundable shipping, supported restock options and locations, required reason codes, and whether the channel processes refunds asynchronously.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
When the channel does not support API refunds, supported is false and deep_link (when available) points to the channel's own refund page.
Requires a Bearer token.
capabilities.notice(string|null) — channel-specific caveat rendered as an info alert in the refund dialog (e.g. Magento 1 credit memos are offline — no money moves on the channel).
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.