Schema - Docs

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
`productStyle`	`String`	Style of the product
`productType`	`String`	Type of the product
`productStock`	`String`	Stock 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
`productVariants`	`Array`	Array of product variant objects

Variant

Schema

Field	Type	Description
`sizeId`	`String`	Size ID of the variant
`sizeLabel`	`String`	Size label of the variant
`colorId`	`String`	Color ID of the variant
`colorLabel`	`String`	Color label of the variant
`url`	`String`	URL of the variant
`img`	`String`	Image of the variant
`stock`	`String`	Stock of the variant
`qt`	`String`	QT URL of the variant

Introduction Overview

On this page

Site
Product
Variant