Products & Inventory
Shelf positions through the API
Use an API key to read shelf positions, move units between shelves, and specify shelves for stock-outs and transfers. Set up shelves and switch tracking on in the app.
If another system records stock movements in StockBold through an API key, it can work with shelf positions as well. It follows the same rules as the screens, and a key can only do what the permissions you gave it allow.
| An integration can | Permission the key needs |
|---|---|
| Read the shelves of each warehouse, and how many units of each tracked product are on every shelf and in Unassigned | None in particular |
| Check whether a product is tracked by shelf, and see which shelves a past movement used | None in particular |
| Move units between two shelves of the same warehouse, or between a shelf and Unassigned, without changing any stock quantity or value | Add stock movements |
| Say which shelves the stock left from when it records a stock-out | Add stock movements |
| Say which shelves a transfer takes the units from in one warehouse and puts them on in the other | Add stock movements |
| Give the shelves again when it edits a stock-out or a transfer, or say where the units go when it deletes one | Add stock movements to edit, Delete stock movements to delete |
The shelves an integration gives must add up exactly to the movement's quantity, and a product that is not tracked by shelf cannot be given shelves. A transfer gives both sides or neither.
Integrations that do not specify shelves
An integration that does not mention shelves keeps working as before. For a tracked product, the units of a stock-out or transfer then come from, or go to, Unassigned. An edit keeps the shelves the movement used and puts any difference in Unassigned.
A deletion puts the units back on the shelves the movement used, and is refused if one of them no longer holds them.
In these cases the product's page and the Shelves page may show units not shelved, or shelves that exceed the stock, until someone moves them.
What is done in the app only
Adding, renaming and deleting shelves, switching shelf tracking on or off, and recording deliveries are done in the app, not with an API key.
Where to find the details
API keys are created in Settings, then API, by people allowed to manage API keys. The API Documentation button at the top of that page opens the API Documentation, which describes every call your developer needs, including the shelf calls. Give it to whoever builds or maintains your integration.