Skip to main content
The Item Data Model represents products and services available for sale in your e-commerce platform. This replaces the previous Product model and introduces embedded Variants for a more comprehensive product representation.
  • Unified item properties: The model provides essential product details including name, description, SKU, and status across different e-commerce platforms.
  • Embedded variants: In V4, product variants (sizes, colors, configurations) are embedded directly within the Item object, eliminating the need for a separate Product model.
  • Expandable relationships: Use the expand parameter to include full Variant objects with pricing and inventory details.

​
Attributes

FieldTypeDescriptionRequiredExpandable
rootfi_idintegerUnique identifier assigned by Commenda for this itemYesNo
rootfi_created_atdatetimeTimestamp when this record was created in Commenda’s systemYesNo
rootfi_updated_atdatetimeTimestamp when this record was last updated in Commenda’s systemYesNo
rootfi_company_idintegerIdentifier of the company this item belongs toYesNo
platform_idstringUnique identifier for this item in the source platformYesNo
namestringDisplay name of the product (e.g., “Wireless Headphones”)YesNo
descriptionstringDetailed description of the product, including features and specificationsNoNo
skustringStock Keeping Unit - unique identifier for inventory trackingNoNo
typeenumType of itemNoNo
statusenumCurrent availability status of the itemYesNo
created_atdatetimeOriginal creation timestamp from the source platformYesNo
updated_atdatetimeLast modification timestamp from the source platformYesNo
variantsarrayCollection of product variants with different attributes (size, color, etc.)NoYes

​
Status Enum Values

ValueDescription
draftItem is in draft status and not yet published
activeItem is active and available for sale
archivedItem has been archived and is no longer actively sold
unknownStatus cannot be determined

​
Type Enum Values

ValueDescription
inventoryPhysical product tracked in inventory
non_inventoryPhysical product not tracked
serviceService offering
digitalDigital product/download
unknownType cannot be determined

​
Expandable Attributes

  • expand=variants - Includes full Variant objects with pricing and inventory details

​
Variant Object

Each variant in the variants array contains:
FieldTypeDescriptionRequired
rootfi_idintegerUnique identifier for this variantYes
platform_idstringPlatform-specific identifier for this variantYes
namestringDisplay name describing this variant (e.g., “Black - Medium”)Yes
skustringUnique SKU for this specific variantNo
pricedecimalCurrent selling price for this variantYes
compare_at_pricedecimalOriginal or suggested retail price for comparison (used to show discounts)No
currency_idstringISO 4217 currency code (e.g., “USD”, “EUR”, “GBP”)Yes
statusenumAvailability status of this specific variant (active, archived, unknown)Yes

​
Migration from V3

In V3, products and their variations were handled separately. V4 consolidates this by:
  • Renaming Products to Items
  • Embedding Variants directly within the Item object
  • Providing a more complete product representation in a single API call
V3 Endpoint: GET /v3/ecommerce/products V4 Endpoint: GET /v4/ecommerce/items 
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "prod_789",
  "name": "Wireless Headphones",
  "description": "Premium wireless headphones with noise cancellation",
  "sku": "WH-2024-BLK",
  "status": "active",
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.465Z",
  "variants": [
    {
      "rootfi_id": 3101,
      "platform_id": "var_shopify_001",
      "name": "Black - Small",
      "sku": "WH-2024-BLK-S",
      "price": 89.99,
      "compare_at_price": 119.99,
      "currency_id": "USD",
      "status": "active"
    },
    {
      "rootfi_id": 3102,
      "platform_id": "var_shopify_002",
      "name": "Black - Medium",
      "sku": "WH-2024-BLK-M",
      "price": 99.99,
      "compare_at_price": 129.99,
      "currency_id": "USD",
      "status": "active"
    },
    {
      "rootfi_id": 3103,
      "platform_id": "var_shopify_003",
      "name": "White - Medium",
      "sku": "WH-2024-WHT-M",
      "price": 99.99,
      "compare_at_price": 129.99,
      "currency_id": "USD",
      "status": "active"
    }
  ]
}