API Reference

Types

Site Object

The site object contains the following fields:

FieldTypeDescription
platformNamestringThe name of the platform (e.g. amazon)
siteNamestringThe name of the site (e.g. AmazonUS)
siteUrlstringThe URL of the site
siteCurrencystringThe currency used on the site
siteImgstringAn image URL for the site
hasListsbooleanWhether or not the site supports lists
hasProductsbooleanWhether or not the site supports products
hasReleasesbooleanWhether or not the site has scrapers
hasForceAddbooleanWhether or not the site supports force adding
queryTypestringThe type of query used for the site (productSku or productUrl)
restockTypesarrayAn array of restock types supported by the site
altNamesarrayAn array of alternative names for the site

Product Object

The product object contains the following fields:

FieldTypeDescription
productSkustringSKU of the product
productImgstringImage of the product
productNamestringName of the product
productPricestringPrice of the product
productUrlstringURL of the product
productSitestringSite of the product
productStylestringStyle of the product
productTypestringType of the product
productStockstringStock of the product
offerIdstringOffer ID of the product
lastRestockedint64Last restocked timestamp of the product
firstAddedint64First added timestamp of the product
productVariantsarray of variant objectsProduct variants

Variant Object

The variant object contains the following fields:

FieldTypeDescription
sizeIdstringSize ID of the variant
sizeLabelstringSize label of the variant
colorIdstringColor ID of the variant
colorLabelstringColor label of the variant
urlstringURL of the variant
imgstringImage of the variant
stockstringStock of the variant
qtstringQT URL of the variant