ReturnGO supports any eCommerce platform. If you use your own custom eCommerce platform, instead of using a standard one like Shopify or BigCommece, ReturnGO enables you to connect your platform to ReturnGO using the specially-curated Platform API.
Requirements
To integrate ReturnGO with your custom platform, you will need the following:
- ReturnGO Platform API Server URL, username, and password
- Store information (owner email, store address, and phone number)
Integrating ReturnGO with Your Custom Platform
To connect ReturnGO with your platform, you’ll need to build a server that implements the relevant APIs and then provide the access details to the ReturnGO team.
To connect ReturnGO to your custom platform:
1. Implement the required APIs in your platform for the ReturnGO Platform API:
-
Authentication
-
Fetch Order APIs
2. Provide the ReturnGO team with the following information:
-
Credentials for your ReturnGO Platform API Server
-
URL
-
Username
-
Password
-
-
Info for creating a ReturnGO account:
-
Owner’s email address
-
Store’s full address, including phone number.
-
3. ReturnGO uses the credentials provided in order to create your ReturnGO account.
4. Accept the ReturnGO account invite email you will receive.
5. Confirm your email address by following the instructions in the email verification email you will receive.
6. Generate an API key from the ReturnGO dashboard.
a. Go to Settings > Integrations > API.
b. Click on ADD API KEY.
7. Create a return portal and embed it into an HTML page.
a. Add these lines to the page HEAD section of your new page:
<script src="https://static.returngo.ai/master.returngo.ai/returngo.min.js" defer="defer"></script>
<script type="application/javascript">
window.ReturnGO = {
shop: 'shopname.myshopify.com', //Your shop URL
locale: 'en', //The locale to display
};
</script>
Tip: To find your shop URL, click on the "copy" icon next to your store name at the top of the ReturnGO dashboard. This will copy your shop URL (which is not visible) to your clipboard.
b. Add this line to the page BODY section where you want the portal to appear:
<div id="ReturngoPortalEmbedding" style="position: relative; display:block; min-height: 600px"></div>
8. Enable the storefront integration and finalize the setup:
-
-
Open the eCommerce Platform Integration section.
-
Enable the Integrate into Your Store toggle.
-
Input the URL of your ReturnGO portal into the provided field.
-
Click on the save icon to save your changes.
9. Set up your return policies and other configurations according to your store’s requirements.
10. Test and implement additional APIs as needed, such as the getVariants API for variant exchanges as well as any other webhooks and APIs that are part of the standard ReturnGO API.
Custom Platform API Flow
Portal API Flow
Refund API Flow
Dashboard API Flow
Tips
Order Name vs. Order ID
The Order Name is the customer-facing order identifier. It might be a number or a string.
The Order ID is an internal order identifier, that your platform may or may not have, which can be used for fetching the order quickly.
The Order Name and Order ID can be the same. In some cases, you may want to use the fulfillment order ID as the order ID.
Tags
Use the tags array at any supported level to map eligibility-related information. You can then base ReturnGO eligibility rules on the tags you added.