Find your API key and build a TrackPackage request

Summary: To use the Shipstore API, get your API key from the profile screen, then call the tracking endpoint. Two things break most first calls: leaving the placeholder brackets in the URL, and leaving out an environment path segment (like /prod) that some sites need.

Before you start

You need access to the Admin tab and the profile you will use.
Know the exact base URL for your own Shipstore site. Some sites need an extra path segment (like /prod) before /api.

Steps

Open the Admin tab, then the Profile tab, and select the profile you will call the API for.
Copy the API key shown on that profile screen.
Build the tracking request as: GET {your base URL}/api/Track/TrackPackage/{tracking number}
Replace {your base URL} with the exact base URL for your site. If your site uses an environment segment like /prod, put it before /api.
Replace {tracking number} with a real tracking number and delete the brackets.
Send the request with your API key, using your API client's authentication.

What you should see

The call returns tracking data for a known shipment. Adding the correct base URL and removing the placeholder brackets turns a failing call into a working one.

If something goes wrong

The call returns nothing or "not found": the base URL or environment segment is wrong. Add the /prod (or your site's) segment before /api.

The call never resolves: you left the brackets around the tracking number. Remove them.

Integrations Administration

Knowledge Base