Get your Shopping Lists
getGet Shopping Lists
shopping_list:read scope to to authorize the API usage. For more information, see Authentication.{"list": [{"id": "string","name": "string","primary": true}],"items": [{"list": {"id": "string","name": "string","primary": true},"item_count": 0,"grouped_item_count": 0}]}
{"error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION","message": "Additional details about error are not static and can be changed"}
auth.tokenNotFound
, auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.{"code": "auth.tokenNotFound"}
This is unexpected response, something is wrong on our side, please contact: [email protected]
curl -X GET "https://api.whisk.com/list/v2"-H "Accept: application/json"-H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"
Whisk allows you to discover and understand its API capabilities on the Swagger interface with the ability to try out the API calls directly in your browser. You can call this endpoint here.
{"list": [{"id": "106e1fa4cbb7c844458be372c3e0f7bfa94","name": "My Secondary Shopping List"},{"id": "106f9105f1d05d24ad2b833f5d2a966be77","name": "My Shopping List","primary": true}],"items": [{"list": {"id": "106e1fa4cbb7c844458be372c3e0f7bfa94","name": "My Secondary Shopping List"},"item_count": 21,"grouped_item_count": 20},{"list": {"id": "106f9105f1d05d24ad2b833f5d2a966be77","name": "My Shopping List","primary": true},"item_count": 2,"grouped_item_count": 2}]}
As shown in this example, the information that gets retrieved is generally grouped into list and items arrays.
The list array includes identification details of all your shopping lists.
Attribute | Type | Description |
| string | The unique shopping list identifier. |
| string | The name of the shopping list. |
| boolean | Indicates if the list is primary. |
The items array includes the count of items in each shopping list.
Attribute | Type | Description |
| array | The list identification details as explained above. |
| number | The total number of items in the shopping list without combining similar items. |
| number | The total number of items in the shopping list after combining similar items. |
