Get inventory planning settings
The lead time and safety buffer (in days) saved for one of the property's shops (a default, per brand or per product), and the values the shop uses (effective).
GET /properties/{propertyId}/inventory-settings
Scope read · Access Read only · Operation id inventory_settings.get
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $PROPERTY_ID first.
productmetrics inventory-settings get --property-id $PROPERTY_ID --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_01J3WVWHEHR0JAWFW29DNEVH51"
}CLI output: productmetrics inventory-settings get --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Read this before inventory_settings.update; the shop’s id is effective.productSpineStoreId. Needs 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) | No | The shop the settings belong to: effective.productSpineStoreId from inventory_settings.get. Omitted on a read: the property’s first shop. |
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 read scope; connect again and allow it.",
"details": {
"required_scope": "read"
}
},
"request_id": "req_01JV4A8BHXBNA297YW5V0HWJXF"
}| 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 read 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. |