Skip to main content

How to Get Your Shipwell API Key

Written by Shipwell Help

Shipwell provides API access so you can integrate with other systems, automate workflows, or build custom tools on top of the Shipwell platform. This article explains how to generate your API key.

Generating Your API Key

To generate an API key in Shipwell:

  1. Log into the Shipwell platform.

  2. Click Manage Company in the navigation menu.

  3. Select Developer Tools.

  4. Click API Keys.

  5. Click the option Get Token.

  6. Copy your new API key and store it somewhere safe β€” it will only be shown once.

Tip: Your API key should be treated like a password. Do not share it publicly or commit it to source control.

Authentication Format

When making API requests, include your key in the Authorization header:

Authorization: Token YOUR_API_KEY_HERE

Service Account / System Integration Credentials

If you need API credentials for a system-to-system integration (not tied to a human user account), contact your Customer Success Manager. They can help set up a service account with the appropriate permissions and credential management.

For API documentation and reference, visit the Shipwell Developer Portal or contact your CSM for access.

Did this answer your question?