Skip to main content

List Sales Credits

GET 
/api/v2/sales-credits

Returns a paginated list of sales credits using the standard list interface. Supports search, archiving filter, and column selection.

Required scope: orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

This endpoint uses the standard list interface. Common filters are passed as query parameters directly.

Response is wrapped with table_specifications metadata when table_specifications parameter is provided.

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)

Documents. Each row carries attachments_count (how many documents are attached to the credit) and attachment_filenames (their file names). Both filter[attachments_count] and filter[attachment_filename] are available, so you can isolate credits that are missing a supporting document or find the credit a given file belongs to. attachments_count is also sortable.

Request​

Responses​

OK

Response Headers
    Content-Type