Inventory Manager API · settings
Replace the organization's stock policy
PUT /settings
Every field is optional and falls back to its default, so a partial body is a whole configuration. transfers is the shape a transfer takes (two-step is the only one that can record a short delivery; off allows none). homeCurrency (ISO 4217) is what valuation, the ledger and analytics are stated in, and what a new purchase order defaults to; it is settled for good when the organization's onboarding completes (homeCurrencyLocked, inventory.home-currency-locked), after which a different one is refused with 409 HomeCurrencyLocked. homeCurrencyLocked itself is read-only: a value sent here is ignored. weightUnit and lengthUnit are display only: every figure is stored in grams and millimetres, so changing a unit never changes a SKU. skuAlphabet is what a new SKU (an item, a kit) may be made of: strict (letters, digits, - and _) or extended (also spaces,. and /, for codes a merchant already prints); existing SKUs are never touched, so going back to strict is refused with 409 SkuAlphabetInUse (naming the SKUs in the way) while any SKU — an item, a variant, a kit — falls outside it. Appends inventory.settings-configured. Idempotent by content: the event is a last-write-wins snapshot of the whole policy, so a retry lands on the same settings. Transfers already open keep the shape they were created under — changing the policy never reshapes one in flight.
Access
Requires settings:write.
How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.
Retries
Idempotent by content: the event is a last-write-wins snapshot of the whole policy, so a retry lands on the same settings.
Why every write carries a key: Idempotency and retries.
Facts appended
inventory.home-currency-lockedinventory.settings-configured
What a fact is: Facts and the journal.
AI agent tool
Agents call this as inventory_set_settings (Inventory: Set settings), in the locations toolset.
Connecting an agent: AI agents.
Example
Let each transfer choose its shape, and allow spaces, dots and slashes in SKUs.
curl -X PUT 'https://inventory.getmanifold.io/settings' \
-H "Authorization: Bearer $MANIFOLD_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"transfers": "unrestricted",
"homeCurrency": "AUD",
"weightUnit": "kg",
"lengthUnit": "cm",
"skuAlphabet": "extended"
}'const response = await fetch("https://inventory.getmanifold.io/settings", {
method: "PUT",
headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"transfers": "unrestricted",
"homeCurrency": "AUD",
"weightUnit": "kg",
"lengthUnit": "cm",
"skuAlphabet": "extended"
}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();{
"transfers": "unrestricted",
"homeCurrency": "AUD",
"weightUnit": "kg",
"lengthUnit": "cm",
"skuAlphabet": "extended"
}{
"transfers": "unrestricted",
"homeCurrency": "AUD",
"homeCurrencyLocked": true,
"weightUnit": "kg",
"lengthUnit": "cm",
"skuAlphabet": "extended"
}The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web
page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: inventory-manager.openapi.json. Base URL https://inventory.getmanifold.io.
Errors
Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.
401
| Refusal | What it means | What to do |
|---|---|---|
Unauthorized reason | The token is missing, expired or not one Manifold issued. | Get a fresh token and send the call again. |
TokenAlreadyUsed tokenId | A single-use app token was already spent. | Mint a new token for this call. |
402
| Refusal | What it means | What to do |
|---|---|---|
SubscriptionRequired status | The organization's subscription has lapsed, so writes are refused. | An owner settles billing. Reads still work meanwhile. |
403
| Refusal | What it means | What to do |
|---|---|---|
TenantRequired userId | The token names no organization. | Choose the organization, then get a new token. |
ScopeRequired required | The token's roles do not grant the scope this call needs. | Ask an owner or admin for a role that grants it. |
409
| Refusal | What it means | What to do |
|---|---|---|
HomeCurrencyLocked homeCurrency | The home currency cannot change once stock has a cost. | Nothing to do here: it stays as it is. |
SkuAlphabetInUse alphabet, skus | Existing SKUs use characters the stricter alphabet would refuse. skus names them. | Rename those SKUs first. |
MirroredFromSource source | This area is fed by your source system until the organization goes live. | Make the change in the source system, or go live first. |
503
| Refusal | What it means | What to do |
|---|---|---|
RequestLogUnavailable tokenId, reason | The service could not record the request, so it did nothing. | Send the same request again shortly. |
How refusals work everywhere: Errors.
Used in
- Running more than one location, step 11: Allow instant moves as well