Documentation Index
Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt
Use this file to discover all available pages before exploring further.
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
DRAFT, ACTIVE, ARCHIVED, and UNKNOWN status values
- Currency flexibility: Items can be priced in any supported currency
Attributes
Item Attributes
| Property | Type | Description |
|---|
| rootfi_id | integer | Unique identifier for this item |
| rootfi_created_at | string | When this item was created in Commenda’s system (ISO 8601) |
| rootfi_updated_at | string | When this item was last updated (ISO 8601) |
| rootfi_company_id | integer | Company identifier this item belongs to |
| platform_id | string | Platform-specific item identifier |
| name | string | Display name of the item |
| description | string | Detailed description |
| sku | string | Stock Keeping Unit code |
| price | number | Base price for this item |
| currency_id | string | ISO 4217 currency code |
| type | enum | Type of item |
| status | enum | Item availability status |
| created_at | string | Original creation timestamp (ISO 8601) |
| updated_at | string | Last update timestamp (ISO 8601) |
| variants | array | Product variants with different pricing/attributes |
Type Enum Values
| Value | Description |
|---|
INVENTORY | Physical product tracked in inventory |
NON_INVENTORY | Physical product not tracked |
SERVICE | Service offering |
DIGITAL | Digital product/download |
UNKNOWN | Type cannot be determined |
Status Enum Values
| Value | Description |
|---|
DRAFT | Item is in draft status and not yet published |
ACTIVE | Item is active and available |
ARCHIVED | Item is archived and no longer sold |
UNKNOWN | Status cannot be determined |
Variant Attributes
| Property | Type | Description |
|---|
| rootfi_id | integer | Unique identifier for this variant |
| platform_id | string | Platform-specific variant identifier |
| name | string | Variant name (e.g., “Large”, “Blue”) |
| sku | string | Variant-specific SKU |
| price | number | Variant price (if different from base) |
| attributes | object | Key-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"
}
}
]
}
