1. Inventory management

Tracking inventory changes

This guide explains how to track inventory changes across products, variants, and inventory records.

Use cases

  • Alert purchasing managers when warehouse inventory is low
  • Notify customers when out-of-stock products become available
  • Identify products with low inventory for clearance

Key highlights

  • Send inventory changes to configured Delivery Target(s)
    • One InventoryIntegration per marketplace
  • Control notifications with LimitNotifications property
    • When true, events trigger only for specific quantity changes:
      • Quantity becomes zero or negative
      • Quantity increases from zero/negative to positive
      • Quantity reaches or falls below NotificationPoint
      • Quantity increases above NotificationPoint from below it
  • Payload includes QuantityAvailable and PreviousQuantity
    • Helps distinguish between restocking and purchase events

New properties

Variant.Inventory.NotificationPoint and InventoryRecord.NotificationPoint

These properties support NotificationPointOnly events for variants and inventory records, complementing existing product-level inventory notifications.

New resource: InventoryIntegration

json
{
  "DeliveryConfigID": "",
  "LimitNotifications": true
}

InventoryChangedPayload

json
{
  "ProductID": "",
  "VariantID": "",
  "InventoryRecordID": "",
  "QuantityAvailable": 0,
  "PreviousQuantity": 0,
  "NotificationPoint": 0
}

Note: ProductID is always included as it's required for accessing variants and inventory records.

New endpoints

  • GET v1/integrations/inventory
  • PUT v1/integrations/inventory
  • DELETE v1/integrations/inventory
  • PATCH v1/integrations/inventory

If you have suggestions for improving this article, let us know!