Skip to main content
Deprecation Notice: The Products endpoint is maintained for backward compatibility. New integrations should use the /v4/ecommerce/items endpoint which provides:
  • Embedded Variants with pricing and inventory details
  • Enhanced status tracking
  • Better alignment with e-commerce platform data models

​
Migration Guide

V3/Legacy EndpointV4 Recommended Endpoint
GET /ecommerce/productsGET /ecommerce/items
POST /ecommerce/productsPOST /ecommerce/items

​
Key Differences

The Items model includes:
  • Embedded Variants: Product variations (sizes, colors, etc.) are included directly in the response
  • Enhanced Status: Supports active, archived, draft, and unknown states
  • Variant Pricing: Each variant has its own price, compare_at_price, and currency

​
Products (Legacy)

The Products model provides:
  • Basic product information (name, description, SKU, status)
  • No embedded variants
  • Simple status tracking

​
Example Migration

Legacy Products Response: 
{
  "platform_id": "prod_789",
  "name": "Wireless Headphones",
  "status": "ACTIVE"
}
New Items Response: 
{
  "platform_id": "prod_789",
  "name": "Wireless Headphones",
  "status": "active",
  "variants": [
    {
      "platform_id": "var_001",
      "name": "Black - Medium",
      "sku": "WH-BLK-M",
      "price": 99.99,
      "currency_id": "USD",
      "status": "active"
    }
  ]
}

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the product
namestringName of the product
descriptionstringDescription of the product
skustringStock Keeping Unit
statusenumStatus of the product (ACTIVE, ARCHIVED)
created_atstringCreated timestamp
updated_atstringUpdated timestamp
{
  "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_123456",
  "name": "Wireless Headphones",
  "description": "Premium wireless headphones",
  "sku": "WH-2024",
  "status": "ACTIVE",
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.465Z"
}