Preview Production Schedule Week Release

Beta

GET/v1/operations/production-schedules/{id}/week-release-preview

This endpoint is idempotent. Learn more

Returns what releasing a week would create, without creating it.

The lots are resolved exactly as the release itself resolves them, so what a planner is shown and what the floor receives cannot drift apart.

is_releasable is false when the week is empty or already released, with blocked_reason saying which; existing_production_run_id names the run a released week is already tied to.

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.

week_indexoptional integer

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

objectstringenumValues:production_schedule_week_release_preview

Resource type identifier.

week_indexinteger

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

week_starts_atstring (date-time)

First instant of the week.

line_countinteger

How many campaigns would be released.

batch_countinteger

How many batches would be created.

total_quantitynumber

Total units that would be released.

lineslistnullable

The campaigns that would be released, each with its lots.

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.

lineentitynullable

The schedule line released.

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

The item's SKU, as it stood when the plan was generated.

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

planned_quantitynumber

Total units planned for the campaign.

lot_unitsnumber

Units in one lot.

unitstringnullable

Abbreviation of the unit the quantity and the lot are counted in.

6 × 60 is not an instruction until it says 6 × 60 of what.

batch_countinteger

How many batches the campaign broke into.

batcheslistnullable

The individual lots, in run order.

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 the batch 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

The item's SKU, as it stood when the plan was generated.

quantitynumber

Units in this lot. The last lot of a campaign is short when the planned quantity is not a whole number of lots.

batchentitynullable

The batch that was created. Null on a preview, where nothing has been written.

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

is_releasableboolean

Whether the week can be released.

blocked_reasonstringnullable

Why the week cannot be released.

existing_production_runentitynullable

The run the week was already released as.

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

Responses

200

Successful response for Preview Production Schedule Week Release

Preview Production Schedule Week Release

import Augno from '@augno/sdk';

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

const releaseScheduleWeekPreview =
  await client.operations.productionSchedules.retrieveWeekReleasePreview(
    'pnsc_0192a4c17b3e4f8a91c2d0',
  );

console.log(releaseScheduleWeekPreview.batch_count);

import Augno from '@augno/sdk';

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

const releaseScheduleWeekPreview =
  await client.operations.productionSchedules.retrieveWeekReleasePreview(
    'pnsc_0192a4c17b3e4f8a91c2d0',
  );

console.log(releaseScheduleWeekPreview.batch_count);

200 example

{
  "object": "production_schedule_week_release_preview",
  "week_index": 0,
  "week_starts_at": "2026-05-10T00:00:00Z",
  "line_count": 1,
  "batch_count": 6,
  "total_quantity": 360,
  "lines": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "line": {
          "id": "pnscln_0192a4c17b3e4f8a91c2",
          "object": "entity",
          "type": "production_schedule_line",
          "name": null,
          "handle": null
        },
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "sku": "MZ-GREIGE-CREW",
        "machine": {
          "id": "mc_0177d18f55a1615f783d3bf8d0",
          "object": "entity",
          "type": "machine",
          "name": "Knitter 3",
          "handle": null
        },
        "planned_quantity": 360,
        "lot_units": 60,
        "unit": null,
        "batch_count": 6,
        "batches": {
          "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": "MZ-GREIGE-CREW",
              "quantity": 60,
              "batch": null
            }
          ]
        }
      }
    ]
  },
  "is_releasable": true,
  "blocked_reason": null,
  "existing_production_run": null
}

{
  "object": "production_schedule_week_release_preview",
  "week_index": 0,
  "week_starts_at": "2026-05-10T00:00:00Z",
  "line_count": 1,
  "batch_count": 6,
  "total_quantity": 360,
  "lines": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "line": {
          "id": "pnscln_0192a4c17b3e4f8a91c2",
          "object": "entity",
          "type": "production_schedule_line",
          "name": null,
          "handle": null
        },
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": null
        },
        "sku": "MZ-GREIGE-CREW",
        "machine": {
          "id": "mc_0177d18f55a1615f783d3bf8d0",
          "object": "entity",
          "type": "machine",
          "name": "Knitter 3",
          "handle": null
        },
        "planned_quantity": 360,
        "lot_units": 60,
        "unit": null,
        "batch_count": 6,
        "batches": {
          "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": "MZ-GREIGE-CREW",
              "quantity": 60,
              "batch": null
            }
          ]
        }
      }
    ]
  },
  "is_releasable": true,
  "blocked_reason": null,
  "existing_production_run": null
}

Preview Production Schedule Week Release

Authorization

Path Parameters

Query Parameters

Returns

Responses