Update Production Schedule Settings
Beta/v1/operations/production-schedule-settingsThis 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.
constraint_department_idoptional stringnullableID 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_weeksintegerHow many weeks a generated plan covers.
frozen_weeksintegerHow many leading weeks become a commitment when a version is published.
week_start_dayintegerDay a planning week starts, where 0 is Sunday.
demand_window_monthsintegerMonths of order history the demand baseline is drawn from.
forecast_history_monthsintegerMonths of history the forecast is fitted to.
forecast_monthsintegerMonths the forecast projects forward.
demand_basisstringenumValues:trailing_12seasonal_emaHow demand is derived.
forecast_znumberZ-score applied to forecast variability.
changeover_avg_minutesnumberTypical changeover duration.
changeover_min_minutesnumberShortest plausible changeover.
changeover_max_minutesnumberLongest plausible changeover.
changeover_labor_ratenumberHourly labour rate charged to a changeover.
holding_rate_pctnumberAnnual cost of holding stock, as a share of item value.
service_level_znumberZ-score for service level safety stock targets.
finish_lead_time_weeksnumberWeeks between finishing at the constraint and being sellable.
default_constraint_lead_time_weeksnumberDefault weeks of lead time at the constraint.
max_weeks_supplynumberCeiling on how far ahead any item is built.
max_flow_depthintegerHow many steps downstream department work is derived for.
shifts_per_dayintegerShifts worked per day.
hours_per_shiftnumberHours in a shift.
work_days_per_weekintegerDays worked per week.
weeks_per_yearintegerWeeks worked per year.
capacity_headroom_pctnumberShare of machine time a plan may fill.
default_lot_unitsnumberUnits in a default production lot.
cadence_statusstringenumValues:activeinactiveWhether schedules are generated on a timer.
generation_cronoptional stringnullableCron expression driving the generation cadence. Send null to clear.
generation_timezonestringTimezone the cadence is interpreted in.
auto_publish_statusstringenumValues:activeinactiveWhether a generated version is published automatically.
objectstringenumValues:production_schedule_settingsResource type identifier.
constraint_departmententitynullableThe 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.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe 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.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
planning_horizon_weeksintegerHow many weeks a generated plan covers.
frozen_weeksintegerHow many leading weeks become a commitment when a version is published.
week_start_dayintegerDay a planning week starts, where 0 is Sunday.
demand_window_monthsintegerMonths of order history the demand baseline is drawn from.
forecast_history_monthsintegerMonths of history the forecast is fitted to.
forecast_monthsintegerMonths the forecast projects forward.
demand_basisstringenumValues:trailing_12seasonal_emaHow demand is derived.
forecast_znumberZ-score applied to forecast variability.
changeover_avg_minutesnumberTypical changeover duration, used to calibrate the changeover model.
changeover_min_minutesnumberShortest plausible changeover.
changeover_max_minutesnumberLongest plausible changeover.
changeover_labor_ratenumberHourly labour rate charged to a changeover.
holding_rate_pctnumberAnnual cost of holding stock, as a share of item value.
service_level_znumberZ-score for the service level safety stock targets.
finish_lead_time_weeksnumberWeeks between finishing at the constraint and being sellable.
default_constraint_lead_time_weeksnumberDefault weeks of lead time at the constraint when an item has no measurement.
max_weeks_supplynumberCeiling on how far ahead any item is built.
max_flow_depthintegerHow many steps downstream department work is derived for.
shifts_per_dayintegerShifts worked per day.
hours_per_shiftnumberHours in a shift.
work_days_per_weekintegerDays worked per week.
weeks_per_yearintegerWeeks worked per year.
capacity_headroom_pctnumberShare of machine time a plan may fill. The remainder absorbs changeovers, which are not scheduled as explicit blocks.
default_lot_unitsnumberUnits in a default production lot.
cadence_statusstringenumValues:activeinactiveWhether schedules are generated on a timer.
generation_cronstringnullableCron expression driving the generation cadence.
generation_timezonestringTimezone the cadence is interpreted in.
auto_publish_statusstringenumValues:activeinactiveWhether a generated version is published automatically.
last_generated_atstring (date-time)nullableWhen the cadence last fired.
settings_statusstringenumValues:storeddefaultWhether 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
Successful response for Update Production Schedule Settings