Export Sales Credits

GET 
/api/sales-credits/list/export

Download an Excel/CSV export of sales credits.

Required scope: orders:read

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

Authentication: Requires Bearer token (scope.rw:orders).

Response: a binary file download (xlsx or csv), NOT JSON. Columns: ID, Credit #, Sales Order #, Store, Customer, Customer Email, Credit Date, Status, Payment Status, Currency, Tax Total, Total Credit, Refunded, Note, Created At.

Query params:

• format: xlsx (default) or csv
• scope: 'filtered' (default) or 'selected'
• ids: comma-separated IDs (only when scope=selected)

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.