Starshipit Developer Center

Build with the Starshipit API

Build, test, and maintain order import, label printing, live rates, order updates, webhooks, manifests, and tracking integrations.

Start quickstart Browse endpoints

First request

curl --request GET \
  --url https://api.starshipit.com/api/orders/unshipped \
  --header "StarShipIT-Api-Key: YOUR_API_KEY" \
  --header "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
  --header "Content-Type: application/json"

Required headers

Use your API key and subscription key on every request.

Build in stages

Start with a small payload, log request IDs, then move to production traffic.

Expected success

You should receive a `200` response with an orders array. If you receive `401` or `403`, verify both API keys and header names first.

Set up Starshipit first. Rates and labels use the couriers, sender addresses, packages, and rules configured in your account.

Plan testing

Quickstarts

Start with the core API flows

Import a test order

Create one test order, confirm it appears in Starshipit, and keep the returned order ID.

POST /api/orders

Print a label by API

Generate a controlled test label, store the returned tracking number, and avoid duplicate prints.

POST /api/orders/shipment

Get checkout rates

Request live rates with realistic package data and compare the result with your Starshipit setup.

POST /api/rates

Foundation

Choose the right fundamentals for each API

Starshipit API fundamentals

Base URL, headers, rate limits, pagination, retries, errors, and duplicate protection for the Starshipit API.

WMS API fundamentals

Base URL, authentication header, retries, errors, and integration habits for warehouse workflows.

Testing guidance

Use controlled test data, staged rollout checks, and production-readiness logging.

Troubleshooting API integrations

Check the API family, endpoint, credentials, headers, request body, and response details.

Workflows

Choose the job your integration needs to do

Import orders

Import orders from a source system, print labels in the Starshipit UI, then update the source system with tracking.

Order importStarshipit UITracking writeback

Print labels by API

Import or update orders, generate labels through the API, and return tracking to your fulfilment system.

External printLabelsTracking

Get checkout rates

Retrieve live rates from Starshipit for checkout, quote, ERP, middleware, or custom workflows.

Live ratesCheckoutCourier services

Print Starshipit-imported orders

Let Starshipit import orders from connected platforms, then trigger labels externally by API.

Find ordersPrint labelsAvoid duplicates

Update before printing

Correct, enrich, or finalise order details before labels are printed in the UI or through the API.

AddressesPackagesCustoms data

Reference

Look up endpoints, fields, and examples

View all reference

Starshipit API reference

Look up endpoint paths, request fields, response examples, and shared models for shipping integrations.

WMS API reference

Look up endpoint paths, parameters, request bodies, examples, and errors for warehouse workflows.

Recommended path

Step 1

Get credentials

Step 2

Run a quickstart

Step 3

Plan testing