Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Postman Collections

Postman is a free, cross-platform app that makes it easy to experiment with APIs in a friendly interface. ShipStation API's official Postman collection help you get started quickly.

You can download Postman here. It's available for Mac, Windows, Linux, and Chrome OS.

Tutorial Video

Unfamiliar with Postman? Want to make sure you get the most out of our walkthrough collection? Then watch this video and follow along to learn how to use Postman and ShipStation API at the same time.

ShipStation API Walkthrough

Run in Postman

TIP: Be sure to run the requests in order. This collection uses Postman variables to connect each step to the next one, so you may get errors if you run them out of order.

Be sure to select the ShipEngine environment, which contains your API key.

Follow-along with descriptions and instructions for every request.

See API responses as raw JSON or as friendly visualizations.

Postman visualizers make large API responses easier to understand.

See your shipping labels right in Postman!

ShipStation API Reference
Reference Docs

This collection contains sample requests for every ShipStation API endpoint. It's great for reference purposes, or to see a birds-eye view of all of ShipStation API.

In addition to this collection, we also have API definitions in various formats. These also include every ShipStation API endpoint.

Instructions

  1. Run in Postman
    Click the following button to automatically open the collection. Run in Postman

  2. API Key
    Select the "ShipEngine" environment in Postman, which has your API key.

  3. Send Requests
    Start with the "Carrier Integrations" folder, and the "List your carriers" request. Be sure to run requests in order, since many steps of the walkthrough rely on previous steps.

  4. Descriptions
    Each folder and request has a description explaining what it does. You'll need to click the arrow next to the request name to see the description.

  5. Visualizations
    Rather that viewing raw JSON responses, try Postman's Visualize view to see the API response in a friendlier format.