Event Types
The following stock-related events are available:variant_stock.updated- Triggered when variant stock quantity is updatedvariant_stock.deleted- Triggered when variant stock is removedvariant_stock_delta.updated- Triggered when a stock quantity change (delta) occurs
Variant Stock Updated Event
Thevariant_stock.updated event is triggered when a variant’s stock quantity is updated.
Event Structure
Field Descriptions
| Field | Type | Description |
|---|---|---|
inventory_id | string | Unique identifier for the inventory record |
product_parent_id | string | ID of the parent product |
product_variant_id | string | ID of the variant |
product_variant_number | string | Variant number |
quantity | number | Current stock quantity |
inventory_date | string | Timestamp of the inventory update |
update_source | string | Source of the update (manual, system, etc.) |
available_online | boolean | Whether the stock is available for online purchase |
stock_updated | boolean | Whether was updated in the request or not |
Variant Stock Deleted Event
Thevariant_stock.deleted event is triggered when a variant’s stock record is removed.
Event Structure
Field Descriptions
| Field | Type | Description |
|---|---|---|
inventory_id | string | ID of the deleted inventory record |
product_parent_id | string | ID of the parent product |
product_variant_id | string | ID of the variant |
product_variant_number | string | Variant number |
Variant Stock Delta Updated Event
Thevariant_stock_delta.updated event is triggered when there’s a change in stock quantity (increment or decrement).
Event Structure
Field Descriptions
| Field | Type | Description |
|---|---|---|
inventory_id | string | ID of the inventory record |
product_variant_number | string | Variant number |
quantity | number | New total stock |
delta | number | Change in quantity (positive for increase, negative for decrease) |
available_online | boolean | Whether the stock is available for online purchase |