The Returns API enables customers to retrieve details of an existing return order. Designed to streamline the returns process, it allows businesses to access essential return order data seamlessly.

• Efficient Returns Retrieval: - Access comprehensive return order details in real-time, enabling seamless tracking and management of the returns process.

• Integration Flexibility: - Enhance operational workflows by integrating return order retrieval functionality directly into your platform, ensuring consistency and ease of access.

Once set up as a user, you can retrieve details of an existing return order via the Returns API. Simply use the Get Return Request by ID endpoint to fetch information for a specific return request initiated through the returns portal.

• How are return orders initiated?

  Return orders are initiated through our returns portal based on an existing order. They cannot be created directly via the API.

• What details can I retrieve using the Returns API?

  The API provides comprehensive details about an existing return order, including return status, associated order information, and customer details.

• How is the returnRequestId generated?

  The returnRequestId is generated during the creation of a return request in the returns portal and shared via a webhook. It serves as the unique identifier for the return order in subsequent API calls.

When the system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response.

Successful response may or may not include warnings.

1. Without warnings - Indicates the request has been processed as anticipated.
2. With warnings - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user.

The severity of an error may be transient or hard.

• Transient error - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time.
• Hard error - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing.

GET

POST