List Production Schedule Item Policies

Beta
GET/v1/operations/production-schedules/{id}/item-policies

This endpoint is idempotent. Learn more

Returns the per-item policy behind a schedule version, ordered by constraint run hours descending.

This is the "why" behind every campaign: lot size, reorder point, safety stock and lead times as they stood when the plan was generated.

Permissions requiredValues:production_schedules:read
The role behind your API key or agent must grant every one of these permissions.
idstring

ID of the schedule version.

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 production_schedule_item_policy

Resources in this page.

idstring

Policy ID.

objectstringenumValues:production_schedule_item_policy

Resource type identifier.

production_scheduleentitynullable

The schedule version this policy belongs to.

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

unitentitynullable

Unit every quantity in this policy is counted in.

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

unit_abbreviationstringnullable

Abbreviation of the unit every quantity in this policy is counted in, for display.

A reorder point of 2,508 is uninterpretable without it, so the two are never meaningful apart.

production_stepentitynullable

The production step the item runs at.

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

primary_machineentitynullable

The machine the item usually 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).

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.

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.

sigma_weekly_poolednumber

Pooled weekly demand variability at the constraint.

sigma_downstream_sumnumber

Summed weekly variability of the finished goods this item becomes.

safety_stock_primarynumber

Buffer held at the constraint.

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 at the constraint plus everything downstream of it. This is what the build decision is made against — stock already finished still counts against building more.

on_hand_greigenumber

Stock sitting at the constraint stage on its own, which the echelon figure cannot be decomposed back into once summed.

average_greige_inventorynumber

What the constraint stage holds on average: its buffer, plus half a campaign as one lands and drains.

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.

projected_on_handarray of number

The echelon position at the end of each horizon week, after that week's campaigns land and its demand is drawn down. A run of weeks with no campaign is stock draining toward reorder_point; this is what makes that visible rather than looking like the solver did nothing.

annual_run_hoursnumber

Constraint hours this item's annual demand consumes.

abc_classstringnullableenumValues:abc

ABC class by share of constraint run hours.

constraintsarray of stringenumValues:eoq_cappedcapacity_starved

Limits the solver hit while sizing this item's campaigns. Empty when the policy was applied as calculated.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Production Schedule Item Policies