> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Trackstar is a unified REST API for WMS, cart, and carrier systems. Base URL: https://production.trackstarhq.com. There is no SDK; call the API with plain HTTP.
> Send x-trackstar-api-key on every request. Endpoints scoped to one connection also need x-trackstar-access-token. Read both from environment variables and never print them.
> Reads return data Trackstar has already synced from the connected system. Writes (POST, PUT, PATCH, DELETE) are forwarded to the connected system immediately.
> A new connection has no data until its initial sync finishes. Wait for the connection.historical-sync-completed webhook, or poll GET /connections/{connection_id} and check historical_sync_completed.
> List endpoints page with page_token and next_token (limit is capped at 1000). Repeat every filter on every page. Filters use field[operator]=value, for example created_date[gte]=2026-01-01T00:00:00Z.
> Write bodies must not contain null or empty strings; omit the field instead. Call GET /integrations/{integration_type}/{integration_name}/write-info first to learn the exact fields an integration accepts.
> To test without real credentials, POST /sandbox/generate-sandbox/{wms|cart|carrier} with the API key returns a sandbox access token. Start at https://docs.trackstarhq.com/how-to-guides/build-with-ai.md and install the skills with: npx skills add https://docs.trackstarhq.com

# WMS API

> One API for orders, inventory, products, inbound shipments, and returns across every connected warehouse management system

The WMS API gives you one set of endpoints for every warehouse management system (WMS) and 3PL your customers connect. An order, an inventory item, or a return comes back in the same shape whichever WMS the warehouse runs, so you build each feature once.

## Make a request

Every endpoint lives under `https://production.trackstarhq.com/wms/` and takes two headers: your API key, and the access token for the customer's connection. See [Getting Started](https://docs.trackstarhq.com/how-to-guides/getting-started.md) for how to get both.

```bash theme={null}
curl "https://production.trackstarhq.com/wms/orders?limit=10" \
  -H "x-trackstar-api-key: YOUR_API_KEY" \
  -H "x-trackstar-access-token: YOUR_ACCESS_TOKEN"
```

List endpoints return up to 1000 items per page with a `next_token` for the next page, and accept filters such as `updated_date[gte]`. [About the API](https://docs.trackstarhq.com/how-to-guides/about-the-api.md) covers pagination, filtering, errors, and rate limits.

Not every WMS supports every endpoint. A connection's `available_actions` lists what it supports, and an endpoint its WMS doesn't support returns `501`.

## Resources

> [card] [Inventory](https://docs.trackstarhq.com/api-reference/wms-api/inventory/info.md)
>
> Onhand, committed, fulfillable, and sellable quantities, plus the inventory ledger.

> [card] [Products](https://docs.trackstarhq.com/api-reference/wms-api/products/info.md)
>
> Product records and the inventory items they map to.

> [card] [Orders](https://docs.trackstarhq.com/api-reference/wms-api/orders/info.md)
>
> Customer orders, their line items, and the shipments that fulfill them.

> [card] [Inbound Shipments](https://docs.trackstarhq.com/api-reference/wms-api/inbound-shipments/info.md)
>
> Advance shipping notices from a supplier, and what the warehouse received.

> [card] [Shipping Methods](https://docs.trackstarhq.com/api-reference/wms-api/shipping-methods/info.md)
>
> The carrier services you can ship an order with.

> [card] [Returns](https://docs.trackstarhq.com/api-reference/wms-api/returns/info.md)
>
> Return authorizations and what came back.

> [card] [Billing](https://docs.trackstarhq.com/api-reference/wms-api/billing/info.md)
>
> What the warehouse charges for shipping, storage, picking, and packing.

> [card] [Warehouses](https://docs.trackstarhq.com/api-reference/wms-api/warehouses/info.md)
>
> Warehouses and the locations within them.

> [card] [Warehouse Customers](https://docs.trackstarhq.com/api-reference/wms-api/warehouse-customers/info.md)
>
> The merchants that own the inventory and orders in a 3PL warehouse.

## Keep your data current

Trackstar syncs each connection on a schedule, so reads come from Trackstar and don't wait on the WMS. To hear about changes as they land instead of polling, subscribe to [webhooks](https://docs.trackstarhq.com/how-to-guides/webhooks/webhooks.md). [Syncing Data](https://docs.trackstarhq.com/how-to-guides/syncing-data.md) explains how often each resource syncs.

To try the endpoints before a customer connects, use the [WMS sandbox](https://docs.trackstarhq.com/how-to-guides/sandbox.md).

## Use cases

> [card] [Order Fulfillment](https://docs.trackstarhq.com/use-cases/order-fulfillment.md)
>
> Create orders and track fulfillments.

> [card] [Inventory Management](https://docs.trackstarhq.com/use-cases/inventory-management.md)
>
> Keep stock in check.

> [card] [Shipping Solutions](https://docs.trackstarhq.com/use-cases/shipping-solutions.md)
>
> Fulfill orders with tracking information.

> [card] [Returns](https://docs.trackstarhq.com/use-cases/returns.md)
>
> Create RMAs and track disposition data.

> [card] [Warehouse ASNs](https://docs.trackstarhq.com/use-cases/warehouse-asns.md)
>
> Notify warehouses of incoming goods and track receipts.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.