Preview Production Schedule

Beta

PUT/v1/operations/production-schedules/actions/preview

This endpoint is idempotent. Learn more

Runs the production scheduling solver and returns the plan without saving it.

This is the inspection surface for the scheduler: it takes the same path a generated schedule will take, minus the write, so a plan can be reviewed and compared before anything depends on it. Machines must be marked as the planning constraint in production schedule settings, otherwise there is nothing to schedule.

Permissions requiredValues:production_schedules:read

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

planning_as_ofoptional string (date-time)

The instant to plan against. Defaults to now.

horizon_weeksoptional integer

Overrides the configured horizon for this preview only.

demand_basisoptional stringenumValues:trailing_12seasonal_ema

Overrides the configured demand basis for this preview only.

objectstringenumValues:production_schedule_preview

Resource type identifier.

solver_versionstring

Version of the solver that produced this plan.

planning_as_of_atstring (date-time)

The instant the plan was calculated against.

policieslistnullable

The computed inventory policy per item, ordered by constraint run hours descending.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

itementitynullable

The item this policy is for.

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).

skustring

SKU of the item.

annual_demandnumber

Demand used for planning, annualized.

weekly_demandnumber

Demand used for planning, per week.

seconds_per_unitnumber

How long one unit occupies the constraint.

unit_costnumber

Standard cost per unit.

setup_costnumber

Cost of one changeover, used as the setup cost in the lot-size calculation.

holding_costnumber

Annual cost of holding one unit.

eoq_unitsnumber

Economic order quantity.

constraint_lead_time_weeksnumber

Observed or default lead time at the constraint.

finish_lead_time_weeksnumber

Lead time from the constraint to sellable stock.

safety_stock_primarynumber

Buffer held at the constraint, pooled across the finished goods it feeds.

safety_stock_downstreamnumber

Buffer held as finished goods.

reorder_pointnumber

Stock position at which a campaign is triggered.

order_up_tonumber

Ceiling on how far ahead this item is built.

on_hand_echelonnumber

Stock on hand at the constraint plus everything downstream of it.

on_hand_greigenumber

Stock sitting at the constraint stage on its own.

average_greige_inventorynumber

What the constraint stage holds on average: its buffer plus half a campaign.

max_greige_inventorynumber

What the constraint stage holds at its peak: its buffer plus a whole campaign.

weeks_of_covernumber

Weeks of demand the current stock covers.

abc_classstringnullableenumValues:abc

ABC class by share of constraint run hours.

annual_run_hoursnumber

Constraint hours this item's annual demand consumes.

campaignslistnullable

The planned production blocks.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

itementitynullable

The item to produce.

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).

skustring

SKU of the item.

machineentitynullable

The machine assigned to the campaign.

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).

week_indexinteger

Zero-based week offset from the start of the horizon.

unitsnumber

Quantity to produce.

lotsinteger

Whole lots the quantity rounds to.

run_hoursnumber

Constraint hours the campaign consumes.

projectionslistnullable

Projected stock position per item across the horizon.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

itementitynullable

The item.

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).

on_hand_by_weekarray of number

Projected stock at the end of each week of the horizon.

diagnosticsobject

What the solver could not do.

eoq_capped_skusarray of string

Items whose economic lot size was reduced to fit one machine-week, meaning shorter and more frequent campaigns.

unschedulable_skusarray of string

Items that cannot fit even a single lot into a machine-week and are therefore never scheduled.

capacity_starved_skusarray of string

Items below their reorder point that never won a slot in the horizon. This is the signal that the plant is short of capacity.

items_without_run_ratearray of string

Items with no measured run rate, which cannot be scheduled because their machine time is unknown.

excluded_item_countinteger

Number of items the merchant has excluded from planning.

constraint_machine_countinteger

Machines the constraint department contributed to this solve.

measured_batch_countinteger

Batches found on those machines in the demand window. Zero means nothing has been scanned there, which is why a plan can be empty even with machines configured.

machines_without_stepinteger

Machines in the constraint department with no production step. Their campaigns derive no downstream department work.

changeover_slope_minutesnumber

Calibrated changeover minutes per additional input.

average_inputs_addednumber

Average inputs a product transition introduces, measured from history.

applied_overrideslistnullable

Every demand override that moved a number.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

overrideentitynullable

The override that was applied.

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).

itementitynullable

The item whose demand changed.

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).

month_starts_atstring (date-time)

The first instant of the month the override applied to.

beforenumber

Demand before the override.

afternumber

Demand after the override.

adjustmentstringenumValues:absolutedelta_unitsdelta_percent

How the override was expressed.

reasonstringnullableenumValues:new_customerlost_accountpromotion

Why the override exists.

Responses

200

Successful response for Preview Production Schedule

Preview Production Schedule

import Augno from '@augno/sdk';

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

const productionSchedulePreview = await client.operations.productionSchedules.actions.preview({
  horizon_weeks: 13,
});

console.log(productionSchedulePreview.campaigns);

import Augno from '@augno/sdk';

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

const productionSchedulePreview = await client.operations.productionSchedules.actions.preview({
  horizon_weeks: 13,
});

console.log(productionSchedulePreview.campaigns);

200 example

{
  "object": "production_schedule_preview",
  "solver_version": "v1",
  "planning_as_of_at": "2026-05-10T00:00:00Z",
  "policies": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "sku": "GREIGE-001",
        "annual_demand": 5200,
        "weekly_demand": 100,
        "seconds_per_unit": 30,
        "unit_cost": 4,
        "setup_cost": 0,
        "holding_cost": 0,
        "eoq_units": 720,
        "constraint_lead_time_weeks": 0,
        "finish_lead_time_weeks": 0,
        "safety_stock_primary": 0,
        "safety_stock_downstream": 0,
        "reorder_point": 900,
        "order_up_to": 0,
        "on_hand_echelon": 0,
        "on_hand_greige": 0,
        "average_greige_inventory": 0,
        "max_greige_inventory": 0,
        "weeks_of_cover": 0,
        "abc_class": "a",
        "annual_run_hours": 0
      }
    ]
  },
  "campaigns": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "sku": "GREIGE-001",
        "machine": {
          "id": "mc_0177d18f55a1615f783d3bf8d0",
          "object": "entity",
          "type": "machine",
          "name": null,
          "handle": null
        },
        "week_index": 0,
        "units": 720,
        "lots": 12,
        "run_hours": 6
      }
    ]
  },
  "projections": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "on_hand_by_week": [
          620,
          520
        ]
      }
    ]
  },
  "diagnostics": {
    "eoq_capped_skus": [],
    "unschedulable_skus": [],
    "capacity_starved_skus": [],
    "items_without_run_rate": [],
    "excluded_item_count": 0,
    "constraint_machine_count": 0,
    "measured_batch_count": 0,
    "machines_without_step": 0,
    "changeover_slope_minutes": 0,
    "average_inputs_added": 0,
    "applied_overrides": {
      "object": "list",
      "page_info": {
        "next_page_url": null,
        "previous_page_url": null,
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": []
    }
  }
}

{
  "object": "production_schedule_preview",
  "solver_version": "v1",
  "planning_as_of_at": "2026-05-10T00:00:00Z",
  "policies": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "sku": "GREIGE-001",
        "annual_demand": 5200,
        "weekly_demand": 100,
        "seconds_per_unit": 30,
        "unit_cost": 4,
        "setup_cost": 0,
        "holding_cost": 0,
        "eoq_units": 720,
        "constraint_lead_time_weeks": 0,
        "finish_lead_time_weeks": 0,
        "safety_stock_primary": 0,
        "safety_stock_downstream": 0,
        "reorder_point": 900,
        "order_up_to": 0,
        "on_hand_echelon": 0,
        "on_hand_greige": 0,
        "average_greige_inventory": 0,
        "max_greige_inventory": 0,
        "weeks_of_cover": 0,
        "abc_class": "a",
        "annual_run_hours": 0
      }
    ]
  },
  "campaigns": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "sku": "GREIGE-001",
        "machine": {
          "id": "mc_0177d18f55a1615f783d3bf8d0",
          "object": "entity",
          "type": "machine",
          "name": null,
          "handle": null
        },
        "week_index": 0,
        "units": 720,
        "lots": 12,
        "run_hours": 6
      }
    ]
  },
  "projections": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "on_hand_by_week": [
          620,
          520
        ]
      }
    ]
  },
  "diagnostics": {
    "eoq_capped_skus": [],
    "unschedulable_skus": [],
    "capacity_starved_skus": [],
    "items_without_run_rate": [],
    "excluded_item_count": 0,
    "constraint_machine_count": 0,
    "measured_batch_count": 0,
    "machines_without_step": 0,
    "changeover_slope_minutes": 0,
    "average_inputs_added": 0,
    "applied_overrides": {
      "object": "list",
      "page_info": {
        "next_page_url": null,
        "previous_page_url": null,
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": []
    }
  }
}

Preview Production Schedule

Authorization

Request Body

Returns

Responses