Skip to main content

Authentication

HeaderRequiredDescription
X-API-KeyYesAPI key format: inex_api_{32 lowercase hex characters}
Content-TypeYes (POST)application/json for rate and ship

The API key must:

  • Be active and not expired (if expiresAt is set)
  • Have integrationType = public-api
  • Include the scope required for each endpoint (see below)

If the key record has an empty scopes array, scope checks are skipped (all scopes allowed).

Scopes

EndpointRequired scope
GET /packaging-types(none — any valid public-api key)
GET /carriers(none — any valid public-api key)
GET /carrier-services(none — any valid public-api key)
POST /rateshipments:rate
POST /ship/{rateResponseId}shipments:create
GET /labels/{orderId}shipments:labels or shipments:create
GET /labels/{orderId}/{labelType}shipments:labels or shipments:create
GET /track/{orderId}shipments:track
DELETE /shipments/{orderId}shipments:cancel