Async Python client for ShipStation V1 and V2 APIs with full type hints.

pip install AsyncShipStation

git clone git@github.com:sudoDeVinci/AsyncShipStation.git cd AsyncShipStation pip install -r requirements.txt

from AsyncShipStation import ShipStationClient # Configure with both V1 and V2 credentials ShipStationClient.configure( v2_key="your_v2_api_key", v1_key="your_v1_api_key", v1_secret="your_v1_secret", )

The library uses a shared httpx.AsyncClient under the hood. You have two options for managing it:

The client starts automatically on first request. Just remember to close it when done:

import asyncio import os from dotenv import load_dotenv from AsyncShipStation import ShipStationClient, InventoryPortal load_dotenv() API_KEY: str | None = os.getenv("API_KEY") async def main() -> None: ShipStationClient.configure(api_key=API_KEY) # Connection pool starts on first request status, warehouses = await InventoryPortal.list_warehouses(page_size=10) print(f"Status: {status}, Warehouses: {warehouses}") ... # Clean up when done await ShipStationClient.close() if __name__ == "__main__": asyncio.run(main())

Scoped usage where you want automatic cleanup:

import asyncio import os from dotenv import load_dotenv from AsyncShipStation import ShipStationClient, InventoryPortal load_dotenv() API_KEY: str | None = os.getenv("API_KEY") async def main() -> None: ShipStationClient.configure(api_key=API_KEY) async with InventoryPortal.scoped_client() as _: status, warehouses = await InventoryPortal.list_warehouses(page_size=10) print(f"Status: {status}, Warehouses: {warehouses}") ... # Client closes automatically when exiting the context if __name__ == "__main__": asyncio.run(main())

The client uses connection pooling, so concurrent requests share connections efficiently:

import asyncio from AsyncShipStation import ( BatchPortal, InventoryPortal, LabelPortal, ShipStationClient, ) ... ShipStationClient.configure(api_key=API_KEY) async with ShipStationClient.scoped_client() as _: results = await asyncio.gather( InventoryPortal.list_warehouses(), InventoryPortal.list(), BatchPortal.list(), LabelPortal.list(), ) for status, data in results: if status in (200, 207, 201): print(f"Success :: {data}") else: print(f"Error :: {data}") ...

Accounts that send too many requests in quick succession will receive a 429 Too Many Requests error response and include a Retry-After header with the number of seconds to wait for. By default we get 200 requests per minute. ShipStation has bulk op endpoints. These only count as a single request.

/batches Process labels in bulk and receive a large number of labels and customs forms in bulk responses. Batching is ideal for workflows that need to process hundreds or thousands of labels quickly. 200

/carriers Retreive useful details about the carriers connected to your accounts, including carrier IDs, service IDs, advanced options, and available carrier package types.

/fulfillments Manage fulfillments which represent completed shipments. Create fulfillments to mark orders as shipped with tracking information and notify customers and marketplaces.

/inventory Manage inventory, adjust quantities, and handle warehouses and locations.

• /inventory_warehouses
• /inventory_locations

/labels Purchase and print shipping labels for any carrier active on your account. The labels endpoint also supports creating return labels, voiding labels, and getting label details like tracking.

/manifests A manifest is a document that provides a list of the day's shipments. It typically contains a barcode that allows the pickup driver to scan a single document to register all shipments, rather than scanning each shipment individually.

/rates (V2) Calculate and estimate shipping rates across multiple carriers. Supports both full rate calculation with shipment details and quick rate estimates.

/shipments (V2) Create, retrieve, and manage shipments. Includes support for getting rates, adding/removing tags, and cancellation.

/tags (V2) Manage tags for organizing shipments and orders. Create, list, and delete tags.

/warehouses (V2) Retrieve warehouse information including origin addresses for shipments.