# Returns API

#### <span style="color: #003366;">**Overview**</span>

Returns offers a comprehensive returns and exchanges solution through our specialised returns suite. With an intuitive dashboard and management software, processing exchanges becomes precise and efficient. The Returns portal empowers customers by providing detailed tracking and management capabilities for all returns, enhancing visibility and refining stock management. Additionally, our one-click returns feature enables customers to generate return labels promptly.

This documentation will provide step-by-step guidance on acquiring the API key from your Returns store and integrating it with your Channels store. The Returns API is available for use for each sales channel incorporated within your Channels store.

#### <span style="color: #003366;">**Obtaining the API Key from Returns API**</span>

<span data-preserver-spaces="true">To retrieve your API key from Returns, adhere to the subsequent steps:</span>

1. <span data-preserver-spaces="true">Sign in to your account via this [link](https://ecommercereturns.co.uk/login).</span>
2. <span data-preserver-spaces="true">Navigate to "Accounts", located on the left-hand panel.</span>
3. <span data-preserver-spaces="true">Select "View Account" from the displayed list, which corresponds to the account you intend to link with Channels.</span>
4. <span data-preserver-spaces="true">Access the "Settings" option at the top right corner of your screen.</span>
5. <span data-preserver-spaces="true">Proceed to the "API Key" tab.</span>
6. <span data-preserver-spaces="true">From the page, locate and copy the API key displayed in the "API Key" section, which will be highlighted for your convenience.</span>

[![](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_KB_Returns01.webp)](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_KB_Returns01.webp)

#### <span style="color: #003366;">**Installing the Returns API Plugin on Channels**</span>

To integrate the Returns API with your Channels store, please follow these steps:

1. <span data-preserver-spaces="true">Access your account and go to the left side of the screen. Click the "Stores" button.</span>
2. <span data-preserver-spaces="true">If you already have a store, click "View Store" on the right side of the screen to access it directly.</span>
3. <span data-preserver-spaces="true">Or, click the "Stores" button from the left-hand side of the screen to edit an existing store and click the edit button on the right side. If you need to create a new store, click "+ ADD" above, name it, and use the edit button to make changes.</span>
4. <span data-preserver-spaces="true">Click the "Plugins" tab.</span>
5. <span data-preserver-spaces="true">Click "+ ADD" in the Plugins section to begin the installation.</span>
6. <span data-preserver-spaces="true">A window will appear in the centre of the screen. Choose "ShipBob" from the available channels list.</span>
7. <span data-preserver-spaces="true">Provide the required information:</span>
    - **<span data-preserver-spaces="true">Plugin Name:</span>**<span data-preserver-spaces="true"> Input a suitable name in the designated field. It's advisable to select a name that's meaningful to you, possibly aligning with your store's name, for clarity in future order references.</span>
    - **API Key:** Input the API key acquired from the Returns platform.
8. <span data-preserver-spaces="true">Once all fields are populated, finalise by selecting "Save" at the bottom right.</span>
9. <span data-preserver-spaces="true">Activate the connection from the top of the screen using the "Is Active" button.</span>

Congratulations! You've successfully set up Returns API on Channels. Please visit [**this page**](https://channels-documentation.despatchcloud.app/books/plugin-setup-guides/page/plugin-features) to learn more about utilising Returns API to the fullest.

[![](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_ReturnsAPI_Plugin.webp)](https://documentation.despatchcloud.com/uploads/images/webp/Channels/Channels_ReturnsAPI_Plugin.webp)