In this article, we will explain how to find your API Key and API documentation in your Shipedge Account. Currently, three versions are supported: v2, v3, and v4. While we recommend using the latest version, some features are only available in legacy versions. We encourage you to choose the version that best fits your needs. The preferences view is accessible only via the main user account.
Configuration
Navigation
To find your API Keys, go to your OMS→ Account→Preferences → API Integration:
API Documentation & Information
Here, you'll find all the available documentation, along with your Account ID, API Key, and other information to assist you in this process:
a. Account ID - This is the unique identifier for your account. It is required for all API versions and all API calls.
b. API Key - Required for all API versions and requests.
Tip
Always keep your API keys safely, and update them regularly
c. Warehouse - This is your warehouse code, which is also part of your Shipedge login URL: <warehousecode>.shipedge.com
d. API REST v4- Click on Documentation to access the API v4. You can make API requests using other tools, or from the documentation site, as it is built with Swagger, a tool that provides an interactive API interface for testing and execution:
You must be logged in to access the documentation.
e. New Base URL- This is the base URL exclusively for API v4 and is required for all API requests. It is already predefined in Swagger and includes your warehouse code:<warehousecode>.shipedge.com
f. Shipping Method Translator: It is strongly recommended to configure the shipping method translator before using the API.
For more information, check this article: OMS: How To Configure Shipping Method Translator
g. Legacy API Documentation- This documentation includes API v1, v2, and v3. These are deprecated versions, but they may still be useful for specific functionalities. Key differences include:
No login is required to access the documentation
No API requests can be made from the documentation; an external tool is required.
h. Legacy Integration URL- Similar to the base URL for API v4, legacy versions also have a base URL. The main difference is that the legacy API uses your server code instead of the warehouse code : <servercode>integration.shipedge.com