Production Schedules

The production_schedule object

A saved production schedule.

Versions are immutable history: generating again creates a new version, and publishing supersedes the previous one rather than editing it, because attainment is measured against whichever version was live at the time.

idstring

Schedule ID.

objectstringenumValues:production_schedule

Resource type identifier.

versioninteger

Sequential version number within the account.

statusstringenumValues:draftgeneratingpublished

Where this version is in its lifecycle.

namestringnullable

Optional label for the version.

planning_as_of_atstring (date-time)

The instant the plan was calculated against.

horizon_starts_atstring (date-time)

First instant of the horizon.

horizon_ends_atstring (date-time)

First instant of the last day of the horizon.

horizon_weeksinteger

Length of the horizon in weeks.

frozen_weeksinteger

How many leading weeks freeze on publish.

frozen_through_atstring (date-time)nullable

Last instant covered by the frozen window, set when the version is published.

demand_basisstringenumValues:trailing_12seasonal_ema

Which demand basis produced the plan.

generation_sourcestringenumValues:manualscheduled

What triggered the generation.

solver_versionstring

Version of the solver that produced the plan.

settings_snapshotobject

The planning assumptions used, frozen at generation so the plan stays explainable after settings change.

diagnosticsobject

What the solver could not do, frozen at generation.

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.

error_messagestringnullable

Why generation failed, when it did.

frozen_line_countinteger

Number of lines that were frozen at publish. Captured once and never recomputed, because frozen-week adherence measures against what was committed to.

frozen_planned_quantitynumber

Total quantity frozen at publish.

generated_byactornullable

The actor that generated this version.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

user: a human user account.
api_key: a programmatic caller authenticating with an API key.
agent: an automated agent acting on the account's behalf.
group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.

namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

For user actors: the user's email address.
For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

admin: full administrative access, including managing API keys.
user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
scanner: a role for scanning-station operators.
sales_rep: a role for sales representatives.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

geolocationgeolocationnullable

Geolocation details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

Default shipping address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

geolocationgeolocationnullable

Geolocation details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL.

favicon_urlstringnullable

Customer-portal favicon URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

URL slug that identifies the account's customer portal.

Unique across all accounts.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

published_byactornullable

The actor that published this version.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

user: a human user account.
api_key: a programmatic caller authenticating with an API key.
agent: an automated agent acting on the account's behalf.
group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.

namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

For user actors: the user's email address.
For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

admin: full administrative access, including managing API keys.
user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
scanner: a role for scanning-station operators.
sales_rep: a role for sales representatives.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

geolocationgeolocationnullable

Geolocation details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

Default shipping address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

geolocationgeolocationnullable

Geolocation details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL.

favicon_urlstringnullable

Customer-portal favicon URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

URL slug that identifies the account's customer portal.

Unique across all accounts.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

published_atstring (date-time)nullable

When this version was published.

superseded_byentitynullable

The version that replaced this one.

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

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

production_schedule example

{
  "id": "pnsc_0192a4c17b3e4f8a91c2d0",
  "object": "production_schedule",
  "version": 3,
  "status": "published",
  "name": "May planning cycle",
  "planning_as_of_at": "2026-05-10T00:00:00Z",
  "horizon_starts_at": "2026-05-10T00:00:00Z",
  "horizon_ends_at": "2026-08-08T00:00:00Z",
  "horizon_weeks": 13,
  "frozen_weeks": 1,
  "frozen_through_at": "2026-05-17T00:00:00Z",
  "demand_basis": "trailing_12",
  "generation_source": "manual",
  "solver_version": "v1",
  "settings_snapshot": {
    "capacity_headroom_pct": 0.9,
    "frozen_weeks": 1,
    "hours_per_shift": 7,
    "planning_horizon_weeks": 13,
    "shifts_per_day": 2
  },
  "diagnostics": {
    "eoq_capped_skus": [
      "MZ-GREIGE-QTR"
    ],
    "unschedulable_skus": [],
    "capacity_starved_skus": [
      "MZ-GREIGE-KNEE"
    ],
    "items_without_run_rate": [
      "MZ-GREIGE-ANKLE"
    ],
    "excluded_item_count": 4,
    "constraint_machine_count": 6,
    "measured_batch_count": 1240,
    "machines_without_step": 1,
    "changeover_slope_minutes": 2.5,
    "average_inputs_added": 3.2,
    "applied_overrides": {
      "object": "list",
      "page_info": {
        "next_page_url": null,
        "previous_page_url": null,
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": [
        {
          "override": {
            "id": "deov_0192b7d38c4f5a9b02d3e16f88",
            "object": "entity",
            "type": "demand_override",
            "name": null,
            "handle": null
          },
          "item": {
            "id": "it_0131e386ac683e8c29a71f6f1f",
            "object": "entity",
            "type": "item",
            "name": null,
            "handle": "MZ-GREIGE-CREW"
          },
          "month_starts_at": "2026-09-01T00:00:00Z",
          "before": 2000,
          "after": 3667,
          "adjustment": "delta_units",
          "reason": "new_customer"
        }
      ]
    }
  },
  "error_message": null,
  "frozen_line_count": 6,
  "frozen_planned_quantity": 4320,
  "generated_by": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@augno.com",
    "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "role": {
      "id": "rl_01c16d2eb637c0d1f3a372937c",
      "object": "role",
      "name": "Admin",
      "type": "admin",
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "default_billing_address": null,
          "default_shipping_address": null,
          "branding": null,
          "portal": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "permissions": [
        "customers:create",
        "customers:read",
        "customers:update",
        "customers:delete"
      ],
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "published_by": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@augno.com",
    "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "role": {
      "id": "rl_01c16d2eb637c0d1f3a372937c",
      "object": "role",
      "name": "Admin",
      "type": "admin",
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "default_billing_address": null,
          "default_shipping_address": null,
          "branding": null,
          "portal": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "permissions": [
        "customers:create",
        "customers:read",
        "customers:update",
        "customers:delete"
      ],
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "published_at": "2026-05-10T00:23:00Z",
  "superseded_by": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "pnsc_0192a4c17b3e4f8a91c2d0",
  "object": "production_schedule",
  "version": 3,
  "status": "published",
  "name": "May planning cycle",
  "planning_as_of_at": "2026-05-10T00:00:00Z",
  "horizon_starts_at": "2026-05-10T00:00:00Z",
  "horizon_ends_at": "2026-08-08T00:00:00Z",
  "horizon_weeks": 13,
  "frozen_weeks": 1,
  "frozen_through_at": "2026-05-17T00:00:00Z",
  "demand_basis": "trailing_12",
  "generation_source": "manual",
  "solver_version": "v1",
  "settings_snapshot": {
    "capacity_headroom_pct": 0.9,
    "frozen_weeks": 1,
    "hours_per_shift": 7,
    "planning_horizon_weeks": 13,
    "shifts_per_day": 2
  },
  "diagnostics": {
    "eoq_capped_skus": [
      "MZ-GREIGE-QTR"
    ],
    "unschedulable_skus": [],
    "capacity_starved_skus": [
      "MZ-GREIGE-KNEE"
    ],
    "items_without_run_rate": [
      "MZ-GREIGE-ANKLE"
    ],
    "excluded_item_count": 4,
    "constraint_machine_count": 6,
    "measured_batch_count": 1240,
    "machines_without_step": 1,
    "changeover_slope_minutes": 2.5,
    "average_inputs_added": 3.2,
    "applied_overrides": {
      "object": "list",
      "page_info": {
        "next_page_url": null,
        "previous_page_url": null,
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": [
        {
          "override": {
            "id": "deov_0192b7d38c4f5a9b02d3e16f88",
            "object": "entity",
            "type": "demand_override",
            "name": null,
            "handle": null
          },
          "item": {
            "id": "it_0131e386ac683e8c29a71f6f1f",
            "object": "entity",
            "type": "item",
            "name": null,
            "handle": "MZ-GREIGE-CREW"
          },
          "month_starts_at": "2026-09-01T00:00:00Z",
          "before": 2000,
          "after": 3667,
          "adjustment": "delta_units",
          "reason": "new_customer"
        }
      ]
    }
  },
  "error_message": null,
  "frozen_line_count": 6,
  "frozen_planned_quantity": 4320,
  "generated_by": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@augno.com",
    "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "role": {
      "id": "rl_01c16d2eb637c0d1f3a372937c",
      "object": "role",
      "name": "Admin",
      "type": "admin",
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "default_billing_address": null,
          "default_shipping_address": null,
          "branding": null,
          "portal": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "permissions": [
        "customers:create",
        "customers:read",
        "customers:update",
        "customers:delete"
      ],
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "published_by": {
    "id": "us_0151164dcaea4cbded27b50aae",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@augno.com",
    "avatar_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
    "role": {
      "id": "rl_01c16d2eb637c0d1f3a372937c",
      "object": "role",
      "name": "Admin",
      "type": "admin",
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "default_billing_address": null,
          "default_shipping_address": null,
          "branding": null,
          "portal": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "permissions": [
        "customers:create",
        "customers:read",
        "customers:update",
        "customers:delete"
      ],
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "published_at": "2026-05-10T00:23:00Z",
  "superseded_by": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Production Schedules

Attributes

Used by