Update Production Schedule Settings

Beta
PUT/v1/operations/production-schedule-settings

This endpoint is idempotent. Learn more

Replaces the planning assumptions production schedules are solved against.

Settings are replaced wholesale rather than patched, because they are read as one coherent set: a horizon that no longer matches the frozen window, or a capacity headroom that no longer matches the shift pattern, would produce a plan nobody intended.

Existing schedule versions are unaffected — each one snapshots the assumptions it was solved under, so changing settings changes future plans only.

Permissions requiredValues:production_schedules:update
The role behind your API key or agent must grant every one of these permissions.
constraint_department_idoptional stringnullable

ID of the department that sets the pace of the factory. Every machine in it is planned, and every step downstream responds. Send null to clear.

planning_horizon_weeksinteger

How many weeks a generated plan covers.

frozen_weeksinteger

How many leading weeks become a commitment when a version is published.

week_start_dayinteger

Day a planning week starts, where 0 is Sunday.

demand_window_monthsinteger

Months of order history the demand baseline is drawn from.

forecast_history_monthsinteger

Months of history the forecast is fitted to.

forecast_monthsinteger

Months the forecast projects forward.

demand_basisstringenumValues:trailing_12seasonal_ema

How demand is derived.

forecast_znumber

Z-score applied to forecast variability.

changeover_avg_minutesnumber

Typical changeover duration.

changeover_min_minutesnumber

Shortest plausible changeover.

changeover_max_minutesnumber

Longest plausible changeover.

changeover_labor_ratenumber

Hourly labour rate charged to a changeover.

holding_rate_pctnumber

Annual cost of holding stock, as a share of item value.

service_level_znumber

Z-score for service level safety stock targets.

finish_lead_time_weeksnumber

Weeks between finishing at the constraint and being sellable.

default_constraint_lead_time_weeksnumber

Default weeks of lead time at the constraint.

max_weeks_supplynumber

Ceiling on how far ahead any item is built.

max_flow_depthinteger

How many steps downstream department work is derived for.

shifts_per_dayinteger

Shifts worked per day.

hours_per_shiftnumber

Hours in a shift.

work_days_per_weekinteger

Days worked per week.

weeks_per_yearinteger

Weeks worked per year.

capacity_headroom_pctnumber

Share of machine time a plan may fill.

default_lot_unitsnumber

Units in a default production lot.

cadence_statusstringenumValues:activeinactive

Whether schedules are generated on a timer.

generation_cronoptional stringnullable

Cron expression driving the generation cadence. Send null to clear.

generation_timezonestring

Timezone the cadence is interpreted in.

auto_publish_statusstringenumValues:activeinactive

Whether a generated version is published automatically.

objectstringenumValues:production_schedule_settings

Resource type identifier.

constraint_departmententitynullable

The department that sets the pace of the factory. Every machine in it is planned, and every step downstream of it responds. A machine that must sit out is excluded through its resource setting rather than by leaving it unselected.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

planning_horizon_weeksinteger

How many weeks a generated plan covers.

frozen_weeksinteger

How many leading weeks become a commitment when a version is published.

week_start_dayinteger

Day a planning week starts, where 0 is Sunday.

demand_window_monthsinteger

Months of order history the demand baseline is drawn from.

forecast_history_monthsinteger

Months of history the forecast is fitted to.

forecast_monthsinteger

Months the forecast projects forward.

demand_basisstringenumValues:trailing_12seasonal_ema

How demand is derived.

forecast_znumber

Z-score applied to forecast variability.

changeover_avg_minutesnumber

Typical changeover duration, used to calibrate the changeover model.

changeover_min_minutesnumber

Shortest plausible changeover.

changeover_max_minutesnumber

Longest plausible changeover.

changeover_labor_ratenumber

Hourly labour rate charged to a changeover.

holding_rate_pctnumber

Annual cost of holding stock, as a share of item value.

service_level_znumber

Z-score for the service level safety stock targets.

finish_lead_time_weeksnumber

Weeks between finishing at the constraint and being sellable.

default_constraint_lead_time_weeksnumber

Default weeks of lead time at the constraint when an item has no measurement.

max_weeks_supplynumber

Ceiling on how far ahead any item is built.

max_flow_depthinteger

How many steps downstream department work is derived for.

shifts_per_dayinteger

Shifts worked per day.

hours_per_shiftnumber

Hours in a shift.

work_days_per_weekinteger

Days worked per week.

weeks_per_yearinteger

Weeks worked per year.

capacity_headroom_pctnumber

Share of machine time a plan may fill. The remainder absorbs changeovers, which are not scheduled as explicit blocks.

default_lot_unitsnumber

Units in a default production lot.

cadence_statusstringenumValues:activeinactive

Whether schedules are generated on a timer.

generation_cronstringnullable

Cron expression driving the generation cadence.

generation_timezonestring

Timezone the cadence is interpreted in.

auto_publish_statusstringenumValues:activeinactive

Whether a generated version is published automatically.

last_generated_atstring (date-time)nullable

When the cadence last fired.

settings_statusstringenumValues:storeddefault

Whether these are the merchant's saved values or the solver's defaults.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Production Schedule Settings