Skip to main content
PUT
/
ecommerce
/
items
/
{id}
Update Item
curl --request PUT \
  --url https://api.rootfi.dev/v4/ecommerce/items/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "data": [
    {
      "name": "<string>",
      "description": "<string>",
      "sku": "<string>",
      "status": "active",
      "created_at": "<string>",
      "updated_at": "<string>",
      "variants": [
        {
          "rootfi_id": 123,
          "platform_id": "<string>",
          "name": "<string>",
          "sku": "<string>",
          "price": 123,
          "compare_at_price": 123,
          "currency_id": "<string>",
          "status": "active"
        }
      ]
    }
  ]
}
'
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.465Z",
  "rootfi_company_id": 1089,
  "platform_id": "prod_789",
  "name": "Wireless Headphones - Updated",
  "description": "Premium wireless headphones",
  "sku": "WH-2024-BLK",
  "status": "active"
}
Update an existing item (product with variants) in the e-commerce platform. Only provided fields will be updated.

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe rootfi_id or platform_id of the item to update

Request Body

FieldTypeRequiredDescription
namestringNoProduct name
descriptionstringNoProduct description
skustringNoStock keeping unit (SKU)
pricenumberNoBase price of the item
currency_idstringNoISO 4217 currency code
statusstringNoItem status (active, inactive, archived)
variantsarrayNoArray of variant objects
See Item Overview for complete field details.

Authorizations

api_key
string
header
required

Path Parameters

id
string
required

The rootfi_id or platform_id of the item

Body

application/json
data
ecommerceItemsFields · object[]
required

The data of the items endpoint

Response

Item updated successfully

V4 Item object (replaces Product) with embedded Variants

rootfi_id
number<double>
required

The unique ID we assign for that data's information

Example:

157

rootfi_created_at
string<date-time>
required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

rootfi_updated_at
string<date-time>
required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

rootfi_company_id
number<double>
required

The ID of the company in the accounting platform

Example:

1089

platform_id
string
required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

rootfi_deleted_at
string<date-time> | null

The date at which the data was deleted in the accounting platform

platform_unique_id
string | null

The ID of the data in the accounting platform.

raw_data
object

A JSON containing fields that you can directly get from the accounting platform.

data_hash
string | null

The hash of the data

name
string | null

Display name of the product (e.g., "Wireless Headphones")

description
string | null

Detailed description of the product, including features and specifications

sku
string | null

Stock Keeping Unit - unique identifier for inventory tracking

status
enum<string> | null

Current availability status of the item

Available options:
active,
archived,
draft,
unknown
created_at
string | null

Original creation timestamp from the source platform (ISO 8601)

updated_at
string | null

Last modification timestamp from the source platform (ISO 8601)

variants
ecommerceVariantObject · object[] | null

Collection of product variants with different attributes (size, color, etc.)