AMALYZE Falcon API

inventory.products (SUM)

Endpoint

Endpoint inventory.products returns summarized information about the sellers / vendors inventory.

Method
SUM inventory.products
Example call

JSON Payload

PropertyTypeDescriptionFurther informationVersion
filtersobjectObject containing the filter information0.2.4
filters.marketplacesarrayArray containing all the marketplaces to search invalid marketplaces ids0.2.4
filters.asinsarrayArray containing the ASINs to search foroptional0.2.4
filters.parentsarrayArray containing the parent ASINs to search foroptonal0.2.4
filters.upcsarrayArray containing the UPCs to search foroptional0.2.4
filters.skusarrayArray containing the SKUs to search foroptional0.2.4
filters.titlestringThe title to search foroptional0.2.4
filters.brandsarrayArray containing the brands to search for (full text search)optional0.2.4
filters.brandsExactarrayArray containing the exact brand names to search foroptional0.2.4
filters.merchantsarrayArray containing the merchant names to search for (full textsearch)optional0.2.4
.filters.merchantsExactarrayArray containing the merchant names to search for (exact match)optional0.2.4
filters.merchantsIdarrayArray containing the merchant ids to search foroptional0.2.4
filters.fulfillmentsarrayArray containing the fulfillment types to search foroptional. value values
  • FBA
  • FBM
0.2.4
filters.stockFullfillableobjectObject containing the fulfillable stockoptional0.2.4
filters.stockFullfillable.minintegerNumber of minimum stockoptional0.2.4
filters.stockFullfillable.minintegerNumber of maximum stockoptional0.2.4
filters.mainCategorystringString containing the main categorys IDoptional0.2.4
filters.mainCategoryRankobjectObject holding information about main categorys best seller rankoptional0.2.4
filters.mainCategoryRank.minintegerNumber of minimum best seller rank for main categoryoptional0.2.4
filters.mainCategoryRank.maxintegerNumber of maximum best seller rank for main categoryoptional0.2.4
filters.subCategorystringString containing the sub categorys IDoptional0.2.4
filters.subCategoryRankobjectObject holding information about sub categorys best seller rankoptional0.2.4
filters.subCategoryRank.minintegerNumber of minimum best seller rank for sub categoryoptional0.2.4
filters.subCategoryRank.maxintegerNumber of maximum best seller rank for sub categoryoptional0.2.4
filters.priceobjectObject containing information about the products priceoptional0.2.4
filters.price.minfloatMinimum price the products must haveoptional0.2.4
filters.price.maxfloatMaximum price the products must haveoptional0.2.4
filters.keywordsOrganicPosobjectObject containing the information about the average position of organic keywordsoptional0.2.4
filters.keywordsOrganicPos.minintegerMinimum average position of organic keywordsoptional0.2.4
filters.keywordsOrganicPos.maxintegerMaximum average position of organic keywordsoptional0.2.4
filters.keywordsOrganicCountobjectObject containing the information about the number of organic keywordsoptional0.2.4
filters.keywordsOrganicCount.minintegerMinimum number of organic keywordsoptional0.2.4
filters.keywordsOrganicCount.maxintegerMaximum number of organic keywordsoptional0.2.4
filters.reviewsobjectObject containing the information about reviewsoptional0.2.4
filters.reviews.minintegerMinimum number of reviewsoptional0.2.4
filters.reviews.maxintegerMaximum number of reviewsoptional0.2.4
filters.ratingobjectObject contaning the information about products ratingoptional0.2.4
filters.rating.minintegerMinimum ratingoptional0.2.4
filters.rating.maxintegerMaximum ratingoptional0.2.4
JSON Response

PropertyTypeDescription
itemsarrayArray containing the summarized items
items.marketpaceobjectObject containing the marketplace information
items.marketpace.idstringString containing the marketplace ID
items.marketpace.namestringString containing the marketplace name
items.asinsobjectObject containing information about the summarized ASINs
items.asins.totalintegerThe total number of ASINs in sellers / vendors inventory
items.asins.outOfStockobjectObject containing information about the out-of-stock ASINs
items.asins.outOfStock.totalintegerThe number of ASINs without stock
items.asins.outOfStock.ratefloatThe rate of out-of-stock ASINs
items.asins.inStockobjectObject containing information about the in-stock ASINs
items.asins.inStock.totalintegerThe number of in-stock ASINs in sellers / vendors inventory
items.asins.inStock.ratefloatThe rate of in-stock ASINs
items.asins.inStock.buyboxobjectObject containing information about the buybox state of the in-stock ASINs
items.asins.inStock.buybox.lostintegerNumber of ASINs where seller does not own the buybox
items.asins.inStock.buybox.wonintegerNumber of ASINs where seller does own the buybox
items.asins.inStock.buybox.ratefloatRate of sellers buybox-ownership based on the in-stock ASINs in his inventory
items.asins.inStock.visibilityobjectObject containing information about the visibility regarding the in-stock ASINs
items.asins.inStock.visibility.visibleintegerNumber of ASINs which do rank to at least one single keyword
items.asins.inStock.visibility.invisibleintegerNumber of ASINs which are not ranking to at least one single keyword
items.asins.inStock.visibility.ratefloatRate of ASINs which doe rank to at least one single keyword
items.skusobjectObject containing information about the summarized SKUs
items.skus.totalintegerThe total number of SKUs in sellers / vendors inventory
items.skus.outOfStockobjectObject containing information about the out-of-stock SKUs
items.skus.outOfStock.totalintegerThe number of SKUs without stock
items.skus.outOfStock.ratefloatThe rate of out-of-stock SKUs
items.skus.inStockobjectObject containing information about the in-stock SKUs
items.skus.inStock.ratefloatThe rate of in-stock SKUs
items.skus.inStock.totalintegerThe number of in-stock SKUs in sellers / vendors inventory
paginationobjectThe pagination object (see Pagination for more information)
requestobjectThe request information object (see Request information for more information)
Updates / Changes
VersionDescription
0.2.4created
Menü