Explains the Modern Retail hybrid API, custom store integration, requirements, and setup.
Use Modern Retail to let your orders flow effortlessly from ShipStation to your POS or ERP. You can ship from multiple brick-and-mortar stores, warehouses, or wherever you keep inventory by using rules that you create within Modern Retail's Ship from Store feature to route your incoming orders.
To connect Modern Retail with ShipStation you will combine two methods: a Custom Store connection and an API connection.
For help configuring your Modern Retail account or for information about the available features, order statuses, or details included in the marketplace notification, please contact Modern Retail.
Connection Requirements:
-
An active account with Modern Retail.
-
Your Modern Retail API Key and Secret (found in the Admin Panel: Settings & API Keys).
To connect your Modern Retail store to ShipStation, you will need to open two separate browser windows and follow these three distinct procedures:
-
Get your Modern Retail API Keys to paste into ShipStaton when you add a Custom Store,
-
Configure Modern Retail as a Custom Store in ShipStation,
-
Get your API Key and API Secret from within ShipStation, then copy + paste them both into the Modern Retail account portal.
Modern Retail also has a similar article that describes how to connect your store to ShipStation.
To find the API Keys in your Modern Retail account, go to the Admin Panel > Settings > API Keys.
You can also see this Modern Retail Configuring Your API article that describes the process in greater detail.
To connect your Modern Retail account to ShipStation as custom store , do the following:
-
Choose the Custom Store option.
-
Enter the following URL in the URL to Custom XML Page: https://staging.modernretail.com/empty.xml.
The status fields map your order statuses to ShipStation's order statuses. This determines where orders will import to in ShipStation. These fields are case sensitive.
If you are not already familiar with their order statuses, you will need to contact Modern Retail to get details about the statuses and how to map them into ShipStation. The table below provides details about the form fields in the connection window:
URL to custom CML Page
This is the location of your Web Endpoint. This field is where you enter the URL: https://staging.modernretail.com/empty.xml
Unpaid Status
This is the name of the status in your system that indicates an order is not yet paid for and not yet ready to be shipped.
Multiple statuses may be separated by a comma.
Paid Status
This is the name of the status in your system that indicates an order is paid and ready to ship.
Shipped Status
This is the name of the status in your system that indicates an order is shipped.
Cancelled Status
This is the name of the status in your system that indicates an order is cancelled.
On-Hold Status
This is the name of the status in your system that indicates an order is on hold.
-
Enter the Modern Retail API Key (found in the Admin Panel: Settings & API Keys) into the Username field, and the API Secret in the Password field.
-
Click on Test Connection after you complete the previously mentioned fields in the Custom Store window in ShipStation, then click the Connect button
Once the connection is complete, ShipStation will begin communicating with your Web Endpoint to obtain order information.
You will still need to add your ShipStation API Key and Secret in your Modern Retail account to complete the integration.
-
Click Generate New API Keys if no key and secret are listed yet.
-
Copy your ShipStation API Key and API Secret, return to the Modern Retail browser, and go to the API Keys page in the Admin Panel > Settings > API Keys.
-
Select the New button beneath the column labelled External Integration Keys.
Be sure that you add a new External Integration Key, and not a new Modern Retail API Key.
-
Enter the API Key from ShipStation in the Site field, and the API Secret in the Secret Token field.
Congratulations! You have now completely configured the integration between ShipStation and Modern Retail.
We also recommend that you rename the custom store you've just set up. You can do this by going back in ShipStation to the Selling Channels > Store Setup page, and selecting Edit to the right of the Custom Store.