Retrieve Product Line

Beta

GET/v1/catalog/product-lines/{id}

This endpoint is idempotent. Learn more

Returns a single product line by ID.

Both the product lines your account owns and the shared system lines can be retrieved.

Permissions requiredValues:product_lines:readcustomers:readsuppliers:read

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

idstring

Product line ID.

include[]optional arrayenumValues:ownerowner.accountunit_group

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

idstring

Product line ID.

objectstringenumValues:product_line

Resource type identifier.

namestring

Display name of the product line.

Unique among the product lines visible to your account, which includes the shared system lines.

descriptionstringnullable

Free-form description of the product line.

notesstringnullable

Free-form notes about the product line.

commission_policystringenumValues:commission_appliedcommission_exempt

Default commission policy for products in this product line.

commission_exempt: no commission applies to these products.
commission_applied: commission applies to these products, unless overridden elsewhere.

freight_policystringenumValues:free_freightbilled_freight

Default freight policy for products in this product line.

free_freight: these products do not incur a freight charge.
billed_freight: freight is billed for these products, unless overridden elsewhere.

ownerownerExpandablenullable

Owner of the product line.

System-owned product lines are platform-provided and shared across all accounts; account-owned product lines are custom to your account. Only account-owned product lines can be updated, deleted, or granted to customers and account groups.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountExpandablenullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

The address billed by default on orders for this account.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

Always returned as null in this endpoint.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_groupunit_groupExpandablenullable

Unit group associated with this product line.

The unit group determines the set of units available to products in this product line.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name of the unit group.

Unique within the account.

notesstringnullable

Free-form notes about the unit group.

typestringenumValues:currencyquantitytime

The dimension shared by every unit in this group, such as mass, volume, or currency.

Only units of this dimension can belong to the group, and the dimension is fixed once the group is created.

base_unitunitnullable

The reference unit designated for this group.

Always returned as null in this endpoint.

associated_unitslistnullable

Units associated with this group, each with its own discount and customer portal visibility settings.

Always returned as null in this endpoint.

ownerownerExpandablenullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_lotquantityExpandablenullable

The lot products in this line are made in — a doff, a pallet.

Sizes the campaigns a production schedule plans, and defaults the quantity when a batch is added to a production run. The unit is part of the value — 60 counted in pairs and 60 counted in eaches are different lots — and is drawn from this product line's unit group.

An item's own lot override still takes precedence over the line's. When the line has no lot convention, planning falls back to the lot of the line the item feeds into, and then to the account-wide default lot size.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitExpandablenullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

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.

fulfillment_policystringnullableenumValues:make_to_stockmake_to_order

How products in this line are produced when they do not say for themselves.

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 falls through to the account default.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for Retrieve Product Line

Retrieve Product Line

import OpenMRP from '@openmrp/sdk';

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

const productLine = await client.catalog.productLines.retrieve('pdln_k9bnlgvxhxjh');

console.log(productLine.id);

import OpenMRP from '@openmrp/sdk';

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

const productLine = await client.catalog.productLines.retrieve('pdln_k9bnlgvxhxjh');

console.log(productLine.id);

200 example

{
  "id": "pdln_k9bnlgvxhxjh",
  "object": "product_line",
  "name": "Industrial Fasteners",
  "description": "Bolts, screws, and anchors for heavy industrial assembly.",
  "notes": "Priced per the 2026 supplier contract; review pricing each quarter.",
  "commission_policy": "commission_exempt",
  "freight_policy": "billed_freight",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "unit_group": {
    "id": "ug_andst6m79n41",
    "object": "unit_group",
    "name": "Weight",
    "notes": "Mass units used for ordering raw materials by weight.",
    "type": "mass",
    "base_unit": null,
    "associated_units": null,
    "owner": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "default_lot": {
    "id": "qty_8hnxbigf0bod",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": {
      "id": "un_82bd37dae5po",
      "object": "unit",
      "name": "US Dollar",
      "abbreviation": "$",
      "type": "currency",
      "ratio_numerator": "1",
      "ratio_denominator": "1",
      "offset_numerator": "0",
      "offset_denominator": "1",
      "is_base_unit": true,
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "fulfillment_policy": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "pdln_k9bnlgvxhxjh",
  "object": "product_line",
  "name": "Industrial Fasteners",
  "description": "Bolts, screws, and anchors for heavy industrial assembly.",
  "notes": "Priced per the 2026 supplier contract; review pricing each quarter.",
  "commission_policy": "commission_exempt",
  "freight_policy": "billed_freight",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "unit_group": {
    "id": "ug_andst6m79n41",
    "object": "unit_group",
    "name": "Weight",
    "notes": "Mass units used for ordering raw materials by weight.",
    "type": "mass",
    "base_unit": null,
    "associated_units": null,
    "owner": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "default_lot": {
    "id": "qty_8hnxbigf0bod",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": {
      "id": "un_82bd37dae5po",
      "object": "unit",
      "name": "US Dollar",
      "abbreviation": "$",
      "type": "currency",
      "ratio_numerator": "1",
      "ratio_denominator": "1",
      "offset_numerator": "0",
      "offset_denominator": "1",
      "is_base_unit": true,
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "fulfillment_policy": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Product Line

Authorization

Path Parameters

Query Parameters

Returns

Responses