← Back

Throughout This Page

You can jump to the specified sections by clicking on these titles.

• Setting Up Relay

Setting Up Relay

This document provides a step-by-step guide to integrating Relay with the Shipping API. Follow these instructions to integrate Relay into your system:

1. Begin by navigating to the left panel and hovering your cursor over "API Accounts."
2. Click the plus icon to initiate the setup process under your preferred API Account.
3. In the first row, choose "Relay" from the list of available options.
4. The following fields are required for setting up Relay integration:
   • Company: Enter any identifier you prefer.
   • Testing: This is a simple yes or no selection. If enabled, the information will not be transmitted to the courier through their API, making it suitable for testing.
   • API_Key: Obtain this detail through Relay's platform or contact them directly to acquire this information.
   • Notes: Use this field to enter relevant information or notes regarding this courier. It will only be visible to you.
5. To complete the setup, click on "Save Changes." 

By following these steps, you will successfully configure the Relay integration with your Shipping API.