Generating an API Key

Why does this need to happen?

ShipStation requires all API keys to expire on a regular schedule as a security measure. An API key is essentially a password that allows your website to communicate with your ShipStation account for things like displaying shipping rates. When the key expires, that connection stops working.

ShipStation will email you a reminder roughly 30 days before your key expires. When you receive that email, it's time to generate a new key and send it to us so we can update your website.

Note: Only the primary account holder on your ShipStation account can generate API keys. If you're not sure whether that's you, check whether you see an option to generate keys in the steps below — if not, you may need to have the account owner complete this process.

How to generate a new API key

  1. Log in to your ShipStation account at https://signin.shipstation.com/login.

  2. Click the gear icon in the top-right corner to open Account Settings.

  3. In the left-hand menu, go to Account > API Settings.

  4. From the dropdown, select V2 API.

  5. If you already have an existing key listed, you can leave it — you don't need to delete it first.

  6. Click Generate API Key and select an expiration of 12 months.

  7. ShipStation will display your new API Key and API Secret. Copy both values immediately — they will only be shown once.

Important: The API Key and API Secret are only visible at the moment they are generated. Once you navigate away from the page, they cannot be retrieved again. Make sure you copy both before closing the window.

What to do next

Reply to the email you received from us with both values:

  1. Your new API Key

  2. Your new API Secret

Once we receive them, we'll update your website's integration and confirm everything is working. You don't need to do anything else.