# Stallion Express API

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.

Version: 4

## Servers

Production server (uses live data)
```
https://ship.stallionexpress.ca/api/v4
```

Sandbox server (uses test data)
```
https://sandbox.stallion.ca/api/v4
```

## Security

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Stallion Express API](https://stallionexpress.redocly.app/_bundle/stallionexpress-v4.yaml)

## Postage Types

### Get Postage Types

 - [GET /postage-types](https://stallionexpress.redocly.app/stallionexpress-v4/postage-types/getpostagetypes.md): Get a list of all available postage types

## Shipments

### Get Rates

 - [POST /rates](https://stallionexpress.redocly.app/stallionexpress-v4/shipments/getrates.md): Validates shipment details and returns all available rates.

### Get Shipments

 - [GET /shipments](https://stallionexpress.redocly.app/stallionexpress-v4/shipments/getshipments.md): Get the list of paginated shipments by different search parameters.

### Create Shipment

 - [POST /shipments](https://stallionexpress.redocly.app/stallionexpress-v4/shipments/createshipment.md): Create a shipment and return the postage label.

### Track Shipment

 - [GET /track](https://stallionexpress.redocly.app/stallionexpress-v4/shipments/track.md): Fetch a shipment tracking details by different search parameters

### Get Shipment

 - [GET /shipments/{ship_code}](https://stallionexpress.redocly.app/stallionexpress-v4/shipments/gettracking.md): Get a shipment

### Void Shipment

 - [GET /shipments/{ship_code}/void](https://stallionexpress.redocly.app/stallionexpress-v4/shipments/voidshipment.md): Requests a void for a shipment with the provided id.

## Orders

### Get Orders

 - [GET /orders](https://stallionexpress.redocly.app/stallionexpress-v4/orders/getorders.md): Get a paginated list of orders based on certain criteria.

### Create Order

 - [POST /orders](https://stallionexpress.redocly.app/stallionexpress-v4/orders/createorder.md): Create an order.

### Get Order

 - [GET /orders/{id}](https://stallionexpress.redocly.app/stallionexpress-v4/orders/getorder.md): Retrieve a specific order by its auto generated unique ID.

### Update Order

 - [PUT /orders/{id}](https://stallionexpress.redocly.app/stallionexpress-v4/orders/updateorder.md): Update an order.

### Get Store Order

 - [GET /{store_id}/orders/{order_id}](https://stallionexpress.redocly.app/stallionexpress-v4/orders/getstoreorder.md): Retrieve a specific order by its unique ID.

## Stores

### Get Stores

 - [GET /stores](https://stallionexpress.redocly.app/stallionexpress-v4/stores/getstores.md): Get a list of all stores associated with the authenticated user. (This only shows store create via the API.)

### Create Store

 - [POST /stores](https://stallionexpress.redocly.app/stallionexpress-v4/stores/createstore.md): Create a new store for the authenticated user.

### Delete Store by ID

 - [DELETE /stores/{id}](https://stallionexpress.redocly.app/stallionexpress-v4/stores/deletestore.md): Delete a store by its unique ID.

## Batches

### Create a batch

 - [POST /batches](https://stallionexpress.redocly.app/stallionexpress-v4/batches/createbatch.md): Creates a new batch to be used when creating shipments.

## Locations

### Get Locations

 - [GET /locations](https://stallionexpress.redocly.app/stallionexpress-v4/locations/getlocations.md): Gets a list of all current Stallion Express locations.

## Credits

### Get Credits

 - [GET /credits](https://stallionexpress.redocly.app/stallionexpress-v4/credits/getcredits.md): Return the current account balance

### Add Credits

 - [POST /credits](https://stallionexpress.redocly.app/stallionexpress-v4/credits/addcredits.md): Add credits using hte account's default credit card