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

Get Stores

Request

Get a list of all stores associated with the authenticated user. (This only shows store create via the API.)

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

Responses

Successful operation

Headers
Request-Idstring

UUID for the request

Bodyapplication/json
successboolean

Indicates whether the request was successful.

storesArray of objects(Store)

Array of stores

Response
application/json
{
  "success": true,
  "stores": [
    { … }
  ]
}

Create Store

Request

Create a new store for the authenticated user.

Bodyapplication/json

The store data that needs to be created.

identifierstring

Unique identifier for the store

curl -i -X POST \
  https://stallionexpress.redocly.app/_mock/stallionexpress-v4/stores \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "identifier": "string"
  }'

Responses

Successful operation

Headers
Request-Idstring

UUID for the request

Bodyapplication/json
successboolean

Indicates whether the request was successful.

storeobject(Store)
Response
application/json
{
  "success": true,
  "store": {
    "id": 0,
    "identifier": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "store_type": "string"
  }
}

Delete Store by ID

Request

Delete a store by its unique ID.

Path
idintegerrequired

The unique ID of the store to delete.

curl -i -X DELETE \
  'https://stallionexpress.redocly.app/_mock/stallionexpress-v4/stores/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Headers
Request-Idstring

UUID for the request

Bodyapplication/json
successboolean

Indicates whether the request was successful.

Response
application/json
{
  "success": true
}

Batches

Operations

Locations

Operations

Credits

Operations