Types

Site Object

The site object contains the following fields:

Field	Type	Description
platformName	string	Name of the platform (e.g. amazon)
siteName	string	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

Instore Object

The instore object contains the following fields:

Field	Type	Description
storeId	string	ID of the store
storeName	string	Name of the store
storeAddress	string	Address of the store
storeStock	string	Total stock for the product at the store

Antibot Object

The antibot object contains the following fields:

Field	Type	Description
name	string	Name of the antibot
url	string	URL of the antibot
type	string	Type of the antibot
status	string	Status of the antibot

Product Object

The product object contains the following fields:

Field	Type	Description	Optional
productSku	string	SKU of the product	No
productImg	string	Image of the product	No
productName	string	Name of the product	No
productPrice	string	Price of the product	No
productUrl	string	URL of the product	No
productSite	string	Site of the product	No
productStyle	string	Style of the product	Yes
productColor	string	Color of the product	Yes
productType	string	Type of the product	Yes
productDescription	string	Description of the product	Yes
productStock	string	Stock of the product	Yes
offerId	string	Offer ID of the product	Yes
lastRestocked	int64	Last restocked timestamp of the product	Yes
firstAdded	int64	First added timestamp of the product	Yes
productVariants	array of variant objects	Product variants	Yes

Variant Object

The variant object contains the following fields:

Field	Type	Description	Optional
sizeId	string	Size ID of the variant	No
sizeLabel	string	Size label of the variant	No
colorId	string	Color ID of the variant	Yes
colorLabel	string	Color label of the variant	Yes
url	string	URL of the variant	Yes
img	string	Image of the variant	Yes
stock	string	Stock of the variant	Yes
qt	string	QT URL of the variant	Yes