Our API allows developers to build applications that interface with the ShipStation platform. You can use the API to handle many tasks, including:
-
Manage Orders
-
Manage Shipments
-
Create Shipping Labels
-
Retrieve Shipping Rates
-
and more!!!
ShipStation has recently launched the V2 API, a new version of our API that includes Shipping and Inventory endpoints. The previous Open API is now called V1 API and is still operational.
ShipStation strives to streamline shipping for online sellers, no matter where they sell their products online. We continuously add 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 this ShipStation Developer page for full V2 documentation and this page for the V1 Open API documentation. See the ShipStation Developer Portal for full documentation on the ShipStation REST API.
The V2 API is a great way to get data directly to and from ShipStation, especially when you create orders, add customers, or query your order and shipping data.
V1 API will be limited to only those accounts on Scale-Gold, Accelerate, or higher plans. V1 API will not be available via the add-on or on lower plans.
For ShipStaton accounts on a Scale-Gold plan, Accelerate plan, or higher, you will have access to the V2 API and V1 API endpoints. For V1 you can generate two API keys. For accounts in any country on any other subscription plan, the V2 API Inventory endpoints will be available as a paid add-on.
Attached to the end of this article, you will find for your reference spreadsheets with API codes for many of our available shipping services. It only includes service codes for publicly available shipping services.
Use Multiple V1 API Keys for a Single Platform
ShipStation allows two V1 API keys to facilitate the process of rotating keys within the same integration. This rotation is to ensure you a consistent workflow and security. These keys are not to be used for two distinct integrations.
When your API key is about to expire, we will remind you by email that you need to rotate your keys before the current one becomes inactive.
Scale-Gold plan (🇺🇸 US, 🇨🇦 CA) or Accelerate plan (🇬🇧 UK, 🇦🇺 AU, 🇳🇿 NZ, 🇪🇺 EU) or higher: the V1 API will be automatically included for accounts on these plans. Please know:
-
You can continue to access V1 in the same way as before.
-
Your API Keys will expire. You can generate a new API key to rotate it into use before the first one expires. You will see no time loss in your workflow and experience greater security.
Accounts on any plan lower than Scale-Gold, please know that:
-
You will no longer be able to generate V1 API (Shipstation openAPI) keys.
-
V1 API (Shipstation openAPI) will not be available via the add-on. Instead, we encourage you to upgrade and try V2 API.
Scale-Gold plan (🇺🇸 US, 🇨🇦 CA) or Accelerate plan (🇬🇧 UK, 🇦🇺 AU, 🇳🇿 NZ, 🇪🇺 EU) or higher: the V2 ShippingAPI will be automatically included for accounts on these plans.
The V2 endpoints are similar to the V1 API but with expanded features. They are available now in their early-access state and we are continuing to develop this API. The two main aspects include an Inventory API and a Shipping API.
Shipping API:
These endpoints include everything related to shipping like rates, customs forms, labels, tracking, etc.
Inventory API:
You can activate the ShipStation Inventory API via the Account add-ons for any plan level. The Inventory API provides powerful tools to manage inventory across multiple warehouses. With these API endpoints, you can retrieve stock levels, set and update SKU counts, update inventory quantities, and synchronize data between ShipStation, inventory warehouses, and external systems.
FEATURES:
-
Real-time Inventory Tracking: Get accurate stock levels across all locations.
-
Batch Updates: Modify inventory quantities in bulk.
-
Warehouse Management: Assign inventory to specific warehouses.
-
Stock Adjustments: Track changes due to sales, returns, or manual adjustments.
Scale-Gold, Accelerate or higher:
-
You have access to both the V1 API and V2 API endpoints, and you can generate multiple keys for V1.
Account plans lower than Scale-Gold or Accelerate:
-
The V1 API will not be available. Any API Keys currently in use will expire or will return a 402 response.
-
The V2 API will not be available. Any existing V2 API keys that are not Inventory API Add-On will return a 402 response
-
You can activate the Inventory API via the Account add-ons for any plan level.
-
The Inventory API is a specific subset of V2 API endpoints that are separate from the base V2 API. Anyone who has enabled the Inventory API add-on can use these particular endpoints, regardless of plan level and regardless of access to the V2 API as a whole.
-
To use ShipStation's API, you'll need to generate an API key, and for V1, an API secret as well. This information will be included with any calls made to the API. The API key and API secret are used to authenticate the API calls so that ShipStation updates the information within your specific account.
New Accounts Gain Access After Email Verification
For security purposes, we require account verification by email after you have signed up for a ShipStation account and before you can generate API keys.
For quicker access or urgent requirements during the wait time for email verification to clear, feel free to contact your trial account manager or contact ShipStation support for assistance.
To get your API key and secret in ShipStation:
-
Select your API Version from the dropdown and click Generate API Key.
We will email a verification link to your user email address.
IMPORTANT: Generated API Keys
API keys and API secrets will only show in ShipStation’s UI when they are generated and only to the user who generated them. They will be hidden from view in the ShipStation UI after you navigate away from the page.
We strongly recommend that you copy the API keys and API secrets and keep a record of these immediately upon their generation.
API Key Generation Limited to the Account Owner Only
-
Only the Account Owner can generate API keys. They will need to verify their email to access the API Key Generator.
-
API keys can only be viewed in plain text. This view will be available only once, immediately after the keys are generated.
-
If you are unsure who is considered to be your account’s owner, contact support@shipstation.comto confirm.
-
-
Check the verification link we send to your user email address and then generate the keys again.
The Generate API Key button will reset once you verify your email.
-
Set the expiration (3, 6, or 12 months) for your new API Key, then click Generate.
-
Click the Copy icon
to copy your newly generated API Key. Be sure to store it securely.
You can then provide your key and secret to the account you wish to access the ShipStation API.
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.
Rotating an API key means replacing the old one with a new one. Periodically, you’ll need to create a new key and update your integrations.
To rotate an API key:
-
Go to Settings > Account > API Settings.
-
Select your API Version from the dropdown and click Generate API Key.
If you already have two sets of API keys, delete one before generating a new set.
See V2 in the Dropdown? Here's What You Need to Know.
If you do not already have V2 API keys generated, there’s no need to generate V2 API keys for this process. Keep in mind that V1 and V2 API keys aren’t interchangeable—they’re used for different types of integrations.
We will email a verification link to your user email address.
-
Check the verification link we send to your user email address and then generate the keys again.
The Generate API Key button will reset once you verify your email.
-
Set the expiration (3, 6, or 12 months) for your new API Key, then click Generate.
-
Click the Copy icon
-
Copy and paste your new API Key(s) your external integrations, platforms, and systems that use it.
-
Locate the API Key you no longer want, and click the Trash Can icon
beside it.
-
Click Delete Key in the Delete API Key popup.
Deleting an API Key cannot be undone. You will need to update any platforms that use that key when you generate a new key.
Before you get started with ShipStation's API, we highly recommend that you review the ShipStation Developer Portal for a full overview of all the actions that the API calls can perform. 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.
Documentation:
See this ShipStation Developer page for full V2 documentation and this page for the V1 Open API documentation.
ShipStation's support team cannot 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.
For V1 API Support please apisupport@shipstation.com and our team will help look into the issue with you.
For V2 API Support please shippingapisupport@shipstation.com and our team will help look into the issue with you.
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.
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 that you contact your API developer directly for assistance pulling any available logs. We also recommend that you CC your API developer on any email communication to V1 apisupport@shipstation.com or to V2 shippingapisupport@shipstation.com
-
Retrieve Shipping Rates may be unavailable for some carriers and services.
Some carriers and services for some carriers may be unavailable to retrieve shipping rates via
getRatecalls. For example,getRatecalls will not return usable rates for UPS Ground Saver ®. To ensure success, check with your carrier first about which of their available shipping services support rate browsing. -
The ShipStation V1 API does not support the Reship an Order function.
-
The ShipStation Open API does not support non-Roman character sets like Japanese, Chinese, and Cyrillic. These sets are often not supported by the carrier's label API, resulting in ??? symbols or blank spaces on the label where the characters should be.