Event catalog

Every event type, when it fires, and what's in data.object.

EventFires whendata.object
order.createdA new order is ingested from any channel (poller or channel webhook)Order
order.status_changedAn order's normalized status changes (e.g. paidshipped)Order
product.updatedA product's content changes — from the dashboard, the API, or a channel-side edit synced inProduct
product.deletedA product is deleted{ "id": … }
inventory.updatedA variant's quantity changes — from a sale on any channel, a channel-side edit, the dashboard, or the APIProduct (with updated variants[])
listing.status_changedA per-channel listing changes status (ongoinglisted, → error, → delisted)Product (see listings[])
operation.completedAn asynchronous operation finishes (succeeded, partial or failed) — subscribe to this instead of polling /operationsOperation

New event types are added over time — consumers must tolerate unknown type values (log and ack them).

Which events do I need?

  • Order sync into your systemorder.created + order.status_changed.
  • Stock sync back to your systeminventory.updated (fires for sales on any channel — this is how you keep an external warehouse in sync).
  • "Is my product live?"listing.status_changed (or operation.completed after a publish).
  • Fire-and-forget writesoperation.completed to get the per-channel outcome without polling.

Need help?

The API is in private beta — email us and a human replies, usually within one business day.

On this page