---
title: "Get Recommendations"
method: GET
path: "/app/{app_id}/scenarios/{scenario_id}/recommendation"
---

# Get Recommendations

`GET /app/{app_id}/scenarios/{scenario_id}/recommendation`

## Request

- Base URL: `https://recommendation.jp.aiqua.io/api/v1.0`
- URL: `https://recommendation.jp.aiqua.io/api/v1.0/app/{app_id}/scenarios/{scenario_id}/recommendation`
- Auth: none required

Retrieve product recommendations from a recommendation scenario.

> 📘 Prerequisites
>
> Before you can retrieve product recommendations, complete the [Recommendation API prerequisites](ref:recommendation-getting-started#getting-started-with-the-recommendation-api).

## Path parameters

- `app_id` string, required
- `scenario_id` string, required

## Query parameters

- `user_id` string, required
- `num_items` integer
- `filter` string
- `category` string
- `product_id` string

## Response `200`

Success

- object
  - `items` object[]: The list of recommended products and their details.
    - `productId` string
    - `position` integer
    - `image` string
    - `title` string
    - `description` string
    - `customLabel00` string: Optional custom label field from your product data feed.
    - `customLabel01` string: Optional custom label field from your product data feed.
    - `customLabel02` string: Optional custom label field from your product data feed.
    - `customLabel03` string: Optional custom label field from your product data feed.
    - `customLabel04` string: Optional custom label field from your product data feed.
    - `url` string
    - `category` string
    - `currency` string
    - `price` string
    - `originalPrice` string
    - `order` string
  - `recId` string: Used to [track recommendation scenario analytics](ref:recommendation-getting-started#performance-and-analytics) on the AIQUA dashboard.
  - `scenarioId` string: Used to [track recommendation scenario analytics](ref:recommendation-getting-started#performance-and-analytics) on the AIQUA dashboard.
  - `modelId` string: Used to [track recommendation scenario analytics](ref:recommendation-getting-started#performance-and-analytics) on the AIQUA dashboard.
  - `expType` string
  - `respCode` string

## Other responses

- `400`: Bad Request. The scenario is still being prepared and can't serve results yet.
- `404`: Not Found. The `scenario_id` or `app_id` is invalid.

---

[API](https://skmtc.dev/appier/apis/get-recommendations.md) - [All operations](https://skmtc.dev/appier/apis/get-recommendations/llms.txt) - [OpenAPI document](https://skmtc.dev/appier/apis/get-recommendations/revisions/566641bb6b9c?raw)