Site
| Field | Type | Description |
|---|---|---|
platformName | String | Monitor platform identifier, such as amazon |
siteType | String | Site category, such as retail |
siteId | String | Stable site identifier, usually the domain |
siteName | String | Display name, such as AmazonUS |
siteUrl | String | Site URL |
siteCurrency | String | Currency used by the site and to select its notification market |
capabilities | SiteCapabilities | Workflows supported by this site |
queryType | String | Expected query type, such as productSku or productUrl |
altNames | Array<String> | Alternative site names |
notificationTypes | Array<String> | Notification types emitted by the site |
platformCategories | Array<String> | Packages or categories containing the site |
sellers | Array<String> | Seller identifiers supported by the site |
siteUrl and are not included as a siteImg response field.
SiteCapabilities
| Field | Type | Description |
|---|---|---|
lists | Boolean | Whether monitored lists are supported |
products | Boolean | Whether product lookup is supported |
releases | Boolean | Whether release monitoring is supported |
sellers | Boolean | Whether seller-specific monitoring is supported |
Product
| Field | Type | Description |
|---|---|---|
productSku | String | Product SKU or identifier |
productSite | String | Stable site identifier for the product |
productImg | String | Product image URL |
productName | String | Product name |
retailPrice | Number | Original or retail price |
currentPrice | Number | Current selling price |
productUrl | String | Product URL |
productDescription | String | Product description |
productStyle | String | Product style identifier |
productColor | String | Product color |
productType | String | Product type |
launchTime | String | Launch time supplied by the monitor |
lastRestocked | Int64 | Last-restocked timestamp |
lastDiscounted | Int64 | Last-discounted timestamp |
firstAdded | Int64 | First-added timestamp |
variants | Object<String, Variant> | Map of variant identifiers to variants |
offers | Object<String, Offer> | Map of seller identifiers to offers |
currentSeller | String | Seller associated with the current event |
stock | String | Product stock value or status |
instock | Boolean | Whether the product is in stock |
inHighStock | Boolean | Whether the product has high stock |
backorder | Boolean | Whether the product is backordered |
preorder | Boolean | Whether the product is available for preorder |
load | Boolean | Monitor-specific load state |
Variant
| Field | Type | Description |
|---|---|---|
id | String | Variant identifier |
sizeId | String | Size identifier |
sizeLabel | String | Display size |
colorId | String | Color identifier |
colorLabel | String | Display color |
width | String | Width label |
url | String | Variant or cart URL |
img | String | Variant image URL |
retailPrice | Number | Original or retail price |
currentPrice | Number | Current selling price |
upc | String | UPC or GTIN |
qt | String | Quick-task value or URL |
stock | String | Variant stock value or status |
instock | Boolean | Whether the variant is in stock |
inHighStock | Boolean | Whether the variant has high stock |
backorder | Boolean | Whether the variant is backordered |
preorder | Boolean | Whether the variant is available for preorder |
load | Boolean | Monitor-specific load state |
Offer
| Field | Type | Description |
|---|---|---|
sellerId | String | Seller identifier |
offerId | String | Offer identifier |
retailPrice | Number | Original or retail price |
currentPrice | Number | Current selling price |
stock | String | Offer stock value or status |
ItemConfig
| Field | Type | Description |
|---|---|---|
maxPrice | Number | null | Maximum price for an in-stock alert |
mutedVariants | Object<String, Boolean> | Map of variant identifiers to mute status |
ItemResponse
| Field | Type | Description |
|---|---|---|
error | Boolean | Whether the operation failed for this item |
status | String | Detailed result status |
product | Product | Product associated with the result |
config | ItemConfig | Monitoring configuration, when applicable |
ItemsRequest
| Field | Type | Description |
|---|---|---|
items | Array<Item> | Items to process |
itemId string and an optional config object.
{
"items": [
{
"itemId": "B09DFHJTF5",
"config": {
"maxPrice": 500,
"mutedVariants": {}
}
}
]
}
ConfigUpdateRequest
| Field | Type | Description |
|---|---|---|
maxPrice | Number | New maximum price for stock alerts |
Error response
| Field | Type | Description |
|---|---|---|
status | Integer | HTTP status code |
message | String | Error message |