Endpoint portfolios.custom updates custom portfolio
AMALYZE Falcon API
portfolios.custom (UPDT)
Endpoint
Method
UPDT portfolios.custom
Example call
Shell
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
curl https://falcon.amalyze.com/<VERSION>/portfolios.custom \ -X UPDT \ -H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \ -d ' { "portfolios": [ { "asins": ["B123456789", "B111111111"], "query": "brand.name:SPOOXX", "name": "abc", "status": "archived", "id": "abcderasfasdfasdfasf", "marketplace": "A1PA6795UKMFR9", "users": [] }, {...} ] } ' |
JSON Payload
JavaScript
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
{ "portfolios": [ { "asins": ["B123456789", "B111111111"], "query": "brand.name:SPOOXX", "name": "abc", "status": "archived", "id": "abcderasfasdfasdfasf", "marketplace": "A1PA6795UKMFR9", "users": [] }, {...} ] } |
| Property | Type | Description | Further information | Version |
portfolios | object | Array containing the portfolio objects | 0.5.0 | |
portfolio.marketplace | string | String containing the marketplace id | valid marketplaces ids | 0.4.0 |
portfolio.id | string | String containing the porfolios ID | 0.4.0 | |
portfolio.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 |
portfolio.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 |
portfolio.status | string | String containing the status to be set |
active | 0.4.0 |
portfolio.name | string | A custom name for the portfolio | 0.4.0 | |
portfolio.users | array | Array containing the users id, which shall receive the portfolio report via email | 0.4.0 |
JSON Response
JavaScript
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
{ "request": { "id": "eb84cbf0-9a57-4622-a470-a8aca915d0bd", "took": 0.5337, "costs": 0, "remaining": 100000, "method": "portfolios.custom", "success": true, "error": { "code": null, "message": null, "hint": null }, "cache": { "generated": 1560237316, "cached": false, "id": null } } } |
| Property | Type | Description | Version |
request | object | The request information object (see Request information for more information) | 0.4.0 |
Updates / Changes
| Version | Description |
| 0.5.0 | added portfolios to support multiple portfolio updates within one single request |
| 0.4.0 | created |