AMALYZE Falcon API

portfolios.custom (PUT)

Endpoint

Endpoint portfolios.custom creates a custom portfolio

Method

PUT portfolios.custom

Example call

curl https://falcon.amalyze.com/<VERSION>/portfolios.custom \
-X PUT \
-H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \
-d '
{
	"asins": [
		"B111111111",
		"B222222212"
	],
	"query": "brand.name:Sample Brand",
	"name": "My custom portfolio",
	"marketplace": "A1PA6795UKMFR9",
	"users": ["abcdefg"]
}
'

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

curl https://falcon.amalyze.com/<VERSION>/portfolios.custom \

-X PUT \

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

-d '

{

"asins": [

"B111111111",

"B222222212"

],

"query": "brand.name:Sample Brand",

"name": "My custom portfolio",

"marketplace": "A1PA6795UKMFR9",

"users": ["abcdefg"]

}

'

JSON Payload

Property	Type	Description	Further information	Version
`marketplace`	string	String containing the marketplace id	valid marketplaces ids	0.4.0
`asins`	array	Array containing the ASINs for the static portfolio.	You can provide either `asins` for a static portfolio or `query` for a dynamic one.	0.4.0
`query`	string	String containing the query for the dynamic portfolio	You can provide either `asins` for a static portfolio or `query` for a dynamic one.	0.4.0
`name`	string	A custom name for the portfolio		0.4.0
`users`	array	Array containing the users ID, which shall receive the portfolio report via email	If you want a specific user to receive the portfolio report via email, add it here	0.4.0

JSON Response

{
    "portfolio": {
        "id": "ef62b73ebb92abed671d989dcb41cb09",
        "name": "abc",
        "marketplace": "A1PA6795UKMFR9"
    },
    "request": {
        "id": "494ad17e-9e7d-4208-8e3d-aa64c2927a29",
        "took": 0.2312,
        "costs": 0,
        "remaining": 100000,
        "method": "portfolios.custom",
        "success": true,
        "error": {
            "code": null,
            "message": null,
            "hint": null
        },
        "cache": {
            "generated": 1560231887,
            "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

{

"portfolio": {

"id": "ef62b73ebb92abed671d989dcb41cb09",

"name": "abc",

"marketplace": "A1PA6795UKMFR9"

},

"request": {

"id": "494ad17e-9e7d-4208-8e3d-aa64c2927a29",

"took": 0.2312,

"costs": 0,

"remaining": 100000,

"method": "portfolios.custom",

"success": true,

"error": {

"code": null,

"message": null,

"hint": null

},

"cache": {

"generated": 1560231887,

"cached": false,

"id": null

}

Property	Type	Description	Version
`portfolio`	object	Object containing information about the created portfolio	0.4.0
`portfolio.id`	string	portfolios ID	0.4.0
`portfolio.name`	string	portfolios name	0.4.0
`portfolio.marketplace`	string	portfolios marketplace	0.4.0
`request`	object	The request information object (see Request information for more information)	0.4.0