How to get started with the Connect API

Get API access

First make sure you have the API key and secret to auth with the API. The API uses Basic Auth. Note that each API key can have different access assigned from the user it is tied to, so you can have separate API keys with access to different brand (a brand being a client) or a single common API key for all of them.

Create a storefront

Storefronts are a way that orders are grouped. Each storefront is tied to a single warehouse. A warehouse when it comes to Connect would a DC (Distribution Center), be it an actual physical warehouse or not. For example: all orders that would ship from Warehouse A, would be assigned to Storefront One. If some order needs to be ship from Warehouse B that will require you to assign them to a new storefront. You can have multiple storefronts tied to doing fulfillment from the same storefront under the same brand, if you want to have the orders separated for one reason or another, like to specify that they come from a different sales channel.

Create an order group

You also group orders into Order Groups, each storefront has their own order groups separate from each other. This is purely for the sake of order management. Note that you will have to create at least one order group before you can create orders in Connect, since all orders must have the order group set.

Tip

When compared to ShipStation: You can think of a Storefront like a ShipStation account. Note that what ShipStation calls Stores are called Order Groups inside the Connect system, but are more or less the same thing. All Storefronts created via the API by default have their order information sourced via the Connect API.

Warehouses and Warehouse Items

Warehouses are managed by LaCore Logistics. You do not have access to create warehouses (you’ll note there is an API endpoint for it, but is reserved for fulfillment partners). You can read warehouse information, including a list of warehouses, their address, and the warehouse items configured in them for your brands.

Note that you can pull inventory levels about warehouse items, from a top down summary, to granulated information by lot number, expiration date and warehouse location. We do not recommend using this for syncing inventory levels in the storefronts. For that it is better to use the /v2/reports/productsStatistics endpoint as it covers all storefront aliases.

Storefront Products

The Storefront Products is a catalog of product SKUs that will be used in the storefront orders, including any kits, variants, or aliases. If you have a product catalog in your storefront we recommend syncing it with the Connect catalog. Note that if you create a order line item with a storefront SKU that doesn’t exist, Connect will automatically generate a storefront product based on the first order line item it encounters.

Orders

Orders are assigned to storefronts and order groups, you won’t be able to create an order without setting both fields. To create orders use the /v2/orders/createorders.

Note that orders have three IDs: Order Number, Order Key and Order Id. The Order Number must be unique for that storefront, as does the Order Key. The Order Key is a unique identifier to identify the order in the source system. The Order Id is unique across storefronts. To update an order you must specify the connect Order Id if using this endpoint. Otherwise Connect will attempt to create a new order with the given request.

You can use the OrderKey to update the order by using the /v2/orders/updateorders endpoint. If no Order Id or Order Key is given an error will be returned for that order.

Order Line items have Order Item Ids and Line Item Keys. If you specify either one, Connect will update the order. You will also note various properties which are ShipStation specific and as such are read only through the Connect API. For orders created through the Connect API those are always null. Please check the API docs for more details on this.