Retrieve Item Lot Default

Beta

GET/v1/catalog/items/{id}/lot-default

This endpoint is idempotent. Learn more

Returns the lot this item is made in — how many, counted in what.

A lot is a doff, a pallet, a batch: the quantity production is issued in. The unit is what makes it meaningful, since 60 pairs and 60 eaches are different lots, so quantity should never be read without unit.

Resolved through the same chain the production schedule uses, most specific first: a per-item override, then the item's own product line, then the product lines of the finished goods it becomes, then the account-wide default. source names which rule applied. Intermediate items like greige are not sold and have no product line of their own, which is why they inherit from what they become.

quantity is 0 when nothing in the chain supplies a lot. That means the item has no lot convention, not that its lot is zero.

Permissions requiredValues:items:read

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

idstring

Item ID.

include[]optional arrayenumValues:unit

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:item_lot_default

Resource type identifier.

itementitynullable

The item the lot was resolved 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).

quantitynumber

Units in one lot.

0 means the item has no lot convention, not that its lot is zero.

unitunitExpandablenullable

The unit the lot is counted in.

A lot that came from a product line is counted in that line's unit; otherwise the item's own base unit is used. The unit is returned even when no rule supplies a lot size, so a form can show what is being counted with the quantity left blank.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

The dimension this unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

sourcestringenumValues:item_overrideproduct_linedownstream_product_line

Which rule in the chain produced this lot.

item_override: a lot size set on the item itself.
product_line: the convention of the line the item sells under.
downstream_product_line: inherited from the finished goods this item becomes, for intermediates that are not themselves sold.
account_default: the account-wide fallback.

Empty when no rule in the chain supplies a lot, which is the same case quantity reports as 0.

product_lineentitynullable

The product line the convention came from.

Present only when source is product_line or downstream_product_line; an item override and the account default do not come from a line.

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

Responses

200

Successful response for Retrieve Item Lot Default

Retrieve Item Lot Default

import OpenMRP from '@openmrp/sdk';

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

const itemLotDefault = await client.catalog.items.retrieveLotDefault('it_pej07ckhvu62');

console.log(itemLotDefault.item);

import OpenMRP from '@openmrp/sdk';

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

const itemLotDefault = await client.catalog.items.retrieveLotDefault('it_pej07ckhvu62');

console.log(itemLotDefault.item);

200 example

{
  "object": "item_lot_default",
  "item": {
    "id": "it_pej07ckhvu62",
    "object": "entity",
    "type": "item",
    "name": null,
    "handle": null
  },
  "quantity": 60,
  "unit": null,
  "source": "downstream_product_line",
  "product_line": {
    "id": "pdln_k9bnlgvxhxjh",
    "object": "entity",
    "type": "product_line",
    "name": null,
    "handle": null
  }
}

{
  "object": "item_lot_default",
  "item": {
    "id": "it_pej07ckhvu62",
    "object": "entity",
    "type": "item",
    "name": null,
    "handle": null
  },
  "quantity": 60,
  "unit": null,
  "source": "downstream_product_line",
  "product_line": {
    "id": "pdln_k9bnlgvxhxjh",
    "object": "entity",
    "type": "product_line",
    "name": null,
    "handle": null
  }
}

Retrieve Item Lot Default

Authorization

Path Parameters

Query Parameters

Returns

Responses