Neuro Returns API Integration Guide

This guide outlines the steps to obtain an API key from Neuro Returns and integrate it with your Neuro store. The Neuro Returns API is accessible for each sales channel linked to your store, ensuring a seamless returns experience.

Last updated 2 months ago

Neuro provides a comprehensive returns and exchanges solution through our specialised returns plugin. Designed for precision and efficiency, Neuro intuitive dashboard enables seamless return processing, while the customer portal enhances transparency with real-time tracking. Our one-click returns feature allows customers to generate return labels effortlessly, improving stock management and operational efficiency.

After installing the plugin this guide outlines the process of registering for Returns, setting up sub-accounts, configuring brands, and integrating essential functionalities such as sales channels, notifications, and couriers. Follow the steps below to ensure a seamless onboarding experience.

1. Installing the Neuro Returns API Plugin.

To integrate Neuro Returns with your store, follow these steps:

Steps to Install the Returns API Plugin:

  1. Access your Neuro account and click Stores in the left-hand menu.

  2. If a store already exists:

    • Click View Store to access it directly.

  3. If a store does not exist:

    • Click + ADD at the top to create a new store.

    • Enter a suitable store name and click Edit to make further changes.

  4. Navigate to the plugins tab.

  5. Click the Install button in the Returns plugin section.

  6. A pop-up window will appear. “Do you wish for the Hey Voila app to be installed on your Voila account? Allowing this app to be installed will provide this app full access to your account and it's data.”

  7. Allow to proceed.

🎉 You have successfully integrated Neuro Returns with your store!

Click to Maximise the Video.

Returns: User Registration & Setup

1. Registering an Account

To access Returns, users must first create an account.

Steps to Register:

  1. Navigate to the Returns registration page.

  2. Enter the required details:

    • Full Name

    • Company Name

    • Email Address

    • Password (Ensure it meets security requirements)

  3. Click Register to create your account.

Upon successful registration, a confirmation email will be sent.

2. Email Verification

To activate your account, follow these steps:

  1. Check your inbox for a verification email from Returns.

  2. Open the email and click on the verification link provided.

  3. You will be redirected to the Returns platform with a confirmation message.

Your account is now verified and ready for use.

3. Accessing the Sub-Account Menu

Once verified, users gain access to the Sub-Account Menu, which allows businesses to create and manage multiple sub-accounts.

Key Features:

  • Multi-client management – Each sub-account operates independently.

  • Custom branding – Configure unique brand settings per sub-account.

  • Flexible integrations – Connect different sales channels per sub-account.

To create a new sub-account:

  1. Navigate to Sub-Accounts in the dashboard.

  2. Click Create New Sub-Account and enter the required details.

  3. Click Save to finalise the setup.

4. Creating & Configuring a Brand

Each sub-account can have its own brand identity, allowing for custom branding and return configurations.

Steps to Create a Brand:

  1. In the Sub-Account Dashboard, go to Brand Settings.

  2. Click Create New Brand.

  3. Enter brand details, including:

    • Brand Name

    • Return Address

    • Support Email

    • Company Logo (Optional)

  4. Click Save to finalise.

Automatic Domain Assignment

Upon saving, a unique predefined domain is automatically assigned to the brand.

5. Configuring Notifications

Returns allows businesses to set up automated notifications for various return events.

Available Notifications:

  • Return Request Confirmation – Sent when a return request is submitted.

  • Return Approval Notification – Sent when a request is approved.

  • Return Completed Notification – Sent when the return process is finalised.

How to Configure Notifications:

  1. Navigate to Notification Settings.

  2. Select a notification type.

  3. Customise the message (optional).

  4. Click Save.

Users can also edit or delete notifications as needed.

6. Defining Return Reasons

Return reasons help categorise and manage return requests efficiently.

Steps to Configure Return Reasons:

  1. Navigate to Return Reasons in the dashboard.

  2. Click Add New Reason and enter a reason (e.g., "Defective Item").

  3. Specify additional settings:

    • Require Additional Information (Yes/No)

    • Require Image Upload (Yes/No)

    • Active Status (Enable/Disable)

  4. Click Save.

7. Setting Up Sales Channels

Returns integrates with multiple sales channels for seamless order retrieval.

How to Add a Sales Channel:

  1. Navigate to Sales Channels.

  2. Click Add Sales Channel.

  3. Select an integration (e.g., Shopify).

  4. Enter the necessary credentials and authenticate.

  5. Click Save.

Once configured, Returns will synchronise orders from the sales channel automatically.

8. Integrating Courier Services

To automate shipping label generation, configure a preferred courier service.

How to Add a Courier:

  1. Navigate to Courier Settings.

  2. Click Add Courier.

  3. Select a courier (e.g., Royal Mail).

  4. Enter the required API credentials (if applicable).

  5. Click Save.

When a return request is approved, Returns will automatically generate a shipping label and return details.

9. Submitting a Return Request

Customers can submit return requests via the Returns platform.

Steps to Submit a Return Request:

  1. Navigate to the Returns Portal.

  2. Enter the following details:

    • Email Address

    • Order ID

  3. Select the item(s) to return.

  4. Specify return reason(s) and upload any required images.

  5. Click Submit Request.

A confirmation email will be sent, summarising the return details.

10. Managing Return Requests

For Managers:

Upon submission, return requests appear in the Returns Management section for review.

Approving a Return Request:

  1. Navigate to Return Requests.

  2. Review the request details and supporting information.

  3. Optionally, add a message for the customer.

  4. Click Approve to confirm.

A shipping label will be generated, and the customer will be notified automatically.

Rejecting a Return Request:

  1. Navigate to Return Requests.

  2. Select the request and click Reject.

  3. Enter a reason for rejection.

  4. Click Confirm.

The customer will receive a notification regarding the rejection.

11. Tracking Return Shipments

Once a return request is processed, tracking details are available in Returns Management.

Key Features:

  • Tracking Number & Status – View courier tracking updates.

  • Customer Notifications – Customers receive updates via email.

  • Order ID Search – Find return requests by order reference.

Conclusion

Returns provides a streamlined and automated workflow for handling return requests efficiently. By following this guide, businesses can set up their account, manage returns seamlessly, and enhance the customer experience.

To fully utilise the Neuro Returns API, explore our comprehensive API documentation for further details on managing returns, processing exchanges, and automating notifications.

For additional support, contact the Neuro Support Team.