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

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

Physical dimension the 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)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

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.

product_lineentitynullable

The product line the convention came from.

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 Augno from '@augno/sdk';

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

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

console.log(itemLotDefault.item);

import Augno from '@augno/sdk';

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

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

console.log(itemLotDefault.item);

200 example

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

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

Retrieve Item Lot Default

Authorization

Path Parameters

Query Parameters

Returns

Responses