For up-to-date API endpoints, request and response examples, and more, visit our API docs.
API Description
The RMA API allows you to retrieve Return Merchandise Authorisation (RMA) data from Swap. It is designed for integrations with systems such as warehouse management systems (WMS), analytics tools, or other third-party applications that require return data.
The API has two versions. Version 2 is recommended for new integrations and adds split shipment support, exchange item detail, and store credit tracking; version 1 remains supported for existing integrations. See the API docs above for the full version comparison.
API Logic
When called, the endpoint returns a paginated list of RMAs for a given store and date range. Optional parameters allow filtering by submission time, update time, controlling pagination, and specifying output version.
Authentication
All requests require an API token in the x-api-key header.
If you already have an API key for another Swap API (e.g. QC API), you can reuse it.
How to generate an API token
Go to Returns → Integrations in the Swap dashboard.
Click Generate API Key.
Copy the token from the popup (it will not be shown again).
Include it in the x-api-key header for all requests.
How to rotate your API key
Go to Returns → Integrations in the Swap dashboard.
In the API key panel, click the refresh icon.
Rotating deactivates the old key immediately and issues a new one, so update your integration with the new key before rotating to avoid dropped requests.