Models

The Event object

Every field of the Event object, with types, required flags and validation rules.

The Event object

Envelope delivered to webhooks and returned by GET /events. Deliveries are at-least-once and unordered. Dedupe by id.

FieldTypeDescription
idstringe.g. evt_2c91d
objectstringalways event
typeEventTypeNew event types may be added; tolerate unknowns. One of: order.created, order.status_changed, product.updated, product.deleted, inventory.updated, listing.status_changed, operation.completed, channel_account.updated, channel_account.connected, channel_account.disconnected
api_versionstringe.g. 2026-07-24
store_idstring
account_idstringPartner keys: the company the event belongs to (absent for the partner's own store)
created_atstringISO 8601
dataobject
data.objectobjectThe full resource as it is when the event is delivered (or read from GET /events), not a copy frozen at the moment of the change; null once it no longer exists. Use data.previous_status / data.status and the other data fields for what the change was

Event types

The type field selects the variant; each one sets the shape of data.

typePayload
order.createddata.object: Order
order.status_changeddata.object: Order, data.status: OrderStatus, data.previous_status: OrderStatus
product.updateddata.merged: array of string, data.object: Product
product.deleteddata.merged_into: string, data.object: object
inventory.updateddata.object: Product, data.source: string, data.reason: string · nullable, data.channel: string · nullable, data.order_id_on_channel: string · nullable, data.variant_id: string · nullable, data.sku: string · nullable, data.quantity_change: integer · nullable
listing.status_changeddata.object: Listing, data.status: ListingStatus, data.previous_status: string · nullable
operation.completeddata.object: Operation
channel_account.updateddata.object: ChannelAccount, data.source: string, data.previous_attributes: object
channel_account.connecteddata.object: ChannelAccount, data.source: string, data.connection_id: string, data.channel_account_id: string, data.channel: string
channel_account.disconnecteddata.object: ChannelAccount, data.source: string, data.channel_account_id: string, data.channel: string

Last updated on October 18, 2026

Need help?

Email us and a human replies, usually within one business day.

On this page