¶ ShipStation Custom Store Setup
The Shipping configuration is done on both the ShipStation and Freedom end. The configuration required for the ShipStation side of the integration is primarily when configuring a Custom Store. Though the following documentation provides some information on how to configure it, it's recommended to check with ShipStation if you are having trouble with the configuration.
¶ Configuring the Custom Store in ShipStation
According to ShipStation, the Custom Store allows you to import orders into ShipStation in a single click and enables ShipStation to automatically send shipment status and tracking information updates back to your cart or marketplace once a label is created.
For more information on the Custom Store, please see ShipStation's Custom Store Guide.
NOTE: The ShipStation account used to create the Custom Store must have administrative privileges. If the account does not have these privileges, a permission 403 error will be returned, and the account will not be allowed to create the Custom Store. Additionally, only accounts without administrative privileges can test the connection.
In ShipStation, navigate to Store Setup through the steps below to find "Custom Store". This Custom Store is where you will be entering the API Endpoint, API Credentials and the Order Status Mappings.
- Go to shipstation.com and login
- Once logged in, use the wrench icon in the upper left-hand corner of the page
- On the Settings page, on the left-hand side under Selling Channels, choose Store Setup
- Select the "Connect a Store or Marketplace" button
- When asked which store to connect to, use the search function to find "Custom Store"
For the Custom Store, you will need to fill in the following information:
- URL to Customer XML Page: https://webapi.bydesign.com/CLIENT/api/Shipping/ShipStation
- Ensure to replace CLIENT with your install folder name. For example: https://webapi.bydesign.com/adapturedemo/api/Shipping/ShipStation
- Username/Password: This is the Integration Provider Account created in Integration Provider Setup
- Custom Statuses: Towards the bottom of the setup page are the custom statuses. ShipStation identifies order statuses differently from Freedom and will need to be remapped to ensure that a valid status is passed to Freedom on any order updates from ShipStation. Below are the ShipStation and Freedom equivalent mappings:
ShipStation Freedom Unpaid Status entered Paid Status posted Shipped Status shipped Cancelled Status void On-Hold Status on-hold
On-Hold Status: Freedom does not support an On-Hold status. The integration requires a mapped value. If an On-Hold Status update is made to the order from ShipStation, there will be no change to the order status within Freedom.
Cancelled Status: You may run into an issue when the Cancelled Status is mapped as Void because ShipStation will not accept any changes to an order once it has been cancelled. There are 2 alternatives that can be used if you encounter this:
(1) You can map Void to the On-Hold Status, but you will need to review this with ShipStation before hand to ensure that this will work appropriately in your configuration.
(2) you can leave the Cancelled Status mapped to Freedom's use of Void, but that will require you to duplicate voided orders to modify and repost them rather than modifying the existing order.
¶ Saving the Configuration
Once you've entered the above infromation, the next step is to select "Test Connection" in the Custom Store Configuration. This will attempt to pull an order from within 24 hours via API to confirm the integration. As a result, you may need to create and post a test order, or modify an existing order, to be picked up by the integration in this step.
If you have created a test order, please do not forget to void it once you have completed your testing.
Once the connection has been successfully, select "Connect" to save the configuration, and proceed with the Fulfillment Setup.