Skip to main content

Interface: ItemMaster

Represents core product or component data for inventory and order fulfillment.

The ItemMaster interface contains detailed information about a product or component's physical characteristics, logistics data, and inventory identifiers. A finished product may reference multiple ItemMaster records for different components or aspects of the product.

ItemMaster data is linked directly to the pricing system through the same code structure used by MarketCostPrice. If a price code doesn't have a matching entry in the MarketCostPrice system, its ItemMaster information won't be used either, ensuring consistency between pricing and inventory data.

Example​

// Retrieving shipping information for a configured product
const chair = {
  itemMasters: [{
    code: "CHAIR-OAK-STD",
    deliveryTime: 14,  // 14 days lead time
    dimensions: {
      width: 60,
      depth: 65,
      height: 95,
      weight: 12.5
    },
    m3: 0.37  // Cubic meters for shipping volume
  }]
};

// Calculating shipping parameters
function getShippingDetails(product) {
  const item = product.itemMasters[0];
  return {
    estimatedDelivery: `${item.deliveryTime} days`,
    dimensions: `${item.dimensions.width}×${item.dimensions.depth}×${item.dimensions.height} cm`,
    weight: `${item.dimensions.weight} kg`,
    volume: `${item.m3} m³`
  };
}

Properties​

aliasCodes?​

optional aliasCodes: AliasCode[]

Alternative product codes for specific companies.

These company-specific codes allow for seamless integration with customer ordering systems that use different product numbering schemes.

code​

code: string

Stock keeping unit (SKU) or product/component code.

This code identifies a specific product, component, or material in inventory and order management systems. It corresponds to the same codes used in the MarketCostPrice system, ensuring alignment between pricing and inventory information.

deliveryTime?​

optional deliveryTime: number

Standard lead time for this product in days.

Indicates how long it typically takes from order placement until the product is ready for shipping or delivery.

dimensions​

dimensions: object

Physical measurements of the product.

These dimensions define the product's size and weight, which are essential for shipping calculations, warehouse space planning, and logistics.

depth?​

optional depth: number

Depth of the item in centimeters.

height?​

optional height: number

Height of the item in centimeters.

weight?​

optional weight: number

Weight of the item in kilograms.

width?​

optional width: number

Width of the item in centimeters.

history?​

optional history: History

Revision history information for this item.

itemMasterId​

itemMasterId: string

Unique identifier for this item master record.

This ID uniquely identifies this specific item record for reference and tracking purposes.

m3?​

optional m3: string | number

Volume of the item in cubic meters.

This measurement is useful for shipping and storage calculations, especially for freight pricing and container loading optimization.

marketCostPrices?​

optional marketCostPrices: PricingMarketCostPrice[]

Market and region-specific cost and pricing information.

These prices provide referential data for different markets and currencies, supporting international pricing strategies.

quantity?​

optional quantity: number

Order quantity for this item master record.

Can represent a default order quantity or minimum order quantity depending on the context.

weight?​

optional weight: number

Total weight of the item in kilograms.

This value may differ from dimensions.weight in cases where packaging weight is included or for multi-part products.