Order Stores
eHub empowers users to connect a wide range of eCommerce services, which we refer to as Order Stores. These connections allow customers to seamlessly consolidate and manage orders through a Transportation Management System (TMS). Below is a summary of how Order Stores work and the endpoints available for managing orders within eHub's system.
Order Store Integration
eHub provides the functionality to pull orders and related information from connected eCommerce systems, as well as update shipment details back into those systems. This ensures a streamlined order management process from creation to shipping.
To view existing Order Stores or to add a new one, users can follow these steps:
- Log into eHub → Select
APIon the far left menu → Click onSettingsin the API submenu → Click onStores
Adding New Order Stores
On the New Order Store page, users can select the type of store they want to connect. The page will guide them through the connection process, which varies by store type—some use OAuth 2.0, while others require keys, URLs, or tokens. The page also shows a table listing the available functionality for each store type, as not all stores support full eHub functionality. Clicking Save will save the store
- If OAuth 2.0 is required, users will need to Authorize the connection.
- After completing the connection, users can begin interacting with their order stores.
It is not possible to successfully interact with the Order endpoints without first specifying the Order Store in the request URL. Therefore we have the List Order Stores endpoint to retrieve all the store connections you have created through your eHub account and their IDs. You will specify the store ID in your request URL.
eHub Order Store Endpoints
To interact with Order Stores, you need to retrieve their details using the List Order Stores endpoint, which shows all connected stores and their unique IDs. These IDs will be used in requests to perform actions on specific stores. Below are the key endpoints available:
Endpoint | Purpose |
List Order Stores | Shows an array of order stores connected to your eHub account |
List Orders From an Order Store | Shows an array of orders for a specific store |
Retrieve an Order From an Order Store | Shows a single order for a specific store |
Ship an Order | Add shipment information to an order in the order store's eCommerce system |
Cancel and Order's Shipment | Override or delete shipment information on an order in the store's eCommerce system |
Create Custom Orders | Associated with “Custom” order stores which are explained below |
Update a Custom Order | Associated with “Custom” order stores which are explained below |
Custom Orders and Order Stores
eHub supports Custom Order Stores, which are useful for integrating custom software platforms with eHub’s Order Store API. This allows for the storage and management of custom order data that can be accessed by partner software, such as eHub Ship. Custom Order Stores must be created in the eHub portal before using their associated endpoints.
On this page
- Order Stores