AMALYZE Falcon API

notifications.products.settings (POST)

Endpoint

Endpoint notifications.products.settings returns all settings made for product notifications

Endpoint

POST notifications.products.settings

Example call

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

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

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

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

-X POST \

-d '

{

"filters":{

"marketplaces":[

"A1PA6795UKMFR9"

],

"asins": [

"B07JQ9DSB6"

]

},

"pagination": {

"page": 1,

"size": 20

},

"sorting":[

{

"direction":"desc",

"column":"asin"

}

]

}'

JSON Payload

{
	"filters":{
		"marketplaces":[	
			"A1PA6795UKMFR9"
		],
		"asins": [
			"B07JQ9DSB6"
		]
	},
	"pagination": {
		"page": 1,
		"size": 20
	},
	"sorting":[
		{
			"direction":"desc",
			"column":"asin"
		}
	]
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

{

"filters":{

"marketplaces":[

"A1PA6795UKMFR9"

],

"asins": [

"B07JQ9DSB6"

]

},

"pagination": {

"page": 1,

"size": 20

},

"sorting":[

{

"direction":"desc",

"column":"asin"

}

]

}

Property	Type	Description	Further information
`filters`	object	Object containing the filter information
`filters.marketplaces`	array	Array containing the marketplace ids	valid marketplaces ids
`filters.asins`	array	Array containing the ASINs	optional
`sorting`	array	Array containing the sorting information
`sorting.column`	string	The column to sort	`asin`
`sorting.direction`	string	The direction to sort	valid direction values
`pagination`	object	Object containing the pagination information	pagination object definition

JSON Response

{
    "items": [
        {
            "asin": "B07JQ9DSB6",
            "marketplace": {
                "id": "A1PA6795UKMFR9",
                "name": "amazon.de"
            },
            "types": {
                "content.category": "none",
                "content.image": "none",
                "content.title": "none",
                "content.parent": "none",
                "content.bulletpoints": "none",
                "buybox.price": "none",
                "buybox.merchant": "none",
                "buybox.unitPrice": "none",
                "offers.merchants": "none",
                "reviews.reviews": "entity",
                "reviews.rating": "entity",
                "keywords.keywords": "none",
                "keywords.position": "none",
                "badge.bestseller": "none"
            }
        }
    ],
    "filtered": 1,
    "request": {
        "id": "830091b3-6278-4c1b-b948-86f25bd45879",
        "took": 0.1139,
        "costs": 0,
        "remaining": 100000,
        "method": "notifications.products.settings",
        "success": true,
        "error": {
            "code": null,
            "message": null,
            "hint": null
        },
        "cache": {
            "generated": 1563274271,
            "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

{

"items": [

{

"asin": "B07JQ9DSB6",

"marketplace": {

"id": "A1PA6795UKMFR9",

"name": "amazon.de"

},

"types": {

"content.category": "none",

"content.image": "none",

"content.title": "none",

"content.parent": "none",

"content.bulletpoints": "none",

"buybox.price": "none",

"buybox.merchant": "none",

"buybox.unitPrice": "none",

"offers.merchants": "none",

"reviews.reviews": "entity",

"reviews.rating": "entity",

"keywords.keywords": "none",

"keywords.position": "none",

"badge.bestseller": "none"

}

],

"filtered": 1,

"request": {

"id": "830091b3-6278-4c1b-b948-86f25bd45879",

"took": 0.1139,

"costs": 0,

"remaining": 100000,

"method": "notifications.products.settings",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

},

"cache": {

"generated": 1563274271,

"cached": false,

"id": null

}

Property	Type	Description
`items`	array	Array containing the summary items
`items.asin`	string	String containing the ASIN the notification refers to
`items.marketplace`	object	Object, containing the marketplace the notifications refers to
`items.types`	obect	Object, containing the types of notifications
`items.content.category`	string	Change of category: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.content.image`	string	Change of main image: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.content.title`	string	Change of title: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.content.bulletpoints`	string	Change of bulletpoints: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.content.parent`	string	Change of parent: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.buybox.unitPrice`	string	Change of buybox unitPrice: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.buybox.price`	string	Change of buybox price: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.buybox.merchant`	string	Change of buybox merchant: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.offers.merchants`	string	Change of number of merchants: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.reviews.reviews`	string	Change of number of reviews: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.reviews.rating`	string	Change of rating: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.keywords.keywords`	string	Change of number of keywords: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.keywords.position`	string	Change of number of average keyword position: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`items.badge.bestseller`	string	Change of bestseller badge: `none`: notifications are not set for this type of notification `entity`: notifications are set for this type of notification, but for a different user under same account `user`notifications are set for the actual user and this type of notification
`request`	object	The request information object (see request information object definition for more information)