Stallion Express API (4)

Access to the sandbox environment can be provided upon request. (Not all rates are available in the Sandbox environment). API token can be found under "Account Settings > API Token" in the Stallion Express dashboard. To help us assist you more effectively when troubleshooting, please make sure to include the Request-ID in your email communication.

Download OpenAPI description
stallionexpress-v4.json
stallionexpress-v4.yaml
Overview
API Support developersupport@stallionexpress.ca
Languages
Servers
Mock server
https://stallionexpress.redocly.app/_mock/stallionexpress-v4/
Production server (uses live data)
https://ship.stallionexpress.ca/api/v4/
Sandbox server (uses test data)
https://sandbox.stallionexpress.ca/api/v4/

Postage Types

Operations

Shipments

Operations

Orders

Operations

Stores

Operations

Batches

Operations

Locations

Operations

Credits

Operations

Get Credits

Request

Return the current account balance

curl -i -X GET \
  https://stallionexpress.redocly.app/_mock/stallionexpress-v4/credits \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Headers
Request-Idstring

UUID for the request

Bodyapplication/json
successboolean
Example: true
amountstring
Example: "0.00"
Response
application/json
{
  "success": true,
  "amount": "0.00"
}

Add Credits

Request

Add credits using hte account's default credit card

Bodyapplication/jsonrequired

Amount of credits to add

amountinteger(int64)
Example: 100
curl -i -X POST \
  https://stallionexpress.redocly.app/_mock/stallionexpress-v4/credits \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 100
  }'

Responses

Successful operation

Headers
Request-Idstring

UUID for the request

Bodyapplication/json
successboolean
Example: true
amountstring
Example: "0.00"
Response
application/json
{
  "success": true,
  "amount": "0.00"
}