Skip to main content
GET
/
ecommerce
/
inventories
/
{id}
Get Inventory
curl --request GET \
  --url https://api.rootfi.dev/v4/ecommerce/inventories/{id} \
  --header 'api_key: <api-key>'
{
  "rootfi_id": 157,
  "rootfi_deleted_at": null,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "123456_1",
  "platform_unique_id": "123456",
  "product_id": "prod_789",
  "description": "Wireless Headphones Inventory",
  "sku": "WH-2024-BLK",
  "quantity": 50
}
Retrieve a specific inventory record by its ID. Inventory records track stock levels, reserved quantities, and warehouse locations for items.

​
Path Parameters

ParameterTypeRequiredDescription
idstringYesThe rootfi_id or platform_id of the inventory record to retrieve

Authorizations

​
api_key
string
header
required

Path Parameters

​
id
string
required

The rootfi_id or platform_id of the inventory record

Response

V4 Inventory object with comprehensive stock tracking

​
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

​
item_id
string | null

Reference to the Item being tracked

​
variant_id
string | null

Reference to the specific Variant being tracked

​
sku
string | null

Stock Keeping Unit for this inventory item

​
quantity
integer | null

Total physical quantity in stock

​
reserved_quantity
integer | null

Quantity allocated to pending orders but not yet shipped

​
available_quantity
integer | null

Quantity available for new orders (quantity - reserved_quantity)

​
status
enum<string> | null

Current inventory status

Available options:
in_stock,
low_stock,
out_of_stock,
discontinued,
unknown
​
is_trackable
boolean | null

Whether inventory levels are actively monitored for this item

​
reorder_level
integer | null

Quantity threshold that triggers reorder alerts

​
reorder_quantity
integer | null

Suggested quantity to reorder when stock is low

​
addresses
ecommerceV4AddressObject · object[] | null

Warehouse locations where this inventory is stored

​
created_at
string | null

When this inventory record was created

​
updated_at
string | null

When this inventory record was last updated