# 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-10-19

> 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, exact name and barcode filters, product-specific replenishment candidates, zone search and sorting, creation, lookup, updates, and occupancy-aware responses. |
| Packages | Package lists and creation. |
| Products | WMS product lists, active or archived filtering, source stores, SKU lookup, pre-order flags, Shopify safety-stock buffers, stock-adjustment location 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, pre-receipt status and transit-stage updates, change history, updates with receiving-state restrictions, email, receiving, restocking drafts, and mark-received actions. |
| Inventory | Inventory summaries, product detail, physical movement availability and reservations, and batch, serial, or availability validation. |
| Stock movements | Stock movement lists, historical reason and inferred process filters, creation, loose-stock and container 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, shipping handoff, and label-printing workflows. |
| Kitting | Kit job creation, detail, allocation, processing, and safe deletion. |
| Replenishment | Replenishment demand review, generation, manual creation, lines, pick, finish picking short, placement, combination, and cancellation. |
| Putaway | Putaway lists, saved progress checkpoints, advisory processing results, eligibility checks, and cancellation. |
| Stocktake | Product-wide or location-scoped loose-stock and container count submission, pending approval and submission history, and approval or decline before asynchronous inventory processing. |
| Analytics | Performance and staff activity, backlog aging, slotting utilization, shipping economics, declared value vs COGS, replenishment jobs, order demand, short picks, staff packing, stock movements, fulfilment billing, packing benches, purchase-order receipts, traceability, slow-moving stock, expiring stock, and pick-face replenishment. Check each endpoint for client scope, date rules, formats, and limits. |
| 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)