Get Sales Credit
GET/api/sales-credits/:sales_credit
Returns a single sales credit with all relations: lines, store with address, sales order, RMA with receipts, payments, allocations, and accounting transaction.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Totals fields:
- total: total credit amount
- refund_payments_total: sum of cash/card refunds against the credit (always positive)
- applied_to_other_total: sum of credit consumed by Loop Returns EXC-* exchange orders (always positive)
- fees_retained_total: sum of fees Loop withheld out of the customer's credit — return shipping, restocking, etc. (always positive)
- outstanding_amount: total minus (refund_payments_total + applied_to_other_total + fees_retained_total), clamped to zero (i.e., the unrefunded, unapplied balance still owed back to the customer)
Response field metadata (object|null): minimal credit-source metadata for channel-synced credits - source (e.g. ebay, shopify, woocommerce) and sales_channel_refund_id (the channel refund ID). null for manually created credits. Used by the UI for the source chip on the sales order Credits tab.
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.