AMALYZE Falcon API

inventory.products (POST)

Endpoint

Endpoint inventory.products returns the general information (title, bulletpoints, price, etc.) for a ASIN / keyword combination based on the sellers / vendors inventory.

Method

POST inventory.products

Example call

curl https://falcon.amalyze.com/<VERSION>/inventory.products \
-X POST \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"filters": {
		"marketplaces": [
			"A1PA6795UKMFR9"
		],
		"asins": ["B0123456789"] 
	},
	"sorting": [
		{"column": "price", "direction": "asc"}
	],
	"aggregation": "asin",
	"pagination": {
		"size": 1,
		"page": 1
	}
}
'

curl https://falcon.amalyze.com/<VERSION>/inventory.products \

-X POST \

-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \

-d '

{

"filters": {

"marketplaces": [

"A1PA6795UKMFR9"

"asins": ["B0123456789"]

"sorting": [

{"column": "price", "direction": "asc"}

"aggregation": "asin",

"pagination": {

"size": 1,

"page": 1

}

JSON Payload

{
	"filters": {
		"marketplaces": [
			"A1PA6795UKMFR9"
		],
		"asins": ["B012345678"] 
	},
	"sorting": [
		{"column": "amazon.price", "direction": "asc"}
	],
	"aggregation": "asin",
	"pagination": {
		"size": 1,
		"page": 1
	}
}

{

"filters": {

"marketplaces": [

"A1PA6795UKMFR9"

"asins": ["B012345678"]

"sorting": [

{"column": "amazon.price", "direction": "asc"}

"aggregation": "asin",

"pagination": {

"size": 1,

"page": 1

}

Property	Type	Description	Further information	Version
`pagination`	object	Object containing the pagination information	pagination object definition	0.2.4
`filters`	object	Object containing the filter information		0.2.4
`filters.marketplaces`	array	Array containing all the marketplaces to search in	valid marketplaces ids	0.2.4
`filters.asins`	array	Array containing the ASINs to search for	optional	0.2.4
`filters.parents`	array	Array containing the parent ASINs to search for	optonal	0.2.4
`filters.upcs`	array	Array containing the UPCs to search for	optional	0.2.4
`filters.skus`	array	Array containing the SKUs to search for	optional	0.2.4
`filters.title`	string	The title to search for	optional	0.2.4
`filters.brands`	array	Array containing the brands to search for (full text search)	optional	0.2.4
`filters.brandsExact`	array	Array containing the exact brand names to search for	optional	0.2.4
`filters.merchants`	array	Array containing the merchant names to search for (full textsearch)	optional	0.2.4
`.filters.merchantsExact`	array	Array containing the merchant names to search for (exact match)	optional	0.2.4
`filters.merchantsId`	array	Array containing the merchant ids to search for	optional	0.2.4
`filters.fulfillments`	array	Array containing the fulfillment types to search for	optional. value values `FBA` `FBM`	0.2.4
`filters.stocksFullfillable`	object	Object containing the fulfillable stock	optional	0.2.4
`filters.stocksFullfillable.min`	integer	Number of minimum stock	optional	0.2.4
`filters.stocksFullfillable.max`	integer	Number of maximum stock	optional	0.2.4
`filters.mainCategory`	string	String containing the main categorys ID	optional	0.2.4
`filters.mainCategoryRank`	object	Object holding information about main categorys best seller rank	optional	0.2.4
`filters.mainCategoryRank.min`	integer	Number of minimum best seller rank for main category	optional	0.2.4
`filters.mainCategoryRank.max`	integer	Number of maximum best seller rank for main category	optional	0.2.4
`filters.subCategory`	string	String containing the sub categorys ID	optional	0.2.4
`filters.subCategoryRank`	object	Object holding information about sub categorys best seller rank	optional	0.2.4
`filters.subCategoryRank.min`	integer	Number of minimum best seller rank for sub category	optional	0.2.4
`filters.subCategoryRank.max`	integer	Number of maximum best seller rank for sub category	optional	0.2.4
`filters.price`	object	Object containing information about the products price	optional	0.2.4
`filters.price.min`	float	Minimum price the products must have	optional	0.2.4
`filters.price.max`	float	Maximum price the products must have	optional	0.2.4
`filters.keywordsOrganicPos`	object	Object containing the information about the average position of organic keywords	optional	0.2.4
`filters.keywordsOrganicPos.min`	integer	Minimum average position of organic keywords	optional	0.2.4
`filters.keywordsOrganicPos.max`	integer	Maximum average position of organic keywords	optional	0.2.4
`filters.keywordsOrganicCount`	object	Object containing the information about the number of organic keywords	optional	0.2.4
`filters.keywordsOrganicCount.min`	integer	Minimum number of organic keywords	optional	0.2.4
`filters.keywordsOrganicCount.max`	integer	Maximum number of organic keywords	optional	0.2.4
`filters.reviews`	object	Object containing the information about reviews	optional	0.2.4
`filters.reviews.min`	integer	Minimum number of reviews	optional	0.2.4
`filters.reviews.max`	integer	Maximum number of reviews	optional	0.2.4
`filters.rating`	object	Object contaning the information about products rating	optional	0.2.4
`filters.rating.min`	integer	Minimum rating	optional	0.2.4
`filters.rating.max`	integer	Maximum rating	optional	0.2.4
`aggregation`	string	String containing the aggregation	`asin` `sku`	0.2.4
`sorting`	array	Array containing the sorting information		0.2.4
`sorting.column`	string	The column to sort	`score` `amazon.asin` `amazon.parent` `amazon.upc` `amazon.sku` `amazon.title` `amazon.brand.name` `amazon.buybox.owned.sku` `amazon.buybox.owned.merchant` `amalyze.keywords.organic.count` `amalyze.keywords.organic.pos` `amalyze.amascore.score` `amazon.category.bsr` `amazon.category.name` `amazon.rating.score` `amazon.reviews.total` `amazon.buybox.prices.offer.amount` `amazon.price` `amazon.fulfillment` `amazon.plus` `amazon.merchant.id` `amazon.merchant.name`	0.2.4
`sorting.direction`	string	The direction to sort	valid direction values	0.2.4

JSON Response

{
    "items": [
        {<product>}
    ],
    "pagination": {
        {"filtered": 123}
    },
    "request": {
        "id": "708f6b29-0c41-4cd1-ba9a-4346a66fedf9",
        "took": 0.0571,
        "costs": 1,
        "remaining": 99999,
        "method": "inventory.products",
        "success": true,
        "error": {
            "code": null,
            "message": null,
            "hint": null
        }
    }
}

{

"items": [

{<product>}

"pagination": {

{"filtered": 123}

"request": {

"id": "708f6b29-0c41-4cd1-ba9a-4346a66fedf9",

"took": 0.0571,

"costs": 1,

"remaining": 99999,

"method": "inventory.products",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

}

Property	Type	Description
`items`	array	Array containing the product items (for more information see product object definition
`pagination`	object	The pagination object (see Pagination for more information)
`request`	object	The request information object (see Request information for more information)