Preview Production Schedule Regenerate

Beta

PUT/v1/operations/production-schedules/{id}/actions/preview-regenerate

This endpoint is idempotent. Learn more

Returns what regenerating this draft would change, without changing it.

Every campaign either plan holds is listed, including the ones both agree on, so the caller can render a full side-by-side rather than a list of surprises. discarded_manual_count is what replace_all would destroy — a regenerate that silently eats hand-work is abandoned within two cycles, so the destructive mode has to be able to state its cost before it runs.

Planning inputs default to the ones the version was generated with, so a plain preview answers "what would the solver say now" rather than answering a different question with a different horizon.

Permissions requiredValues:production_schedules:read

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

idstring

ID of the production schedule.

planning_as_ofoptional string (date-time)

Date to plan from. Defaults to the date the version was generated for.

horizon_weeksoptional integer

Weeks the plan should cover. Defaults to the version's own horizon.

demand_basisoptional stringenumValues:trailing_12seasonal_ema

How demand is derived. Defaults to the version's own basis.

objectstringenumValues:production_schedule_regenerate_preview

Resource type identifier.

production_scheduleentitynullable

The draft this would act on.

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

solver_versionstring

Which solver produced the proposal.

planning_as_of_atstring (date-time)

The instant the fresh solve planned from.

lineslistnullable

Every campaign either plan holds, including the ones both agree on.

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.

changestringenumValues:addedremovedchanged

What the regenerate would do to this campaign.

itementitynullable

The item the campaign produces.

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 that item.

machineentitynullable

The machine the campaign runs on.

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 horizon week.

current_quantitynumber

Units the current plan asks for. Zero when the campaign is being added.

proposed_quantitynumber

Units the fresh solve asks for. Zero when the campaign is being removed.

current_is_manualboolean

Whether the current campaign was created or edited by a person.

added_countinteger

Campaigns the fresh solve wants that the current plan does not have.

removed_countinteger

Campaigns the current plan has that the fresh solve does not want.

changed_countinteger

Campaigns both hold, in different quantities.

manual_line_countinteger

Hand-edited campaigns currently on the draft.

discarded_manual_countinteger

Hand-edited campaigns replace_all would destroy.

Responses

200

Successful response for Preview Production Schedule Regenerate

Preview Production Schedule Regenerate

import Augno from '@augno/sdk';

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

const productionScheduleRegeneratePreview =
  await client.operations.productionSchedules.actions.previewRegenerate(
    'pnsc_0192a4c17b3e4f8a91c2d0',
    { horizon_weeks: 13 },
  );

console.log(productionScheduleRegeneratePreview.added_count);

import Augno from '@augno/sdk';

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

const productionScheduleRegeneratePreview =
  await client.operations.productionSchedules.actions.previewRegenerate(
    'pnsc_0192a4c17b3e4f8a91c2d0',
    { horizon_weeks: 13 },
  );

console.log(productionScheduleRegeneratePreview.added_count);

200 example

{
  "object": "production_schedule_regenerate_preview",
  "production_schedule": {
    "id": "pnsc_0192a4c17b3e4f8a91c2d0",
    "object": "entity",
    "type": "production_schedule",
    "name": null,
    "handle": null
  },
  "solver_version": "1.0.0",
  "planning_as_of_at": "2026-05-10T00:00:00Z",
  "lines": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "change": "changed",
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "sku": "MZ-CREW-BLK-L",
        "machine": {
          "id": "mc_0177d18f55a1615f783d3bf8d0",
          "object": "entity",
          "type": "machine",
          "name": null,
          "handle": null
        },
        "week_index": 2,
        "current_quantity": 600,
        "proposed_quantity": 720,
        "current_is_manual": false
      }
    ]
  },
  "added_count": 1,
  "removed_count": 0,
  "changed_count": 1,
  "manual_line_count": 0,
  "discarded_manual_count": 0
}

{
  "object": "production_schedule_regenerate_preview",
  "production_schedule": {
    "id": "pnsc_0192a4c17b3e4f8a91c2d0",
    "object": "entity",
    "type": "production_schedule",
    "name": null,
    "handle": null
  },
  "solver_version": "1.0.0",
  "planning_as_of_at": "2026-05-10T00:00:00Z",
  "lines": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "change": "changed",
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "sku": "MZ-CREW-BLK-L",
        "machine": {
          "id": "mc_0177d18f55a1615f783d3bf8d0",
          "object": "entity",
          "type": "machine",
          "name": null,
          "handle": null
        },
        "week_index": 2,
        "current_quantity": 600,
        "proposed_quantity": 720,
        "current_is_manual": false
      }
    ]
  },
  "added_count": 1,
  "removed_count": 0,
  "changed_count": 1,
  "manual_line_count": 0,
  "discarded_manual_count": 0
}

Preview Production Schedule Regenerate

Authorization

Path Parameters

Request Body

Returns

Responses