List Production Schedule Item Settings

Beta
GET/v1/operations/production-schedule-settings/items

This endpoint is idempotent. Learn more

Returns every per-item planning override in the account.

Only items that have been given an override appear here. An item with none is planned on the account defaults and its product line's conventions, which is the normal case — this is the list of exceptions, not a list of every item.

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

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of production_schedule_item_setting

Resources in this page.

idstring

Item setting ID.

objectstringenumValues:production_schedule_item_setting

Resource type identifier.

itementitynullable

The item these overrides apply 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).

participation_statusstringenumValues:includedexcluded

Whether this item takes part in planning.

An excluded item is left out of the plan entirely: no campaigns, no policy, no capacity.

lot_multiple_unitsnumbernullable

Units in one production lot for this item, overriding the lot its product line would supply.

fulfillment_policystringnullableenumValues:make_to_stockmake_to_order

How this item is produced.

  • make_to_stock: built to the forecast, holding a safety stock against its variability.
  • make_to_order: built only against orders already on the book, holding no buffer.

Null inherits from the item's product line, then from the account default.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Production Schedule Item Settings