Skip to main content

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 Inventory Data Model tracks stock quantities, reserved amounts, and availability status for items in your e-commerce catalog.
PropertyTypeDescription
rootfi_idintegerUnique identifier for this inventory record
platform_idstringPlatform-specific inventory identifier
item_idstringReference to the related item
quantitynumberTotal quantity on hand
reserved_quantitynumberQuantity allocated to pending orders
available_quantitynumberQuantity available for new orders
statusenumIN_STOCK, LOW_STOCK, OUT_OF_STOCK, DISCONTINUED
updated_atstringLast update timestamp (ISO 8601)
Read inventory at GET /v4/core/companies/{company_id}/shared/inventory.