Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

The Planning settings to change. A setting left out keeps its value.

working_days
integer[]

The days the organization works, as ISO weekdays: 1 for Monday to 7 for Sunday. At least one.

Required array length: 1 - 7 elements
Required range: 1 <= x <= 7
outlier_deviations
number

How many median absolute deviations from its median make a week's demand an outlier, from 1 to 10; 3.5 by default.

forecast_horizon_weeks
integer

How many weeks ahead forecasts reach, from 4 to 104; 52 by default.

Required range: 4 <= x <= 104
forecast_schedule
enum<string>

weekly (the default) to forecast every Monday on their own, or manual to forecast only when started.

Available options:
weekly,
manual
service_level
number

The chance of not running out while an order is on its way that suggestions aim for, in percent, from 50 to 99.9; 95 by default.

lead_time_receipts
integer

How many of the latest receipts or builds a lead time is measured from, from 1 to 50; 10 by default.

Required range: 1 <= x <= 50

Response

PlanningSettingsResource

data
PlanningSettingsResource · object
required