Description of ShipStation's REST API capabilities, how to generate access tokens, and how to obtain support for REST API issues.
Our REST API is available for any plan and allows for read access to almost all data in your account, and write access to create specific objects, like Orders, Customers, and Products. The API is a great way to get data directly to and from ShipStation, like creating orders, customers, and querying order & shipping data.
ShipStation strives to streamline shipping for online sellers, no matter where they sell their products online. We are continuously adding new marketplaces, shopping carts, and integration tools because we know the ecommerce space is growing. As a result, we’ve worked hard to provide developer resources to build custom integrations with ShipStation. Check out the ShipStation Developer Portal for full documentation on the ShipStation REST API.
Our API allows developers to build applications that interface with the ShipStation platform. The API can be used to handle many tasks including:
-
Managing Orders
-
Managing Shipments
-
Creating Shipping Labels
-
Retrieving Shipping Rates
-
and more!!!
There is a spreadsheet of API codes for many of our available shipping services attached to this article for your reference. It only includes service codes for publicly available shipping services.
To use ShipStation's API, you'll need to generate an API Key and Secret which will be included with any calls made to the API. The Key and Secret are used to authenticate the API calls so that ShipStation updates the information within your specific account.
-
Click Generate New API Keys if no key and secret are listed yet.
-
Copy your key and secret.
You can then provide them to the account you wish to access the ShipStation API.
After the API keys have been generated, you'll be able to copy them from this page and provide them as needed to any API developers.
Your ShipStation account can issue only a single set of API keys at a time. The same set of API keys can be used for multiple API applications. If you generate new keys at any point, be sure to provide the new keys to any application that uses them, or the connection with ShipStation will no longer function.
There is no way to limit the scope of API access at this time. If an API developer has access to your key and secret, they'll be able to perform any ShipStation API actions available.
Before you get started with ShipStation's API, we highly recommend reviewing the ShipStation Developer Portal for a full overview of all the actions that can be performed via API calls. This documentation also provides you with examples of calls and responses for API communication, and detailed information on how to authenticate your API key and secret for API calls.
ShipStation's support team is not able to help you design or build an API integration, but we can certainly help test API calls and make sure everything is working as designed, or help you identify information within the call body that would cause errors. If you're running into issues with one or more of your API calls and need some assistance, email our API Support team directly at apisupport@shipstation.com and our team will help look into the issue with you.
In order to better assist you, please make sure to include the following information:
-
The API action you were trying to perform (ex: List Shipments, Create Orders, etc.)
-
The full API endpoint you were contacting (ex: https://ssapi.shipstation.com/shipments?orderNumber=zen-285858-1)
-
If making a POST API call, the full JSON body of the request.
-
The status code number for the API response.
-
The full JSON response to the API call.
-
Please note: The ShipStation Open API does not support non-Roman character sets like Japanese, Chinese, and Cyrillic. These sets also are often not supported by the carrier's label API, resulting in ??? symbols or blank spaces on the label where the characters should be.
Support for API Issues
Without the above information, it can be difficult for ShipStation to troubleshoot API issues. If you're unsure how to obtain that information, we recommend you reach out to your API developer directly for assistance pulling any available logs. We also recommend you CC your API developer on any communication to apisupport@shipstation.com.