Product

Summary

Schema

Relationships

Data Definitions

Data Type	Field Name	Rules	About
String	alternateId	Zero or One	The alternate unique identifier of the product. The alternateId is an Alternate Key.
AttributeField	attributeField	Zero to Many	Refer to: Attribute Field.
BillOfMaterials	billOfMaterials	Zero to Many	The list of the components (bill of material items), and their quantities that make up an assembly.
Monetary	cost	Zero or One	Item price before markup, taxes etc.
String	description	Zero or One	A written representation of the product.
DuplicateRecord	duplicateRecords	Zero to Many	The duplicate records for a product.
ExtensionField	extendedBy	Zero to Many	Refer to: Extension Field.
ExternalID	externalIdentity	Zero to Many	Refer to: External ID.
InventoryCosting	inventoryCosting	Zero to Many	Allows for inventory costs to be allocated by manufacturing plant.
Magnitude	mass	Zero or One	The mass of the product.
String	Name	Zero or One	The name of the product.
Monetary	price	Zero or One	Selling price of the product.
ProductCategory	productCategory	Zero to Many	Used to group related products in order to sort group products.
ProductGroup	productGroup	Zero to Many	A way to group similar products together for organizing products in the system.
ProductLifeCycle	productLifeCycle	Zero or One	Normal, Obsolete, PhaseOut.
ProductPlant	productPlant	Zero to Many	A collection of objects representing a physical location where products are manufactured or processed.
ProductStatus	productStatus	Zero or One	Active, Deleted, Obsolete.
RecordedByUser	recordedBy	Zero to Many	The user who captured the sales order in the originating system.
ProductSalesChannel	salesChannel	Zero to Many	The product's sales channels.
String	sku	Zero or One	The stock keeping unit is the business's internal unique identifier for a product or service.
ID	skuHistory	Zero to Many	A list of historical SKUs this product had.
String	sourceSystemCode	Zero or One	Refer to: Source System.
String	sourceSystemID	Zero or One	Refer to: Source System.
TaxType	taxType	Zero or One	Description and reference of the tax applied to the Sales Order. Refer to: Tax Type.
UnitOfMeasure	uom	Zero or One	The measurement unit used to keep track of this product.
Magnitude	volume	Zero or One	The volumetric measurement of this product.

Note omitted fields: attributeField, extendedBy, externalIdentity, recordedBy, sourceSystemCode, sourceSystemId, uniqueText

Product Category

Data Type	Field Name	Rules	About
String	code	Exactly 1
String	description	Zero or One

Product Group

Data Type	Field Name	Rules	About
String	code	Exactly 1
String	description	Zero or One

Product Life Cycle

Data Type	Field Name	Rules	About
String	code	Exactly 1
String	description	Zero or One

Product Status

Data Type	Field Name	Rules	About
String	code	Exactly 1
String	description	Zero 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 Type	Field Name	Rules	About
String	alternateId	Zero or One	The alternate unique identifier of the bill of materials. The alternateId is an Alternate Key.
Decimal	baseQuantity	Zero or One	The 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.
BillOfMaterialsItem	billOfMaterialsItem	Zero to Many	A 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 Type	Field Name	Rules	About
Product	catalogItem	Exactly 1	The component Product for this BOM item.
String	lineNumber	Zero or One	The line number for this BOM item help to order / sequence items in the BOM.
Magnitude	quantity	Exactly 1	The 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 Type	Field Name	Rules	About
ProductPlantUnitOfMeasure	alternateUoms	Zero to Many	An alternate unit of measure for the product and its conversion for this product plant. factor.
ProductPlantUnitOfMeasure	issueUom	Zero or One	The the unit of measurement used when goods or products are being taken from inventory for various purposes, such as fulfilling orders, production, or consumption.
String	plantCode	Zero or One	A unique identifier or code assigned to a specific manufacturing or production facility within an organization. The plant code is an Alternate Key.
String	profitCenter	Zero or One	The profit center code.
ProductPlantUnitOfMeasure	stockKeepingUom	Zero or One	The unit of measure for stock keeping.

Inventory Costing

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

Data Type	Field Name	Rules	About
InventoryCostingItem	inventoryCostingItem	Zero to Many	Inventory costing item.
Monetary	plannedPrice	Zero or One	Planned price.

Inventory Costing Item

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

Data Type	Field Name	Rules	About
Monetary	cost	Zero to Many	Cost value for the item.
String	costUnit	Zero to Many	Cost unit for the item.

Product Sales Channel

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

Data Type	Field Name	Rules	About
String	distributionChannelCode	Zero or One	The canonical code for the distribution channel.
String	salesOrganizationCode	Zero or One	The canonical code for the sales organization.

Duplicate Records

A collection of associated product information that has been consolidated from multiple entries representing the same product, i.e. duplicates.

Data Type	Field Name	Rules	About
String	sku	Zero or One	The sku of the product duplicate.
String	description	Zero or One	The product description of the product duplicate.

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"
    }
  ],
  "duplicateRecords": [
    {
      "@type": "DuplicateRecord",
      "sku": "30012035"
      "description": "My Duplicate Example Product Description",
    }
  ]
}

Summary​

Schema​

Relationships​

Data Definitions​

Product Category​

Product Group​

Product Life Cycle​

Product Status​

Bill of Materials​

Bill of Materials Item​

Product Plant​

Inventory Costing​

Inventory Costing Item​

Product Sales Channel​

Duplicate Records​

Sample JSON​