# 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-09-08

> 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 lists, details, updates, assignment, safe close behavior, allocation, pause, and resume workflows. |
| Locations | Warehouse location lists, active or archived filtering, name, barcode, and zone search, creation, lookup, updates to location types and settings, and occupancy-aware responses. |
| Packages | Package lists and creation. |
| Products | WMS product lists, active or archived filtering, source stores, SKU lookup, creation, updates, deletion, and supported product syncs. |
| Suppliers | Supplier lists, creation, lookup, and updates for purchase and receiving workflows. |
| Purchase orders | Purchase order lists, creation, duplication, lookup, updates, email, receiving, restocking drafts, and mark-received actions. |
| Inventory | Inventory summaries, product detail, and batch, serial, or availability validation. |
| Stock movements | Stock movement lists, creation, transfers, and exports. |
| Allocations | Allocation lists and manual allocation deletion. |
| Picking | Pick job details, begin, pick, stage, and tote workflows. |
| Packing | Pack job details, progress, packages, carrier service, begin, and label-printing workflows. |
| Kitting | Kit job creation, detail, allocation, and processing. |
| Replenishment | Replenishment demand review, generation, manual creation, lines, pick, placement, and combination. |
| Putaway | Putaway lists, processing, eligibility checks, and cancellation. |
| Stocktake | Stocktake count submission, pending approval and submission history, and approval or decline before asynchronous inventory processing. |
| Analytics | Date-specific performance, staff activity filters, and operational reports, including backlog aging, slotting utilization, shipping economics, declared value vs COGS, and replenishment jobs. |
| 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.

Create and manage orders through the [Starshipit API reference](/developers/api-reference/starshipit). Orders available in Starshipit enter WMS for warehouse processing, so WMS order endpoints are not included in the public WMS API reference.

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)