# Search Suggestions List

Return Morrisons primary, refined, or follow-on search suggestions for a query.

- Platform: [Morrisons](https://docs.upscrape.com/docs/platforms/morrisons)
- Capability ID: `morrisons.search.suggestions.list`
- Cost: 1 credit per request
- Maximum runtime: 30 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "kind": "primary",
    "limit": 8,
    "query": "milk"
  },
  "capability": "morrisons.search.suggestions.list"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | `string` | No |  |
| `limit` | `integer` | No |  |
| `query` | `string` | Yes |  |

### Example input

```json
{
  "kind": "primary",
  "limit": 8,
  "query": "milk"
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "kind": "primary",
  "query": "milk",
  "suggestions": [
    "milk",
    "semi skimmed milk",
    "oat milk"
  ]
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `kind` | `string` | primary |
| `query` | `string` | milk |
| `suggestions` | `array` | 3 items |
| `suggestions` | `array` | 3 items |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)