Retrieve Production Schedule Item Setting

Beta

GET/v1/operations/production-schedule-settings/items/{item_id}

This endpoint is idempotent. Learn more

Returns the planning overrides for one item.

Fails with a not-found error when the item has none, rather than returning an empty set of overrides: an item with no overrides is planned on the account defaults and its product line's conventions, and reporting that as a resource would suggest there is something here to edit.

Permissions requiredValues:production_schedules:read

The role behind your API key or agent must grant every one of these permissions.

item_idstring

Item whose overrides are being read.

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

Retrieve Production Schedule Item Setting

import OpenMRP from '@openmrp/sdk';

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

const productionScheduleItemSetting =
  await client.operations.productionScheduleSettings.items.retrieve('example');

console.log(productionScheduleItemSetting.id);

import OpenMRP from '@openmrp/sdk';

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

const productionScheduleItemSetting =
  await client.operations.productionScheduleSettings.items.retrieve('example');

console.log(productionScheduleItemSetting.id);

200 example

{
  "id": "pnscitsd_kw83nzq4mrt6",
  "object": "production_schedule_item_setting",
  "item": {
    "id": "it_pej07ckhvu62",
    "object": "entity",
    "type": "item",
    "name": null,
    "handle": "LKN-001"
  },
  "participation_status": "included",
  "lot_multiple_units": 60,
  "fulfillment_policy": "make_to_order",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "pnscitsd_kw83nzq4mrt6",
  "object": "production_schedule_item_setting",
  "item": {
    "id": "it_pej07ckhvu62",
    "object": "entity",
    "type": "item",
    "name": null,
    "handle": "LKN-001"
  },
  "participation_status": "included",
  "lot_multiple_units": 60,
  "fulfillment_policy": "make_to_order",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Production Schedule Item Setting

Authorization

Path Parameters

Returns

Responses