Save an inventory planning setting
Saves one lead time and safety buffer row for a shop: the default (scopeKind default, no scopeValue), a brand or a product (scopeValue the brand name or platform product id), then applies the shop's settings.
PUT /properties/{propertyId}/inventory-settings
Scope write · Access Changes data · Operation id inventory_settings.update
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID, $STORE_ID first.
productmetrics inventory-settings update \
--property-id $PROPERTY_ID \
--store-id $STORE_ID \
--scope-kind default \
--lead-time-days 30 \
--safety-buffer-days 30 \
--jsonResponse
API response (200), shortened:
{
"data": {
"settings": [
{
"leadTimeDays": 30,
"safetyBufferDays": 30
// … 2 more fields
}
],
"effective": {
"productSpineStoreId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"version": "7f3a9c2e"
// … 3 more fields
}
},
"request_id": "req_01JXB0WQF7X2ZQ4GQF1WA86SJZ"
}CLI output: productmetrics inventory-settings update --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Answers the saved rows and the values now in use. Get store_id from inventory_settings.get. Needs an editor or admin and the Pro plan.
Path parameters
| Name | Type | Description |
|---|---|---|
propertyId | string (uuid) | A property_id from properties.list. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
store_id | string (uuid) | Yes | The shop the settings belong to: effective.productSpineStoreId from inventory_settings.get. Omitted on a read: the property’s first shop. |
Body
| Name | Type | Required | Description |
|---|---|---|---|
scopeKind | enum | Yes | Saves one lead time and safety buffer row for a shop: the default (scopeKind default, no scopeValue), a brand or a product (scopeValue the brand name or platform product id), then applies the shop’s settings. One of default, brand, product. |
scopeValue | string or null | No | Saves one lead time and safety buffer row for a shop: the default (scopeKind default, no scopeValue), a brand or a product (scopeValue the brand name or platform product id), then applies the shop’s settings. 1 to 255 characters. |
leadTimeDays | integer | Yes | Days between ordering stock and having it in the shop. From 0 to 730. |
safetyBufferDays | integer | Yes | Extra days of stock to keep on top of the lead time. From 0 to 365. |
Errors
A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the write scope; connect again and allow it.",
"details": {
"required_scope": "write"
}
},
"request_id": "req_01JPW5GA6B2MK6E8KQ9GBZE5PW"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 402 | subscription_required | The workspace has no Pro plan. |
| 403 | insufficient_scope | The token lacks the write scope (details.required_scope): sign in again and allow it. |
| 404 | not_found | An id in the path does not exist, or the signed-in person cannot open it. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |