Schema - Docs

Message

Every message is a JSON object with the following fields:

Field	Type	Presence	Description
`site`	`Site`	Always	Site that emitted the notification
`notificationType`	`String`	Always	Notification type
`product`	`Product`	Product events	Product data
`isHyped`	`Boolean`	Always	Whether the product is considered hyped
`isFiltered`	`Boolean`	Always	Whether the event came from a filtered stream
`instore`	`Instore`	In-store events	Store availability data
`antibot`	`Antibot`	Queue, checkpoint, and similar events	Antibot state

product, instore, and antibot are event-specific and are omitted when they do not apply.

Site

WebSocket messages use the shared Site schema. In particular, the current fields include siteId, siteType, siteCurrency, capabilities, and notificationTypes; there is no siteImg or restockTypes field.

Product

WebSocket messages use the shared flat Product schema. Prices are numeric retailPrice and currentPrice fields. Product availability is represented by fields such as stock and instock. Variants are returned in the variants object, keyed by variant identifier, and follow the Variant schema. Seller offers are returned in the offers object and follow the Offer schema.

Instore

Field	Type	Description
`storeId`	`String`	Store identifier
`storeName`	`String`	Store name
`storeAddress`	`String`	Store address
`storeStock`	`String`	Total product stock at the store

Antibot

Field	Type	Description
`name`	`String`	Antibot name
`url`	`String`	Relevant URL
`type`	`String`	Antibot type
`status`	`String`	Current status

​Message

​Site

​Product

​Instore

​Antibot

Message

Site

Product

Instore

Antibot