List Returns
GET/api/shopify/:integrationInstance/returns
Returns a paginated list of Shopify returns synced for the integration instance, with the parent order summary, return line item counts, and the linked SKU.io RMA when one has been created.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Filterable columns: id, name, status, order_name, shopify_created_at, shopify_updated_at, created_at, updated_at. filter[search] matches the return number and order number.
Filtering: pass filter[column]=value for an exact match, or filter[column.operator]=value with operators such as contains, does_not_contain, is, is_not, is_one_of, starts_with, ends_with, is_empty, is_not_empty (text), greater_than, less_than, greater_than_or_equal, less_than_or_equal, between (numeric/date). Complex AND/OR trees can be sent as a base64-encoded JSON tree in the filter_groups parameter.
Allowed sorts: id, name, status, shopify_created_at, shopify_updated_at, created_at, updated_at (default -id). Pagination defaults to 15 per page.
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.