Ordexs API v1 Get an API key

Webhook event

inventory.updated

A variant's stock changesSubscribe with events

Sent when a variant's stock changes. data.object is the Variant as the API returns it. data.previous_attributes.inventory_quantity holds the old count.

data.object

The Variant exactly as retrieve a variant returns it, frozen when the change was saved.

  • idstringRequired

    starts with var_

  • objectstringRequired

    always "variant"

  • product_idstringRequired
  • titlestringRequired

    The option values joined, e.g. "Black / M". "Default" for a product without options.

  • optionsobjectRequired

    Option name → value.

  • skustring or null
  • barcodestring or null
  • priceMoneyRequired

    An amount of money. amount is a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.

    2 child fields
    • amountstringRequired
    • currencystringRequired
  • compare_at_priceMoney or null
    2 child fields
    • amountstringRequired
    • currencystringRequired
  • costMoney or null

    Only present when the key has the products:read_costs scope.

    2 child fields
    • amountstringRequired
    • currencystringRequired
  • inventory_quantityintegerRequired

    Units in stock. Negative when units are owed to pre-orders.

  • inventory_trackedboolean
  • incoming_quantityinteger

    Units on their way from a supplier.

  • incoming_due_atstring or null

    When the incoming delivery is expected.

    ISO 8601 date-time, UTC

  • allow_preorderboolean

    Orderable past zero

  • allow_backorderboolean

    Orderable past zero without limit; the merchant owes the units.

  • at_courierinteger

    Units kept at the courier's warehouse.

  • image_urlstring or null
  • livemodebooleanRequired
  • created_atstringRequired

    ISO 8601 date-time, UTC

  • updated_atstringRequired

    ISO 8601 date-time, UTC