The ReturnGO API empowers you to seamlessly integrate with any shipping carrier even if it doesn’t have a built-in integration with ReturnGO. This gives you the flexibility to choose the most suitable carrier for your business needs.
For more information about the API, check out the article about the ReturnGO API and its abilities.
Connecting with a Shipping Carrier via API
The API connection with a shipping carrier enables you to notify the carrier when an RMA is created and generate a return shipping label through the carrier which is then automatically included in confirmation emails to customers.
Prerequisites:
- A ship with any carrier return method - when this return method is selected as the RMA's return method, you’ll need to generate a return shipping label.
- One or more return policy rules set with the relevant return method.
- The return policy rules need to be set to manual approval. RMAs will be automatically approved through the API.
- Receive webhook event on RMA creation - Register to the webhook event of RMA Created so that when an RMA is created in ReturnGO, you receive the event that an RMA has been created.
- Get the RMA details - Use the GET RMA Details endpoint to get the information about the return, including addresses, customer information, etc.
- Generate the return shipping label - Generate the return label through the shipping carrier by calling APIs of the carrier/aggregator.
- Add shipping label to the RMA - Use ReturnGO’s PUT Shipment endpoint to add the return shipping label URL to the corresponding RMA. Shipping labels in PDF or PNG formats are fully supported.
If the return method is configured to generate a packing slip as well, the packing slip will be attached as a second page to the provided label.
This links the relevant information such as the shipment ID to the RMA, enabling you to include the URL in the RMA card so you can track it manually, as well as in emails so you can enable customers to register for updates.
Note: The shipment ID is generated when the return method requires the items to be returned and will appear in the RMA details.
5. Approve the RMA - Approve the RMA with ReturnGO’s PUT RMA Status endpoint. The shipping details will be documented in the RMA.
Make sure the shipping instructions for the return method include the relevant steps, including a {print_label_button} variable to include the label in the shipping instructions.
6. Receive shipment status updates - Use webhooks or polling to get shipment status updates from the carrier.
7. Set shipment status - Set shipment status to Shipped when the package is on its way or RMA status to Received when the package is delivered.
Note: The rate limit is up to 2000 calls per day and 100 calls per second. If you need a higher limit, contact ReturnGO support.
Customizing Shipping Notifications
ReturnGO sends update notifications to your customers based on the shipment status tracked by your system and then set using the API.
Learn how to use the ReturnGO API to offer return pickups.