# Reference

## Parameters

| ATTRIBUTE        | TYPE                                | DESCRIPTION                                                                                                                                                                                                                                                                                                                                                                              |
| ---------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| items            | array \[ListsTransferItemPayload]   | List of normalized items to add.                                                                                                                                                                                                                                                                                                                                                         |
| rawItems         | array \[string]                     | List of raw items to add.                                                                                                                                                                                                                                                                                                                                                                |
| recipes          | array \[ListsTransferRecipePayload] | List of recipes to add.                                                                                                                                                                                                                                                                                                                                                                  |
| allowedRetailers | array \[string]                     | List of available retailers in the shopping list app. If not set, all available retailers are shown. Each retailer should be prefixed with the country code to control which retailer will be available in which country. For example, `GB:AmazonFresh`, `US:Walmart`. To see the list of all retailers that we support, read [Integrated Retailers](/resources/supported-retailers.md). |
| language         | string                              | This affects interface language and analysis on item text. Possible values: `en`, `de`, `fr`.                                                                                                                                                                                                                                                                                            |
| country          | string                              | Set default country. This will affect which stores are available. If not set, the country will be automatically detected.                                                                                                                                                                                                                                                                |
| zipcode          | string                              | Set default zip code. This will show stores available in this area. For de and us this should be 5 digits, e.g. 10001.                                                                                                                                                                                                                                                                   |
| utm\_campaign    | string                              | Identifies a specific product promotion or strategic campaign.                                                                                                                                                                                                                                                                                                                           |
| utm\_source      | string                              | Identifies which site sent the traffic, and is a required parameter.                                                                                                                                                                                                                                                                                                                     |
| utm\_medium      | string                              | Identifies what type of link was used, such as cost per click or email.                                                                                                                                                                                                                                                                                                                  |
| utm\_content     | string                              | Identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link.                                                                                                                                                                                                                                                                              |
| utm\_term        | string                              | Identifies search terms.                                                                                                                                                                                                                                                                                                                                                                 |

### ListsTransferItemPayload

| ATTRIBUTE | TYPE   | DESCRIPTION                           |
| --------- | ------ | ------------------------------------- |
| name\*    | string | Item name (e.g. potato)               |
| quantity  | double | Item quantity                         |
| unit      | string | Item unit (e.g. gram, ml)             |
| comment   | string | Additional information (e.g. organic) |

### ListsTransferRecipePayload

| ATTRIBUTE | TYPE   | DESCRIPTION                                                                                                 |
| --------- | ------ | ----------------------------------------------------------------------------------------------------------- |
| id\*      | string | GraphId or URL of a Recipe                                                                                  |
| scale     | number | Multiply the quantities of all ingredients within recipe. Accepts integers (e.g. 2) or decimals (e.g. 0.5). |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.whisk.com/shopping-list-mobile-api/reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.