Access & authentication

The Shipperfy API gives merchants a single place to:

• Query orders across all of their connected sales channels.
• Get quotes across Shipperfy carrier rates and the carrier accounts they have connected.
• Create shipments and fetch their labels.
• Track shipments.

Connecting sales channels and carriers is done in the Shipperfy app, not through the API. See Integrations.

Request access#

API credentials are generated manually. Contact us with a short description of what you want to build and we will issue your credentials.

Base URL#

https://api.shipperfy.com

Authenticate#

Once you have your credentials, request an access token from the login endpoint, then send it with every request:

POST /access/login
Content-Type: application/json

{
  "client_id": "<your client id>",
  "client_secret": "<your client secret>",
  "grant_type": "client_credentials"
}

GET /store/orders/<installId>
Authorization: Bearer <access_token>

Responses use a common envelope:

{
  "status": 200,
  "message": "OK",
  "payload": { }
}

Tokens expire. Request a new one when you receive a 40001 (token expired) error. See Error messages for the error codes.