Download OpenAPI specification:Download
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.
Get a list of all available postage types
Successful operation
Unauthenticated
Internal error
{- "success": true,
- "postage_types": [
- "USPS First Class Mail"
]
}
Validates shipment details and returns all available rates.
Shipment details
Successful operation
Unauthenticated
Validation Error
Internal error
{- "to_address": {
- "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",
- "is_residential": true
}, - "return_address": {
- "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",
- "is_residential": true
}, - "is_return": false,
- "weight_unit": "lbs",
- "weight": 0.6,
- "length": 9,
- "width": 12,
- "height": 1,
- "size_unit": "cm",
- "items": [
- {
- "description": "Two pair of socks",
- "sku": "SKU123",
- "quantity": 2,
- "value": 10,
- "currency": "CAD",
- "country_of_origin": "CN",
- "hs_code": "123456"
}
], - "package_type": "Parcel",
- "postage_types": [ ],
- "signature_confirmation": true,
- "insured": true,
- "region": null,
- "tax_identifier": {
- "tax_type": "IOSS",
- "number": "IM1234567890",
- "issuing_authority": "GB"
}
}
{- "success": true,
- "rates": [
- {
- "postage_type": "USPS First Class Mail",
- "package_type": "Parcel",
- "trackable": true,
- "base_rate": 10,
- "add_ons": [
- null
], - "rate": 10,
- "tax": 0,
- "total": 0,
- "currency": "CAD",
- "delivery_days": "2"
}
]
}
Get the list of paginated shipments by different search parameters.
Successful operation
Unauthenticated
Validation Error
Internal error
{- "data": [
- null
], - "links": null,
- "meta": null
}
Create a shipment and return the postage label.
The shipment object that needs to be created. Note that size fields are required for any shipments with the package type of Parcel.
Successful operation
Unauthenticated
Validation Error
Internal error
{- "to_address": {
- "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",
- "is_residential": true
}, - "return_address": {
- "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",
- "is_residential": true
}, - "is_return": false,
- "weight_unit": "lbs",
- "weight": 0.6,
- "length": 9,
- "width": 12,
- "height": 1,
- "size_unit": "cm",
- "items": [
- {
- "description": "Two pair of socks",
- "sku": "SKU123",
- "quantity": 2,
- "value": 10,
- "currency": "CAD",
- "country_of_origin": "CN",
- "hs_code": "123456"
}
], - "package_type": "Parcel",
- "signature_confirmation": false,
- "postage_type": "USPS First Class Mail",
- "label_format": "pdf",
- "is_fba": false,
- "is_draft": false,
- "insured": true,
- "region": null,
- "tax_identifier": {
- "tax_type": "IOSS",
- "number": "IM1234567890",
- "issuing_authority": "GB"
}
}
{- "success": true,
- "label": "base64_label",
- "tracking_code": "9400111969000940000011",
- "message": "Shipment successfully completed",
- "shipment": null,
- "rate": {
- "postage_type": "USPS First Class Mail",
- "package_type": "Parcel",
- "trackable": true,
- "base_rate": 10,
- "add_ons": [
- null
], - "rate": 10,
- "tax": 0,
- "total": 0,
- "currency": "CAD",
- "delivery_days": "2"
}
}
Fetch a shipment tracking details by different search parameters
Successful operation
Unauthenticated
Validation Error
Internal error
{- "success": true,
- "status": "Postage Expired",
- "events": [
- null
], - "details": {
- "ship_code": 2012121234,
- "destination": "Toronto ON, CA",
- "tracking": "123123123123123123",
- "carrier_phone": "12312341234"
}
}
Get a shipment
Successful operation
Unauthenticated
Not Found
Internal error
{- "success": true,
- "label": "base64_label",
- "tracking_code": "9400111969000940000011",
- "message": "Shipment successfully completed",
- "shipment": null,
- "rate": {
- "postage_type": "USPS First Class Mail",
- "package_type": "Parcel",
- "trackable": true,
- "base_rate": 10,
- "add_ons": [
- null
], - "rate": 10,
- "tax": 0,
- "total": 0,
- "currency": "CAD",
- "delivery_days": "2"
}
}
Requests a void for a shipment with the provided id.
Successful operation
Unauthenticated
Not Found
Validation Error
Internal error
{- "success": true,
- "message": false
}
Get a paginated list of orders based on certain criteria.
Successful operation
Unauthenticated
Internal error
{- "per_page": 100,
- "to": 2,
- "total": 2,
- "success": true,
- "data": [
- {
- "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,
- "value": 0,
- "currency": "string",
- "order_id": "string",
- "order_at": "2019-08-24T14:15:22Z",
- "store": "string",
- "tags": [ ],
- "items": [
- {
- "item_id": "string",
- "title": "string",
- "sku": "string",
- "hs_code": "string",
- "quantity": 0,
- "value": 0,
- "currency": "string",
- "country_of_origin": "string",
- "warehouse_location": "string"
}
], - "shipment": null,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Create an order.
The order object that needs to be created.
Successful operation
Unauthenticated
Conflict
Validation Error
Internal error
{- "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']"
}
{- "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,
- "value": 0,
- "currency": "string",
- "order_id": "string",
- "order_at": "2019-08-24T14:15:22Z",
- "store": "string",
- "tags": [ ],
- "items": [
- {
- "item_id": "string",
- "title": "string",
- "sku": "string",
- "hs_code": "string",
- "quantity": 0,
- "value": 0,
- "currency": "string",
- "country_of_origin": "string",
- "warehouse_location": "string"
}
], - "shipment": null,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Update an order.
The order object that needs to be updated.
Successful operation
Unauthenticated
Conflict
Validation Error
Internal error
{- "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']"
}
{- "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,
- "value": 0,
- "currency": "string",
- "order_id": "string",
- "order_at": "2019-08-24T14:15:22Z",
- "store": "string",
- "tags": [ ],
- "items": [
- {
- "item_id": "string",
- "title": "string",
- "sku": "string",
- "hs_code": "string",
- "quantity": 0,
- "value": 0,
- "currency": "string",
- "country_of_origin": "string",
- "warehouse_location": "string"
}
], - "shipment": null,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Retrieve a specific order by its auto generated unique ID.
Successful operation
Unauthenticated
Order not found
Internal error
{- "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,
- "value": 0,
- "currency": "string",
- "order_id": "string",
- "order_at": "2019-08-24T14:15:22Z",
- "store": "string",
- "tags": [ ],
- "items": [
- {
- "item_id": "string",
- "title": "string",
- "sku": "string",
- "hs_code": "string",
- "quantity": 0,
- "value": 0,
- "currency": "string",
- "country_of_origin": "string",
- "warehouse_location": "string"
}
], - "shipment": null,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Retrieve a specific order by its unique ID.
Successful operation
Unauthenticated
Order not found
Internal error
{- "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,
- "value": 0,
- "currency": "string",
- "order_id": "string",
- "order_at": "2019-08-24T14:15:22Z",
- "store": "string",
- "tags": [ ],
- "items": [
- {
- "item_id": "string",
- "title": "string",
- "sku": "string",
- "hs_code": "string",
- "quantity": 0,
- "value": 0,
- "currency": "string",
- "country_of_origin": "string",
- "warehouse_location": "string"
}
], - "shipment": null,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Get a list of all stores associated with the authenticated user. (This only shows store create via the API.)
Successful operation
Unauthenticated
Internal error
{- "success": true,
- "stores": [
- {
- "id": 0,
- "identifier": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "store_type": "string"
}
]
}
Create a new store for the authenticated user.
Successful operation
Unauthenticated
Validation Error
Internal error
{- "identifier": "string"
}
{- "success": true,
- "store": {
- "id": 0,
- "identifier": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "store_type": "string"
}
}
Creates a new batch to be used when creating shipments.
Successful operation
Unauthenticated
Internal error
{- "success": true,
- "batch_id": "18179823"
}
Gets a list of all current Stallion Express locations.
Successful operation
Unauthenticated
Internal error
{- "success": true,
- "locations": [
- null
]
}
Add credits using hte account's default credit card
Successful operation
Unauthenticated
Validation Error
Internal error
{- "amount": 100
}
{- "success": true,
- "amount": "0.00"
}