# WMS API reference guide
URL: https://support.starshipit.com/articles/14700000001023-wms-api-reference-guide
Canonical: https://support.starshipit.com/articles/14700000001023-wms-api-reference-guide
Markdown: https://support.starshipit.com/articles/14700000001023-wms-api-reference-guide.md
Updated: 2026-06-18

> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).

> Use the WMS API reference to find endpoint groups, methods, request parameters, examples, and errors.

Use the WMS API reference when you need exact WMS endpoint paths, request parameters, request bodies, response examples, and error details. Start with the WMS guide first, then use the [WMS API reference](/developers/api-reference/wms) to confirm technical details.

## Endpoint groups

The WMS API reference is organised into these groups:

| Group | What it supports |
| --- | --- |
| Authentication | Required WMS API authentication header. |
| Jobs | Warehouse job list, details, assignment, allocation, pause, resume, and cleanup workflows. |
| Locations | Warehouse locations, location lookup, layout, and import/export workflows. |
| Packages | Package records used by WMS workflows. |
| Products | WMS product records, filters, sync, imports, exports, SKU lookup, barcodes, and HS code workflows. |
| Suppliers | Supplier records used by purchase and receiving workflows. |
| Purchase orders | Purchase orders, receiving, imports, templates, and mark-received actions. |
| Inventory | Inventory lists, summaries, validation, external updates, exports, and cleanup workflows. |
| Stock movements | Stock movement list, exports, and transfer workflows. |
| Allocations | Allocation checks and allocation-related job operations. |
| Picking | Pick batches, pick actions, staging, tote assignments, expedite, and packing slip workflows. |
| Packing | Packing summaries and packing-related workflows. |
| Kitting | Kit jobs, allocation, pick slips, and process actions. |
| Replenishment | Replenishment generation, allocation, pick, and replenish actions. |
| Putaway | Putaway checks, create-from-location, and putaway list workflows. |
| Stocktake | Stocktake list and product workflows. |
| Analytics | WMS reporting and operational analytics endpoints. |
| Starshipit orders | Starshipit order data used by WMS workflows. |
| Error handling | Common error response patterns. |

## What the reference is for

The [WMS API reference](/developers/api-reference/wms) helps you confirm exact endpoint paths, request parameters, request bodies, response examples, and error details after you have chosen the warehouse workflow you want to build.

The reference is a customer-facing API reference, not a complete promise that every internal WMS route is public for all accounts. Add or revise endpoints only when the customer-facing contract is confirmed.

## Related guides

- [WMS API guide](/articles/developer-center/starshipit-wms-api/wms-api-guide)
- [WMS API fundamentals](/articles/developer-center/starshipit-wms-api/wms-api-fundamentals)
- [WMS API reference](/developers/api-reference/wms)