Retrieve Production Schedule Settings

Beta

GET/v1/operations/production-schedule-settings

This endpoint is idempotent. Learn more

Returns the planning assumptions production schedules are solved against.

Always fully populated: an account that has never saved settings gets the solver's own defaults rather than nulls, so a caller never has to know which values would otherwise be assumed. settings_status distinguishes the two.

Permissions requiredValues:production_schedules:read

The role behind your API key or agent must grant every one of these permissions.

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 Retrieve Production Schedule Settings

Retrieve Production Schedule Settings

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const productionScheduleSettings = await client.operations.productionScheduleSettings.list();

console.log(productionScheduleSettings.auto_publish_status);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const productionScheduleSettings = await client.operations.productionScheduleSettings.list();

console.log(productionScheduleSettings.auto_publish_status);

200 example

{
  "object": "production_schedule_settings",
  "constraint_department": null,
  "planning_horizon_weeks": 13,
  "frozen_weeks": 1,
  "week_start_day": 1,
  "demand_window_months": 12,
  "forecast_history_months": 24,
  "forecast_months": 12,
  "demand_basis": "trailing_12",
  "forecast_z": 1.645,
  "changeover_avg_minutes": 30,
  "changeover_min_minutes": 15,
  "changeover_max_minutes": 90,
  "changeover_labor_rate": 20,
  "holding_rate_pct": 0.25,
  "service_level_z": 1.645,
  "finish_lead_time_weeks": 6,
  "default_constraint_lead_time_weeks": 1.3,
  "max_weeks_supply": 12,
  "max_flow_depth": 10,
  "shifts_per_day": 2,
  "hours_per_shift": 7,
  "work_days_per_week": 5,
  "weeks_per_year": 52,
  "capacity_headroom_pct": 0.9,
  "default_lot_units": 60,
  "cadence_status": "inactive",
  "generation_cron": null,
  "generation_timezone": "UTC",
  "auto_publish_status": "inactive",
  "last_generated_at": null,
  "settings_status": "default",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "object": "production_schedule_settings",
  "constraint_department": null,
  "planning_horizon_weeks": 13,
  "frozen_weeks": 1,
  "week_start_day": 1,
  "demand_window_months": 12,
  "forecast_history_months": 24,
  "forecast_months": 12,
  "demand_basis": "trailing_12",
  "forecast_z": 1.645,
  "changeover_avg_minutes": 30,
  "changeover_min_minutes": 15,
  "changeover_max_minutes": 90,
  "changeover_labor_rate": 20,
  "holding_rate_pct": 0.25,
  "service_level_z": 1.645,
  "finish_lead_time_weeks": 6,
  "default_constraint_lead_time_weeks": 1.3,
  "max_weeks_supply": 12,
  "max_flow_depth": 10,
  "shifts_per_day": 2,
  "hours_per_shift": 7,
  "work_days_per_week": 5,
  "weeks_per_year": 52,
  "capacity_headroom_pct": 0.9,
  "default_lot_units": 60,
  "cadence_status": "inactive",
  "generation_cron": null,
  "generation_timezone": "UTC",
  "auto_publish_status": "inactive",
  "last_generated_at": null,
  "settings_status": "default",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Production Schedule Settings

Authorization

Returns

Responses