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

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

Get Orders

Request

Get a paginated list of orders based on certain criteria.

Query

limitinteger[ 10 .. 500 ]

The maximum number of orders to retrieve per page.

pageinteger>= 1

The page number of results to retrieve.

order_idstring

Filter orders by a specific order ID.

from_datestring(date)

The start date for filtering orders (optional).

to_datestring(date)

The end date for filtering orders (optional). Must be after or equal to from_date.

curl -i -X GET \
  'https://stallionexpress.redocly.app/_mock/stallionexpress-v4/orders?from_date=2019-08-24&limit=10&order_id=string&page=1&to_date=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Headers

Request-Idstring

UUID for the request

Bodyapplication/json

pathstring

The path to the orders.

Example: "http://admin.stallionexpress.test/api/v4/orders"

per_pageinteger

The number of orders displayed per page.

Example: 100

tointeger

The page number of the current result set.

Example: 2

totalinteger

The total number of orders.

Example: 2

successboolean

Indicates whether the request was successful.

dataArray of objects(Order)

Array of orders.

Response

application/json

{
  "path": "http://admin.stallionexpress.test/api/v4/orders",
  "per_page": 100,
  "to": 2,
  "total": 2,
  "success": true,
  "data": [
    { … }
  ]
}

Create Order

Request

Create an order.

Bodyapplication/json

The order object that needs to be created.

store_idstringrequired

The unique identifier for the store.

Example: "1234"

namestring<= 40 charactersrequired

The name of the recipient.

Example: "Pramod Thomson"

companystring or null<= 40 characters

The company name of the recipient (optional).

address1string<= 50 charactersrequired

The first line of the delivery address.

Example: "30 Clearview Dr"

address2string or null<= 50 characters

The second line of the delivery address (optional).

citystring<= 35 charactersrequired

The city where the recipient is located.

Example: "Rock Springs"

province_codestring= 2 characters

The two-letter province or state code where the recipient is located.

Example: "WY"

postal_codestring<= 10 characters

The postal code or ZIP code of the recipient's location.

Example: "82901"

country_codestring= 2 charactersrequired

The two-letter country code of the recipient's country.

Example: "US"

phonestring or null<= 20 characters

The recipient's phone number (optional).

emailstring or null<= 50 characters

The recipient's email address (optional).

customer_idstring or null<= 50 characters

The customer ID associated with the order (optional).

carrier_codestring or null<= 50 characters

The carrier code for shipping (optional).

postage_codestring or null<= 50 characters

The postage code for shipping (optional).

package_codestring or null<= 50 characters

The package code for shipping (optional).

notestring or null<= 255 characters

Additional notes or comments for the order (optional).

weight_unitstring(WeightUnit)required

Enum"lbs""kg""g""oz"

weightnumber>= 0.01required

The weight of the order in the specified weight unit.

Example: 0.6

valuenumber>= 0.01required

The total value of the order.

Example: 10.5

currencystring(Currency)required

Enum"CAD""USD""EUR""AUD""GBP"

order_idstringrequired

The unique identifier for the order.

Example: "1234-1233"

order_atstring(date-time)required

The date and time when the order was placed.

Example: "2023-09-26 14:30:00"

storestring

Store Nickname or Identifier.

Example: "My Shopify Store"

itemsArray of objects(OrderRequestItem)required

Order Line Items.

items[].item_idstring

The unique identifier for the item.

Example: 1234

items[].titlestringrequired

The title or name of the item.

Example: "Cool T-Shirt"

items[].skustring or null

The SKU (Stock Keeping Unit) of the item (optional).

Example: "SKU123"

items[].hs_codestring or null

The HS (Harmonized System) code for customs (optional). Required if the shipment country_of_origin is CN/HK

Example: "620800"

items[].quantitynumber>= 1required

The quantity of the item in the order.

Example: 1

items[].valuenumber>= 0.01required

The value of the item.

Example: 10

items[].currencystring(Currency)required

Enum"CAD""USD""EUR""AUD""GBP"

items[].country_of_originstring or null= 2 characters

The two-letter country code indicating the country of origin for the item (optional). Required if the shipment is being sent to US

Example: "CN"

items[].warehouse_locationstring or null<= 50 characters

The location of the item in the warehouse (optional).

Example: "Warehouse A"

tagsArray of arrays

The tags for the order.

Example: "['this is a tag', 'this is another tag']"

curl -i -X POST \
  https://stallionexpress.redocly.app/_mock/stallionexpress-v4/orders \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "store_id": "1234",
    "name": "Pramod Thomson",
    "company": "string",
    "address1": "30 Clearview Dr",
    "address2": "string",
    "city": "Rock Springs",
    "province_code": "WY",
    "postal_code": "82901",
    "country_code": "US",
    "phone": "string",
    "email": "string",
    "customer_id": "string",
    "carrier_code": "string",
    "postage_code": "string",
    "package_code": "string",
    "note": "string",
    "weight_unit": "lbs",
    "weight": 0.6,
    "value": 10.5,
    "currency": "CAD",
    "order_id": "1234-1233",
    "order_at": "2023-09-26 14:30:00",
    "store": "My Shopify Store",
    "items": [
      {
        "item_id": 1234,
        "title": "Cool T-Shirt",
        "sku": "SKU123",
        "hs_code": "620800",
        "quantity": 1,
        "value": 10,
        "currency": "CAD",
        "country_of_origin": "CN",
        "warehouse_location": "Warehouse A"
      }
    ],
    "tags": "['\''this is a tag'\'', '\''this is another tag'\'']"
  }'

Responses

Successful operation

Headers

Request-Idstring

UUID for the request

Bodyapplication/json

successboolean

Indicates whether the request was successful.

orderobject(Order)

Response

application/json

{
  "success": true,
  "order": {
    "id": 0,
    "name": "string",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province_code": "string",
    "postal_code": "string",
    "country_code": "string",
    "phone": "string",
    "email": "user@example.com",
    "customer_id": "string",
    "carrier_code": "string",
    "postage_code": "string",
    "package_code": "string",
    "note": "string",
    "weight_unit": "string",
    "weight": 0.1,
    "value": 0.1,
    "currency": "string",
    "order_id": "string",
    "order_at": "2019-08-24T14:15:22Z",
    "store": "string",
    "tags": [],
    "items": [ … ],
    "shipment": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Get Order

Request

Retrieve a specific order by its auto generated unique ID.

Path

idstringrequired

The unique ID of the order to retrieve.

curl -i -X GET \
  'https://stallionexpress.redocly.app/_mock/stallionexpress-v4/orders/{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.

orderobject(Order)

Response

application/json

{
  "success": true,
  "order": {
    "id": 0,
    "name": "string",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province_code": "string",
    "postal_code": "string",
    "country_code": "string",
    "phone": "string",
    "email": "user@example.com",
    "customer_id": "string",
    "carrier_code": "string",
    "postage_code": "string",
    "package_code": "string",
    "note": "string",
    "weight_unit": "string",
    "weight": 0.1,
    "value": 0.1,
    "currency": "string",
    "order_id": "string",
    "order_at": "2019-08-24T14:15:22Z",
    "store": "string",
    "tags": [],
    "items": [ … ],
    "shipment": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Update Order

Request

Update an order.

Path

idstringrequired

The unique ID of the order to update.

Bodyapplication/json

The order object that needs to be updated.

store_idstringrequired

The unique identifier for the store.

Example: "1234"

namestring<= 40 charactersrequired

The name of the recipient.

Example: "Pramod Thomson"

companystring or null<= 40 characters

The company name of the recipient (optional).

address1string<= 50 charactersrequired

The first line of the delivery address.

Example: "30 Clearview Dr"

address2string or null<= 50 characters

The second line of the delivery address (optional).

citystring<= 35 charactersrequired

The city where the recipient is located.

Example: "Rock Springs"

province_codestring= 2 characters

The two-letter province or state code where the recipient is located.

Example: "WY"

postal_codestring<= 10 characters

The postal code or ZIP code of the recipient's location.

Example: "82901"

country_codestring= 2 charactersrequired

The two-letter country code of the recipient's country.

Example: "US"

phonestring or null<= 20 characters

The recipient's phone number (optional).

emailstring or null<= 50 characters

The recipient's email address (optional).

customer_idstring or null<= 50 characters

The customer ID associated with the order (optional).

carrier_codestring or null<= 50 characters

The carrier code for shipping (optional).

postage_codestring or null<= 50 characters

The postage code for shipping (optional).

package_codestring or null<= 50 characters

The package code for shipping (optional).

notestring or null<= 255 characters

Additional notes or comments for the order (optional).

weight_unitstring(WeightUnit)required

Enum"lbs""kg""g""oz"

weightnumber>= 0.01required

The weight of the order in the specified weight unit.

Example: 0.6

valuenumber>= 0.01required

The total value of the order.

Example: 10.5

currencystring(Currency)required

Enum"CAD""USD""EUR""AUD""GBP"

order_idstringrequired

The unique identifier for the order.

Example: "1234-1233"

order_atstring(date-time)required

The date and time when the order was placed.

Example: "2023-09-26 14:30:00"

storestring

Store Nickname or Identifier.

Example: "My Shopify Store"

itemsArray of objects(OrderRequestItem)required

Order Line Items.

items[].item_idstring

The unique identifier for the item.

Example: 1234

items[].titlestringrequired

The title or name of the item.

Example: "Cool T-Shirt"

items[].skustring or null

The SKU (Stock Keeping Unit) of the item (optional).

Example: "SKU123"

items[].hs_codestring or null

The HS (Harmonized System) code for customs (optional). Required if the shipment country_of_origin is CN/HK

Example: "620800"

items[].quantitynumber>= 1required

The quantity of the item in the order.

Example: 1

items[].valuenumber>= 0.01required

The value of the item.

Example: 10

items[].currencystring(Currency)required

Enum"CAD""USD""EUR""AUD""GBP"

items[].country_of_originstring or null= 2 characters

The two-letter country code indicating the country of origin for the item (optional). Required if the shipment is being sent to US

Example: "CN"

items[].warehouse_locationstring or null<= 50 characters

The location of the item in the warehouse (optional).

Example: "Warehouse A"

tagsArray of arrays

The tags for the order.

Example: "['this is a tag', 'this is another tag']"

curl -i -X PUT \
  'https://stallionexpress.redocly.app/_mock/stallionexpress-v4/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "store_id": "1234",
    "name": "Pramod Thomson",
    "company": "string",
    "address1": "30 Clearview Dr",
    "address2": "string",
    "city": "Rock Springs",
    "province_code": "WY",
    "postal_code": "82901",
    "country_code": "US",
    "phone": "string",
    "email": "string",
    "customer_id": "string",
    "carrier_code": "string",
    "postage_code": "string",
    "package_code": "string",
    "note": "string",
    "weight_unit": "lbs",
    "weight": 0.6,
    "value": 10.5,
    "currency": "CAD",
    "order_id": "1234-1233",
    "order_at": "2023-09-26 14:30:00",
    "store": "My Shopify Store",
    "items": [
      {
        "item_id": 1234,
        "title": "Cool T-Shirt",
        "sku": "SKU123",
        "hs_code": "620800",
        "quantity": 1,
        "value": 10,
        "currency": "CAD",
        "country_of_origin": "CN",
        "warehouse_location": "Warehouse A"
      }
    ],
    "tags": "['\''this is a tag'\'', '\''this is another tag'\'']"
  }'

Responses

Successful operation

Headers

Request-Idstring

UUID for the request

Bodyapplication/json

successboolean

Indicates whether the request was successful.

orderobject(Order)

Response

application/json

{
  "success": true,
  "order": {
    "id": 0,
    "name": "string",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province_code": "string",
    "postal_code": "string",
    "country_code": "string",
    "phone": "string",
    "email": "user@example.com",
    "customer_id": "string",
    "carrier_code": "string",
    "postage_code": "string",
    "package_code": "string",
    "note": "string",
    "weight_unit": "string",
    "weight": 0.1,
    "value": 0.1,
    "currency": "string",
    "order_id": "string",
    "order_at": "2019-08-24T14:15:22Z",
    "store": "string",
    "tags": [],
    "items": [ … ],
    "shipment": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Get Store Order

Request

Retrieve a specific order by its unique ID.

Path

store_idstringrequired

The unique ID of the store to retrieve.

order_idstringrequired

The user provided order ID of the order to retrieve.

curl -i -X GET \
  'https://stallionexpress.redocly.app/_mock/stallionexpress-v4/{store_id}/orders/{order_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.

orderobject(Order)

Response

application/json

{
  "success": true,
  "order": {
    "id": 0,
    "name": "string",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province_code": "string",
    "postal_code": "string",
    "country_code": "string",
    "phone": "string",
    "email": "user@example.com",
    "customer_id": "string",
    "carrier_code": "string",
    "postage_code": "string",
    "package_code": "string",
    "note": "string",
    "weight_unit": "string",
    "weight": 0.1,
    "value": 0.1,
    "currency": "string",
    "order_id": "string",
    "order_at": "2019-08-24T14:15:22Z",
    "store": "string",
    "tags": [],
    "items": [ … ],
    "shipment": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Stores

Operations

Batches

Operations

Locations

Operations

Credits

Operations

Stallion Express API (4)

Postage Types

Shipments

Orders

Get Orders

Request

Responses

Was this helpful?

Create Order

Request

Responses

Was this helpful?

Get Order

Request

Responses

Was this helpful?

Update Order

Request

Responses

Was this helpful?

Get Store Order

Request

Responses

Was this helpful?

Stores

Batches

Locations

Credits

Stallion Express API (4)

Postage Types

Shipments

Orders

Get Orders

Request

Responses

Was this helpful?

Create Order

RequestExpand all

Responses

Was this helpful?

Get Order

Request

Responses

Was this helpful?

Update Order

RequestExpand all

Responses

Was this helpful?

Get Store Order

Request

Responses

Was this helpful?

Stores

Batches

Locations

Credits

Request

Request