Guide on moving from ShipStation API to Connect v2.0 API
This document outlines the differences between ShipStation and Connect as well as similarities, to watch out for when integrating with.
The main API Docs can be found at: https://api.lacoreconnect.com/docs
The Connect API uses the same auth setup as ShipStation. So Auth Basic. The API keys will be supplied by the management person responsible for it.
Order Listing
Section titled “Order Listing”ShipStation responses are slightly different between API endpoints, so the orders listing actually lists items in the “items” array instead of the “orders” array. Same for order groups, shipments, etc.
Order Details
Section titled “Order Details”You will notice a few additional properties on the OrderDto entity, when compared to ShipStation:
- ShipstationOrderId - We send the original ShipStation OrderId as well, but as this property, of course, only if it is applicable
- FulfilledByService - Connect Specific, the Fulfillment Service, who is handling the packaging/delivery, not the same as the actual carrier
- StorefrontId - Connect Specific, the Storefront ID, a Storefront is equivalent to a ShipStation account, the default one will be used if not specified when writing to the API
- OrderGroupId - Connect Specific, Order Group ID, equivalent to the StoreId in Advanced Fields, note that if this if not specified, the default one will be used
- SourceOfOrder - Connect Specific, How the order entered the Connect System, can be say “ShipStation” or “ConnectAPI”, read only
- Note that many fields are as of now not being actively used, mainly the UserId, Insurance Options, InternationalOptions and most of the AdvancedOptions (everything except the custom fields). All of those are ShipStation only features, so when doing writes to the API, these can be ignored. They are mainly there for backwards compatibility with ShipStation.
Shipment Details
Section titled “Shipment Details”You will notice the shipment details, while very similar, there are some changes to the properties on the ShipmentDto entity, when compared to ShipStation:
- ShipstationShipmentId - We send the original ShipStation ShipmentId as well, but as this property, of course, only if it is applicable
- FulfilledByService - Connect Specific, the Fulfillment Service, who is handling the packaging/delivery, not the same as the actual carrier
- StorefrontId - Connect Specific, the Storefront ID, a Storefront is equivalent to a ShipStation account, the default one will be used if not specified when writing to the API
- Notes - Additional Notes
- Status - The Status of the Shipment, can be: Created, Shipped, InTransit, Delivered, Cancelled. Note: Connect does not have full shipment tracking for all carriers as of now, so only certain carriers/fulfillment services will have the full range of covered Statuses.
- TrackingUrl - Url for Tracking, Example:
https://example.com/TR745 - ReceiveDate - Expected/Actual date the item was received.
- Note that some properties have also been removed!
Order Groups
Section titled “Order Groups”The order group is what Connect calls a “ShipStation Store.” They can be created through the API, though there is very little need to do so. You can read existing ones from the API, to get the corresponding Order Groups via it.