Upsert Production Schedule Item Setting

Beta
PUT/v1/operations/production-schedule-settings/items/{item_id}

This endpoint is idempotent. Learn more

Writes the planning overrides for one item.

An item has at most one set of overrides, so this replaces the existing entry rather than adding a second, and the entry keeps the ID it already had.

The fulfillment policy is the most consequential of these. A make_to_order item contributes no forecast demand and holds no safety stock, so it is built only against orders already on the book — which is what stops a slow mover accumulating inventory nobody asked for. It also propagates: an intermediate item is planned to order only when every finished good it becomes is, so one stocked sibling keeps the whole family buffered.

Overrides are read when a plan is generated, so a change takes effect on the next generated version and leaves existing ones untouched.

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

Item to override.

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

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

fulfillment_policyoptional stringnullableenumValues: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.

Clearing it returns the item to its product line's policy, then to the account default. Send null to clear.

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 Upsert Production Schedule Item Setting