Schema - Docs

On this page

Site
Product
ItemConfig
ItemResponse
ItemsRequest
ConfigUpdateRequest
Error Response

Site

Schema

Field	Type	Description
`platformName`	`String`	The name of the platform (e.g., amazon)
`siteName`	`String`	The name of the site (e.g., AmazonUS)
`siteUrl`	`String`	The URL of the site
`siteCurrency`	`String`	The currency used on the site
`siteImg`	`String`	An image URL for the site
`hasLists`	`Boolean`	Whether or not the site supports lists
`hasProducts`	`Boolean`	Whether or not the site supports products
`hasReleases`	`Boolean`	Whether or not the site has scrapers
`hasForceAdd`	`Boolean`	Whether or not the site supports force adding
`queryType`	`String`	The type of query used for the site (productSku or productUrl)
`restockTypes`	`Array`	An array of restock types supported by the site
`altNames`	`Array`	An array of alternative names for the site

Product

Schema

Field	Type	Description
`productSku`	`String`	SKU of the product
`productImg`	`String`	Image of the product
`productName`	`String`	Name of the product
`productPrice`	`String`	Price of the product
`productUrl`	`String`	URL of the product
`productSite`	`String`	Site of the product
`offerId`	`String`	Offer ID of the product
`lastRestocked`	`Int 64`	Last restocked timestamp of the product
`firstAdded`	`Int 64`	First added timestamp of the product

ItemConfig

Schema

Field	Type	Description
`stockAlertMaxPrice`	`Float`	Maximum price threshold for stock alerts (nullable)
`priceAlertMaxPrice`	`Float`	Maximum price threshold for price alerts (nullable)
`monitorPrice`	`Boolean`	Whether to monitor price changes
`mutedVariants`	`Object`	Object mapping variant IDs to mute status

ItemResponse

Schema

Field	Type	Description
`error`	`Boolean`	Indicates if an error occurred
`status`	`String`	Detailed status indicating error/success
`product`	`Product`	Product object with detailed information
`config`	`ItemConfig`	Item configuration settings

ItemsRequest

Schema

ConfigUpdateRequest

Schema

Error Response

Schema

Introduction Overview