Return Helper provides a suite of APIs for managing e-commerce product returns end-to-end — from return request creation through shipment tracking, label generation, and warehouse processing.
The API is designed for server-to-server integration only. Do not call these endpoints directly from client-side code.
User API — Authenticated endpoints for merchants and partners to manage return requests, shipments, labels, inventory, and account settings.Public API — Reference data endpoints exposing lookup values such as service types, warehouse lists, status codes, and supported countries.
For state-changing requests (creating return shipments, inventories, etc.), include an idempotency key to prevent duplicate operations in the event of network retries.
x-returnhelper-idempotency-key: YOUR_UNIQUE_KEY
Generate a fresh UUID (or similarly unique string) for each distinct transactional request. The server recognises repeated submissions of the same key and executes the operation only once, preserving data integrity.
The full API specification is available as an OpenAPI 3.1 document. You can download it and import it directly into API clients such as Postman or Insomnia, or use it to generate client SDKs with tools like OpenAPI Generator.
Label results and warehouse events (shipment arrival, inventory creation, image uploads, etc.) are delivered asynchronously via webhook notifications. You must register a notification endpoint to receive these events.See the Webhooks section for the full list of notification event types and their payloads.
