Skip to main content
The Item Data Model represents a product or service that can be sold. Items can have variants representing different configurations (e.g., sizes, colors) with their own pricing.
In V4, the separate Products model has been consolidated into Items. Items now support variants for more flexible product configurations.
  • Product catalog: Manage products and services in a unified catalog
  • Variant support: Create product variations with different attributes and pricing
  • Status management: Track item availability with active/archived status
  • Currency flexibility: Items can be priced in any supported currency

​
Attributes

​
Item Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier for this item
rootfi_created_atstringWhen this item was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringWhen this item was last updated (ISO 8601)
rootfi_company_idintegerCompany identifier this item belongs to
platform_idstringPlatform-specific item identifier
namestringDisplay name of the item
descriptionstringDetailed description
skustringStock Keeping Unit code
pricenumberBase price for this item
currency_idstringISO 4217 currency code
typeenumType of item
statusenumItem availability status
created_atstringOriginal creation timestamp (ISO 8601)
updated_atstringLast update timestamp (ISO 8601)
variantsarrayProduct variants with different pricing/attributes

​
Type Enum Values

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

​
Status Enum Values

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

​
Variant Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier for this variant
platform_idstringPlatform-specific variant identifier
namestringVariant name (e.g., “Large”, “Blue”)
skustringVariant-specific SKU
pricenumberVariant price (if different from base)
attributesobjectKey-value pairs describing variant attributes

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=variants - Includes all Variant objects
{
  "rootfi_id": 4001,
  "rootfi_created_at": "2025-01-01T00:00:00Z",
  "rootfi_updated_at": "2025-01-15T10:00:00Z",
  "rootfi_company_id": 999,
  "platform_id": "prod_stripe_001",
  "name": "Premium Plan",
  "description": "Full access to all premium features",
  "sku": "PREM-001",
  "price": 99.99,
  "currency_id": "USD",
  "status": "active",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z",
  "variants": [
    {
      "rootfi_id": 4101,
      "platform_id": "var_stripe_001",
      "name": "Monthly",
      "sku": "PREM-001-MO",
      "price": 99.99,
      "attributes": {
        "billing_period": "month"
      }
    },
    {
      "rootfi_id": 4102,
      "platform_id": "var_stripe_002",
      "name": "Annual",
      "sku": "PREM-001-YR",
      "price": 999.99,
      "attributes": {
        "billing_period": "year"
      }
    }
  ]
}