Skip to main content

Product

Summary

Schema

Relationships

Data Definitions

Data TypeField NameRulesAbout
StringalternateIdZero or OneThe alternate unique identifier of the product. The alternateId is an Alternate Key.
AttributeFieldattributeFieldZero to ManyRefer to: Attribute Field.
BillOfMaterialsbillOfMaterialsZero to ManyThe list of the components (bill of material items), and their quantities that make up an assembly.
MonetarycostZero or OneItem price before markup, taxes etc.
StringdescriptionZero or OneA written representation of the product.
ExtensionFieldextendedByZero to ManyRefer to: Extension Field.
ExternalIDexternalIdentityZero to ManyRefer to: External ID.
InventoryCostinginventoryCostingZero to ManyAllows for inventory costs to be allocated by manufacturing plant.
MagnitudemassZero or OneThe mass of the product.
StringNameZero or OneThe name of the product.
MonetarypriceZero or OneSelling price of the product.
ProductCategoryproductCategoryZero to ManyUsed to group related products in order to sort group products.
ProductGroupproductGroupZero to ManyA way to group similar products together for organizing products in the system.
ProductLifeCycleproductLifeCycleZero or OneNormal, Obsolete, PhaseOut.
ProductPlantproductPlantZero to ManyA collection of objects representing a physical location where products are manufactured or processed.
ProductStatusproductStatusZero or OneActive, Deleted, Obsolete.
RecordedByUserrecordedByZero to ManyThe user who captured the sales order in the originating system.
ProductSalesChannelsalesChannelZero to ManyThe product's sales channels.
StringskuZero or OneThe stock keeping unit is the business's internal unique identifier for a product or service.
IDskuHistoryZero to ManyA list of historical SKUs this product had.
StringsourceSystemCodeZero or OneRefer to: Source System.
StringsourceSystemIDZero or OneRefer to: Source System.
TaxTypetaxTypeZero or OneDescription and reference of the tax applied to the Sales Order. Refer to: Tax Type.
UnitOfMeasureuomZero or OneThe measurement unit used to keep track of this product.
MagnitudevolumeZero or OneThe volumetric measurement of this product.

Product Category

Data TypeField NameRulesAbout
StringcodeExactly 1
StringdescriptionZero or One

Product Group

Data TypeField NameRulesAbout
StringcodeExactly 1
StringdescriptionZero or One

Product Life Cycle

Data TypeField NameRulesAbout
StringcodeExactly 1
StringdescriptionZero or One

Product Status

Data TypeField NameRulesAbout
StringcodeExactly 1
StringdescriptionZero or One

Bill of Materials

A Bill of Materials (BOM) is a structured list of components, parts, and raw materials required to manufacture or assemble a product. The primary purpose of a BOM is to provide a detailed breakdown of what is needed to produce a particular product.

Data TypeField NameRulesAbout
StringalternateIdZero or OneThe alternate unique identifier of the bill of materials. The alternateId is an Alternate Key.
DecimalbaseQuantityZero or OneThe field is typically the quantity of the main or primary component or item needed to produce one unit of the final product. Which can serve as a reference point for calculating the quantities of other materials and components required for the assembly or production process.
BillOfMaterialsItembillOfMaterialsItemZero to ManyA component of the Bill of Materials.

Bill of Materials Item

A "Bill of Materials (BOM) item" refers to an individual component, part, or raw material that is listed within a Bill of Materials. In a BOM, each item is a distinct element or entity that contributes to the construction or assembly of a final product.

Data TypeField NameRulesAbout
ProductcatalogItemExactly 1The component Product for this BOM item.
StringlineNumberZero or OneThe line number for this BOM item help to order / sequence items in the BOM.
MagnitudequantityExactly 1The Magnitude (unit and amount) of the Product needed for this BOM item.

Product Plant

A product plant typically refers to a specific facility or organizational unit within a company where a particular product or group of products is manufactured, tracked, and managed.

Data TypeField NameRulesAbout
ProductPlantUnitOfMeasurealternateUomsZero to ManyAn alternate unit of measure for the product and its conversion for this product plant. factor.
ProductPlantUnitOfMeasureissueUomZero or OneThe the unit of measurement used when goods or products are being taken from inventory for various purposes, such as fulfilling orders, production, or consumption.
StringplantCodeZero or OneA unique identifier or code assigned to a specific manufacturing or production facility within an organization. The plant code is an Alternate Key.
StringprofitCenterZero or OneThe profit center code.
ProductPlantUnitOfMeasurestockKeepingUomZero or OneThe unit of measure for stock keeping.

Inventory Costing

An inventory costing allows for the allocation of inventory costs by manufacturing plant.

Data TypeField NameRulesAbout
InventoryCostingIteminventoryCostingItemZero to ManyInventory costing item.
MonetaryplannedPriceZero or OnePlanned price.

Inventory Costing Item

An inventory costing item refers to a line item listed within an inventory costing record.

Data TypeField NameRulesAbout
MonetarycostZero to ManyCost value for the item.
StringcostUnitZero to ManyCost unit for the item.

Product Sales Channel

The distribution channels used to sell products and services to customers for a given sales organization.

Data TypeField NameRulesAbout
StringdistributionChannelCodeZero or OneThe canonical code for the distribution channel.
StringsalesOrganizationCodeZero or OneThe canonical code for the sales organization.

Sample JSON

{
"@type": "Product",
"description": "Example Product Description",
"productLifeCycle": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "ProductLifeCycle",
"iri": "https://schema.limbergraph.com/limber/ProductLifeCycle#Normal",
"keys": [
{
"code": "Normal"
}
],
"label": "Current"
},
"productPlant": [
{
"@type": "ProductPlant",
"plantCode": "4324"
}
],
"billOfMaterials": [
{
"@type": "BillOfMaterials",
"billOfMaterialsItem": [
{
"@type": "BillOfMaterialsItem",
"uniqueText": "79f420ff-6908-45c6-b5d7-584072b21fd7",
"catalogItem": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "Product",
"iri": "https://schema.limbergraph.com/limber/Product#bff3e4cf-fd70-4ed1-8a75-e6b068811655",
"keys": [
{
"uniqueText": "bff3e4cf-fd70-4ed1-8a75-e6b068811655"
}
],
"label": "BOM Item 1"
},
"quantity": {
"@type": "Magnitude",
"uniqueText": "6696ac20-41dc-47b7-be70-1ac8919f953c",
"decimalValue": "0.300",
"uom": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "UnitOfMeasure",
"iri": "https://schema.limbergraph.com/limber/UnitOfMeasure#kg",
"keys": [
{
"code": "kg"
}
],
"label": "kg"
}
}
},
{
"@type": "BillOfMaterialsItem",
"uniqueText": "d493bb24-50da-49ca-b57c-7ece524138a0",
"catalogItem": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "Product",
"iri": "https://schema.limbergraph.com/limber/Product#f9ecbc49-ed50-4521-9590-6394b6b60e47",
"keys": [
{
"uniqueText": "f9ecbc49-ed50-4521-9590-6394b6b60e47"
}
],
"label": "BOM Item 2"
},
"quantity": {
"@type": "Magnitude",
"uniqueText": "c0c6386b-cada-4ac5-8121-d42b48c3c521",
"decimalValue": "1.000",
"uom": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "UnitOfMeasure",
"iri": "https://schema.limbergraph.com/limber/UnitOfMeasure#each",
"keys": [
{
"code": "each"
}
],
"label": "each"
}
}
},
{
"@type": "BillOfMaterialsItem",
"uniqueText": "d5fa52d7-f19f-4b5d-badd-4d21ebef2357",
"catalogItem": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "Product",
"iri": "https://schema.limbergraph.com/limber/Product#451a29b0-4ea9-4a52-8884-d64de1ad6c9f",
"keys": [
{
"uniqueText": "451a29b0-4ea9-4a52-8884-d64de1ad6c9f"
}
],
"label": "BOM Item 3"
},
"quantity": {
"@type": "Magnitude",
"uniqueText": "0ab4d65e-b26f-4515-b3a7-6429a8384948",
"decimalValue": "1.000",
"uom": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "UnitOfMeasure",
"iri": "https://schema.limbergraph.com/limber/UnitOfMeasure#each",
"keys": [
{
"code": "each"
}
],
"label": "each"
}
}
},
{
"@type": "BillOfMaterialsItem",
"uniqueText": "ee7d80bb-3e1f-442a-b631-c52aac42683c",
"catalogItem": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "Product",
"iri": "https://schema.limbergraph.com/limber/Product#89e87158-b245-4e47-a4d4-9a1ceff26341",
"keys": [
{
"uniqueText": "89e87158-b245-4e47-a4d4-9a1ceff26341"
}
],
"label": "BOM Item 4"
},
"quantity": {
"@type": "Magnitude",
"uniqueText": "cb739022-7141-43bc-8f85-2afd12126a97",
"decimalValue": "0.100",
"uom": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "UnitOfMeasure",
"iri": "https://schema.limbergraph.com/limber/UnitOfMeasure#each",
"keys": [
{
"code": "each"
}
],
"label": "each"
}
}
},
{
"@type": "BillOfMaterialsItem",
"uniqueText": "0f322573-40a3-44ce-ab7f-db3972fba728",
"catalogItem": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "Product",
"iri": "https://schema.limbergraph.com/limber/Product#8fecdad5-ba14-4dee-8211-f1d7eda8a196",
"keys": [
{
"uniqueText": "8fecdad5-ba14-4dee-8211-f1d7eda8a196"
}
],
"label": "BOM Item 5"
},
"quantity": {
"@type": "Magnitude",
"uniqueText": "220944d3-e03c-419b-a19b-b02ea742911c",
"decimalValue": "1.000",
"uom": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "UnitOfMeasure",
"iri": "https://schema.limbergraph.com/limber/UnitOfMeasure#each",
"keys": [
{
"code": "each"
}
],
"label": "each"
}
}
},
{
"@type": "BillOfMaterialsItem",
"uniqueText": "f8b6fba6-5e2d-4f60-a260-3497388992ea",
"catalogItem": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "Product",
"iri": "https://schema.limbergraph.com/limber/Product#fb86b7cc-700f-4066-a4bb-3a7735dc2c4b",
"keys": [
{
"uniqueText": "fb86b7cc-700f-4066-a4bb-3a7735dc2c4b"
}
],
"label": "BOM Item 6"
},
"quantity": {
"@type": "Magnitude",
"uniqueText": "45a76436-57d7-4d45-aba5-e2c7ddb1a836",
"decimalValue": "0.100",
"uom": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "UnitOfMeasure",
"iri": "https://schema.limbergraph.com/limber/UnitOfMeasure#each",
"keys": [
{
"code": "each"
}
],
"label": "each"
}
}
}
],
"uniqueText": "3f178590-692a-4f6f-be65-9ae5a2a7bb16"
}
],
"uom": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "UnitOfMeasure",
"iri": "https://schema.limbergraph.com/limber/UnitOfMeasure#each",
"keys": [
{
"code": "each"
}
],
"label": "each"
},
"uniqueText": "fe762af4-7218-45ea-ac3f-6d89b4b4f1f4",
"name": "KB PIllow 11-08-2023",
"sku": "30012034",
"mass": {
"@type": "Magnitude",
"decimalValue": "0.000",
"uom": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "UnitOfMeasure",
"iri": "https://schema.limbergraph.com/limber/UnitOfMeasure#kg",
"keys": [
{
"code": "kg"
}
],
"label": "kg"
},
"uniqueText": "30241bf8-c70c-441d-af8c-cef45e988a32"
},
"inventoryCosting": [
{
"@type": "InventoryCosting",
"inventoryCostingItem": [
{
"@type": "InventoryCostingItem",
"costUnit": "1",
"cost": {
"@type": "Monetary",
"decimalValue": "0.00",
"currency": {
"@type": "DataReference",
"schemaName": "limber",
"shapeName": "CurrencyUnit",
"iri": "https://schema.limbergraph.com/limber/CurrencyUnit#NZD",
"keys": [
{
"code": "NZD"
}
],
"label": "NZD"
},
"uniqueText": "30cd8883-3ba9-4f5a-80cc-17817659ddf5"
},
"uniqueText": "2d3ad047-efee-4428-adb4-766cbb675f09"
}
],
"uniqueText": "78dd9141-d41f-4292-92e4-c4fe3c72cb7f"
}
],
"salesChannel": [
{
"@type": "ProductSalesChannel",
"distributionChannelCode": "10",
"salesOrganizationCode": "6900"
}
]
}