Getting Started with Custom Store

If you're new to REST APIs then be sure to read our introduction to REST to understand the basics. You'll also need to know to implement a few security features for your Custom Store implementation.

If you're new to developing REST APIs please check out our guide to popular REST frameworks as well as popular developer tools for testing and troubleshooting.

Once you're done implementing your Custom Store, you'll need to tell us about it! This can be accomplished by configuring it through the ShipStation client.

Info

Software Skills Required

Please note that the Custom Store requires advanced development skills to set up.

ShipStation's support for Custom Stores is limited, but if you do encounter errors during the setup process, our support team can provide additional insight so that you or your developer can take corrective actions.

How the Custom Store Works

To integrate with the Custom Store, you must expose three web endpoints that return JSON according to the format in this guide.

The required web endpoints are:

  • GET /: Allows ShipStation to check that your endpoints support the correct version of the Custom Store API, and also describes the methods that your endpoints support. Please see the root reference page for more information.

  • GET /orders: Allows ShipStation to pull in order information from your Custom Store, including recipient address, products, customers, etc. Please see the orders reference page for more information.

  • POST /events: Allows ShipStation to send shipment information back to the shopping cart of the marketplace when an order is shipped, including shipping method, shipping status, tracking number, and more. Please see the events reference page for more information.

When your web endpoints are ready, you can then connect ShipStation to your store via the Custom Store connection option. Once connected, you can then import order information and send back shipment information.

Need some help?

We’re always here to help with any of your questions. Here are some ways to find answers or get in touch with our team:

  1. Take advantage of our 24-hour live chat, Monday through Friday (CST) each week. Simply open the chat window in the bottom right corner of your browser to get your questions answered.

  2. Search our Help Center articles for answers to your questions.

  3. Have some feedback or experiencing an issue? Create a Ticket in our Help Center.

  4. Email our Sales and Support team directly.