AMALYZE Falcon API

notifications.products (POST)

Endpoint

Endpoint notifications.products returns the individual user notifications for product changes

Endpoint

POST notifications.products

Example call

curl https://falcon.amalyze.com/<VERSION>/notifications.products \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-X POST \
-d '
{
	"pagination": {
		"page": 1,
		"size": 10
	},
	"filters": {
		"marketplaces": [
			"A1RKKUPIHCS9HS",
			"A1PA6795UKMFR9"
		],
		"asin": "B123456789",
		"parent": "B112233445",
		"change": [
			"down",
			"up"
		],
		"types": [
			"content.title"
		],
		"read": [
			false,
			true
		],
		"brand": "Sample brand",
		"start": "2019-01-01",
		"end": "2019-02-28"
	},
	"sorting": [
		{
			"column": "asin",
			"direction": "asc"
		}
	]
}'

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

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

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

-X POST \

-d '

{

"pagination": {

"page": 1,

"size": 10

},

"filters": {

"marketplaces": [

"A1RKKUPIHCS9HS",

"A1PA6795UKMFR9"

],

"asin": "B123456789",

"parent": "B112233445",

"change": [

"down",

"up"

],

"types": [

"content.title"

],

"read": [

false,

true

],

"brand": "Sample brand",

"start": "2019-01-01",

"end": "2019-02-28"

},

"sorting": [

{

"column": "asin",

"direction": "asc"

}

]

}'

JSON Payload

{
	"pagination": {
		"page": 1,
		"size": 10
	},
	"filters": {
		"marketplaces": [
			"A1RKKUPIHCS9HS",
			"A1PA6795UKMFR9"
		],
		"asin": "B123456789",
		"parent": "B112233445",
		"change": [
			"down",
			"up"
		],
		"types": [
			"content.title"
		],
		"read": [
			false,
			true
		],
		"brand": "Sample brand",
		"start": "2019-01-01",
		"end": "2019-02-28"
	},
	"sorting": [
		{
			"column": "asin",
			"direction": "asc"
		}
	]
}

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

{

"pagination": {

"page": 1,

"size": 10

},

"filters": {

"marketplaces": [

"A1RKKUPIHCS9HS",

"A1PA6795UKMFR9"

],

"asin": "B123456789",

"parent": "B112233445",

"change": [

"down",

"up"

],

"types": [

"content.title"

],

"read": [

false,

true

],

"brand": "Sample brand",

"start": "2019-01-01",

"end": "2019-02-28"

},

"sorting": [

{

"column": "asin",

"direction": "asc"

}

]

}

Property	Type	Description	Further information
`filters`	object	Object containing the filter information
`filters.start`	date	String containing the start date	YYYY-MM-DD
`filters.end`	date	String containing the end date	YYYY-MM-DD
`filters.marketplaces`	array	Array containing the marketplace ids	valid marketplaces ids
`filters.asin`	string	String containing the ASINs	optional
`filters.parent`	string	String containing the parent’s ASIN	optional
`filters.change`	array	Array containing the direction of change	optional `up`: increased value `down`: decreased value
`filters.type`	array	Array containing the type of change	optional `content.category` `content.title` `content.bulletpoints` `content.parent` `buybox.merchant` `buybox.price` `buybox.unitPrice` `reviews.reviews` `reviews.rating`
`filters.brand`	string	String containing the brand to search for	optional
`sorting`	array	Array containing the sorting information
`sorting.column`	string	The column to sort	`asin` `parent` `brand` `read` `type` `timestamp`
`sorting.direction`	string	The direction to sort	valid direction values
`pagination`	object	Object containing the pagination information	pagination object definition

JSON Response

{
    "items": [
        {
            "id": "QKqnKmkBmCTDDpjWeN4u",
            "timestamp": "2019-02-26T16:15:40+00:00",
            "read": false,
            "asin": "B123456789",
            "parent": "B112233445",
            "brand": "Sample brand",
            "type": "content.title",
            "change": "up",
            "marketplace": {
                "id": "A1PA6795UKMFR9",
                "name": "amazon.de"
            },
            "new": "new sample title",
            "old": "old sample title"
        },
        {...},
        {
            "id": "fNe8KmkBmCTDDpjWdQK0",
            "timestamp": "2019-02-26T16:18:01+00:00",
            "read": false,
            "asin": "B123459780",
            "parent": null,
            "brand": "2nd sample brand",
            "type": "buybox.price",
            "change": "down",
            "marketplace": {
                "id": "A1PA6795UKMFR9",
                "name": "amazon.de"
            },
            "new": null,
            "old": 5.99
        }
    ],
    "pagination": {
        "filtered": 26,
    },
    "request": {
        "id": "54455599-4355-4906-b941-99f48d14ac38",
        "took": 0.2936,
        "costs": 0,
        "remaining": 100000,
        "method": "notifications.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

{

"items": [

{

"id": "QKqnKmkBmCTDDpjWeN4u",

"timestamp": "2019-02-26T16:15:40+00:00",

"read": false,

"asin": "B123456789",

"parent": "B112233445",

"brand": "Sample brand",

"type": "content.title",

"change": "up",

"marketplace": {

"id": "A1PA6795UKMFR9",

"name": "amazon.de"

},

"new": "new sample title",

"old": "old sample title"

},

{...},

{

"id": "fNe8KmkBmCTDDpjWdQK0",

"timestamp": "2019-02-26T16:18:01+00:00",

"read": false,

"asin": "B123459780",

"parent": null,

"brand": "2nd sample brand",

"type": "buybox.price",

"change": "down",

"marketplace": {

"id": "A1PA6795UKMFR9",

"name": "amazon.de"

},

"new": null,

"old": 5.99

}

],

"pagination": {

"filtered": 26,

},

"request": {

"id": "54455599-4355-4906-b941-99f48d14ac38",

"took": 0.2936,

"costs": 0,

"remaining": 100000,

"method": "notifications.products",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

},

"cache": {

"cached": false,

"id": null

}

Property	Type	Description
`items`	array	Array containing the summary items
`items.id`	string	String containing the notifications unique id (used to mark notification as read see notifications.products (UPDT))
`items.timestamp`	dateTime	String containing the timestamp, when the notification occured
`items.read`	boolean	Boolean, indicating, if the notification has been marked as read
`items.asin`	string	String containing the ASIN the notification refers to
`items.parent`	string	String containing the parents ASIN (if existing) the notification refers to
`items.brand`	string	String containing the brands name of the ASIN
`items.type`	string	String containing the type of notification
`items.change`	string	String containing the value of change
`items.marketplace`	object	Object, containing the marketplace the notifications refers to
`items.new`	string	String containing the new value
`items.old`	string	String containing the old value
`request`	object	The request information object (see request information object definition for more information)

Updates / Changes

Version	Description
0.6.0	added `content.parent` as possible option to filters.type
	added `buybox.unitPrice` as possible option to filters.type
0.2.4	created