Using the ReturnGO API to Create RMAs

The ReturnGO API enables you to create Return Merchandise Authorizations (RMAs) externally, either through predefined or interactive workflows.

This can be useful in cases where you want to create RMAs from an external platform, such as a warehouse application, custom-built portal, or bot.

For more information, check out the article about the ReturnGO API and its abilities.

Capabilities

• Creates RMAs that are initiated externally, in ReturnGO.
• Applies any integrations and automations used for regular ReturnGO RMAs.
• Supports predefined and interactive workflows for different scenarios.
• Enforces eligibility checks to ensure policy compliance during RMA creation.

Requirements

To use the ReturnGO API for creating RMAs, you need:

• ReturnGO API key
  • Find your API key on the ReturnGO dashboard on the Settings > Integrations > API page.

See full documentation of endpoints, webhooks, and more: ReturnGO API Documentation.

Key Workflows

The API supports two main workflows for creating RMAs:

1. Predefined Workflow

Setting up a predefined workflow is best suited for situations where the return policy rule is already determined. This is ideal for automating "blind returns" — returns where items are returned to the warehouse without the customer initiating a return request through the return portal first.

In this workflow, the warehouse application can create the RMA automatically, e.g when an item is scanned, which then automatically generates the RMA in ReturnGO. This helps to streamline the process, as the return method and resolution have already been predefined.

Example:

• A warehouse may classify returned items into two categories: damaged and not damaged. 
• Based on these predefined categories, the warehouse team can create an RMA for each item.
• The return method and resolution (e.g., refund) are already determined for these categories, and eligibility checks are enforced automatically to ensure policy compliance during RMA creation.

2. Interactive Workflow

Setting up an interactive workflow is best suited for situations where you build a custom portal, bot, or interface to initiate returns, rather than using the ReturnGO portal, while still ensuring that RMAs are created in ReturnGO and go through the normal process and automation flow. 

This workflow uses the API to get available return options and select the most appropriate ones based on real-time data.

Example:

• A customer or staff member initiates a return through your custom-built portal or interface. 
• The portal checks real-time data for available return options, like refunds or store credit, based on the return eligibility. 
• The API ensures that a corresponding RMA is automatically created in ReturnGO.

How the API Works

The ReturnGO API for creating RMAs operates in two key steps to support both workflows:

1. getEligiblePolicies (Optional)
   • This step retrieves available return policy rules for each of the specified items.
   • Primarily used in the interactive workflow to dynamically determine the available return options for a specific return scenario.
   • By pulling the eligible policies, you can present customers with the relevant return options within your custom portal or interface.
2. createRmaByPolicy
   • This step creates the actual RMA in ReturnGO.
     • In a predefined workflow, the policy rules are configured ahead of time and automatically applied to create the RMA.
     • In an interactive workflow, you use the policies retrieved in the getEligiblePolicies step to create the RMA, ensuring that the created RMA aligns with the selected return options and customer preferences.