AMALYZE Falcon API

inventory.products (SUM)

Endpoint

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

Method

SUM 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"] 
	}
}
'

1

2

3

4

5

6

7

8

9

10

11

12

13

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

-X POST \

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

-d '

{

"filters": {

"marketplaces": [

"A1PA6795UKMFR9"

],

"asins": ["B0123456789"]

}

'

JSON Payload

Property	Type	Description	Further information	Version
`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.stockFullfillable`	object	Object containing the fulfillable stock	optional	0.2.4
`filters.stockFullfillable.min`	integer	Number of minimum stock	optional	0.2.4
`filters.stockFullfillable.min`	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

JSON Response

{
    "items": [
        {
            "marketplace": {
                "id": "A1PA6795UKMFR9",
                "name": "amazon.de"
            },
            "asins": {
                "total": 652,
                "outOfStock": {
                    "total": 95,
                    "rate": 0.14570552147239
                },
                "inStock": {
                    "total": 557,
                    "rate": 0.85429447852761,
                    "buybox": {
                        "lost": 0,
                        "won": 557,
                        "rate": 1
                    },
                    "visibility": {
                        "visible": 554,
                        "invisible": 3,
                        "rate": 0.99461400359066
                    }
                }
            },
            "skus": {
                "total": 1305,
                "outOfStock": {
                    "total": 247,
                    "rate": 0.18927203065134
                },
                "inStock": {
                    "total": 1058,
                    "rate": 0.81072796934866
                }
            }
        },
        {
            "marketplace": {
                "id": "A1RKKUPIHCS9HS",
                "name": "amazon.es"
            },
            "asins": {
                "total": 627,
                "outOfStock": {
                    "total": 82,
                    "rate": 0.13078149920255
                },
                "inStock": {
                    "total": 545,
                    "rate": 0.86921850079745,
                    "buybox": {
                        "lost": 1,
                        "won": 544,
                        "rate": 0.99816513761468
                    },
                    "visibility": {
                        "visible": 512,
                        "invisible": 33,
                        "rate": 0.9394495412844
                    }
                }
            },
            "skus": {
                "total": 1166,
                "outOfStock": {
                    "total": 202,
                    "rate": 0.17324185248714
                },
                "inStock": {
                    "total": 964,
                    "rate": 0.82675814751286
                }
            }
        }
    ],
    "request": {
        "id": "481cccda-4a63-432b-986b-4d0dda230712",
        "took": 0.4415,
        "costs": 0,
        "remaining": 100000,
        "method": "inventory.products",
        "success": true,
        "error": {
            "code": null,
            "message": null,
            "hint": null
        },
        "cache": {
            "cached": false,
            "id": null
        }
    }
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

{

"items": [

{

"marketplace": {

"id": "A1PA6795UKMFR9",

"name": "amazon.de"

},

"asins": {

"total": 652,

"outOfStock": {

"total": 95,

"rate": 0.14570552147239

},

"inStock": {

"total": 557,

"rate": 0.85429447852761,

"buybox": {

"lost": 0,

"won": 557,

"rate": 1

},

"visibility": {

"visible": 554,

"invisible": 3,

"rate": 0.99461400359066

}

},

"skus": {

"total": 1305,

"outOfStock": {

"total": 247,

"rate": 0.18927203065134

},

"inStock": {

"total": 1058,

"rate": 0.81072796934866

}

},

{

"marketplace": {

"id": "A1RKKUPIHCS9HS",

"name": "amazon.es"

},

"asins": {

"total": 627,

"outOfStock": {

"total": 82,

"rate": 0.13078149920255

},

"inStock": {

"total": 545,

"rate": 0.86921850079745,

"buybox": {

"lost": 1,

"won": 544,

"rate": 0.99816513761468

},

"visibility": {

"visible": 512,

"invisible": 33,

"rate": 0.9394495412844

}

},

"skus": {

"total": 1166,

"outOfStock": {

"total": 202,

"rate": 0.17324185248714

},

"inStock": {

"total": 964,

"rate": 0.82675814751286

}

],

"request": {

"id": "481cccda-4a63-432b-986b-4d0dda230712",

"took": 0.4415,

"costs": 0,

"remaining": 100000,

"method": "inventory.products",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

},

"cache": {

"cached": false,

"id": null

}

Property	Type	Description
`items`	array	Array containing the summarized items
`items.marketpace`	object	Object containing the marketplace information
`items.marketpace.id`	string	String containing the marketplace ID
`items.marketpace.name`	string	String containing the marketplace name
`items.asins`	object	Object containing information about the summarized ASINs
`items.asins.total`	integer	The total number of ASINs in sellers / vendors inventory
`items.asins.outOfStock`	object	Object containing information about the out-of-stock ASINs
`items.asins.outOfStock.total`	integer	The number of ASINs without stock
`items.asins.outOfStock.rate`	float	The rate of out-of-stock ASINs
`items.asins.inStock`	object	Object containing information about the in-stock ASINs
`items.asins.inStock.total`	integer	The number of in-stock ASINs in sellers / vendors inventory
`items.asins.inStock.rate`	float	The rate of in-stock ASINs
`items.asins.inStock.buybox`	object	Object containing information about the buybox state of the in-stock ASINs
`items.asins.inStock.buybox.lost`	integer	Number of ASINs where seller does not own the buybox
`items.asins.inStock.buybox.won`	integer	Number of ASINs where seller does own the buybox
`items.asins.inStock.buybox.rate`	float	Rate of sellers buybox-ownership based on the in-stock ASINs in his inventory
`items.asins.inStock.visibility`	object	Object containing information about the visibility regarding the in-stock ASINs
`items.asins.inStock.visibility.visible`	integer	Number of ASINs which do rank to at least one single keyword
`items.asins.inStock.visibility.invisible`	integer	Number of ASINs which are not ranking to at least one single keyword
`items.asins.inStock.visibility.rate`	float	Rate of ASINs which doe rank to at least one single keyword
`items.skus`	object	Object containing information about the summarized SKUs
`items.skus.total`	integer	The total number of SKUs in sellers / vendors inventory
`items.skus.outOfStock`	object	Object containing information about the out-of-stock SKUs
`items.skus.outOfStock.total`	integer	The number of SKUs without stock
`items.skus.outOfStock.rate`	float	The rate of out-of-stock SKUs
`items.skus.inStock`	object	Object containing information about the in-stock SKUs
`items.skus.inStock.rate`	float	The rate of in-stock SKUs
`items.skus.inStock.total`	integer	The number of in-stock SKUs in sellers / vendors inventory
`pagination`	object	The pagination object (see Pagination for more information)
`request`	object	The request information object (see Request information for more information)