> For the complete documentation index, see [llms.txt](https://easyparser.gitbook.io/easyparser-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://easyparser.gitbook.io/easyparser-documentation/real-time-integration/similar-products/response.md).

# Response

## API Response Structure Overview

The JSON response is organized into 4 primary sections:

1. `request_info`: The status of the request, including success flags, HTTP status code, error details and credit usage.
2. `request_parameters`: An echo of the parameters sent in the request, including the `asin` and `similar_limit` values.
3. `request_metadata`: Timestamps and the total processing time of the request.
4. `result`: The core payload, holding the requested product and its `similar` array of related products.

## 1 - Top-Level Meta Fields (Outside of `result`)

These fields provide essential information about the transaction status, parameters, and processing timing.

### `request_info` (object)

Contains the status of the API call and credit usage details.

| Field                      | Type              | Description                                                                                                    |
| -------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------- |
| `id`                       | String            | A unique identifier for this specific request.                                                                 |
| `success`                  | Boolean           | Indicates whether the request was completed successfully.                                                      |
| `status_code`              | Number            | Standard HTTP status code (e.g., `200` for success, `404` if the ASIN does not exist in the requested domain). |
| `error_details`            | Array             | An array of error messages if the request failed. Empty `[]` on success.                                       |
| `credits_used`             | Number            | The total cumulative credits used by your account to date.                                                     |
| `credit_used_this_request` | Number            | The specific cost deducted for this call (Base Cost + any extra based on `similar_limit`).                     |
| `credits_remaining`        | Number            | Your current remaining credit balance.                                                                         |
| `credits_reset_at`         | String (ISO Date) | The date and time when your monthly credit limit will reset.                                                   |

{% code overflow="wrap" expandable="true" %}

```json
"request_info": {
    "id": "33de1673-d1a3-4c6b-bf5d-84d4c06ec24b",
    "success": true,
    "status_code": 200,
    "error_details": [],
    "credits_used": 15323,
    "credit_used_this_request": 1,
    "credits_remaining": 1999984677,
    "credits_reset_at": "2026-10-17T07:17:40.000Z"
}
```

{% endcode %}

### `request_parameters` (object)

Echoes back the parameters sent in the request to confirm what was processed.

| Field           | Type    | Description                                                                   |
| --------------- | ------- | ----------------------------------------------------------------------------- |
| `type`          | String  | The operation type executed (`SIMILAR_PRODUCTS`).                             |
| `asin`          | String  | The ASIN of the product that similar products were requested for.             |
| `similar_limit` | String  | The maximum number of similar products requested (`"10"`, `"50"` or `"100"`). |
| `output`        | String  | The response format (default: `"json"`).                                      |
| `language`      | String  | The localization language used for the request (e.g., `"en_US"`).             |
| `include_html`  | Boolean | Indicates if raw HTML was requested (default: `false`).                       |

{% code overflow="wrap" expandable="true" %}

```json
"request_parameters": {
    "output": "json",
    "language": "en_US",
    "include_html": false,
    "asin": "B0G2V8898X",
    "similar_limit": "10",
    "type": "SIMILAR_PRODUCTS"
}
```

{% endcode %}

### `request_metadata` (object)

Contains timing information about the request lifecycle, from the moment it was received until processing was completed. These fields are useful for monitoring response times and logging.

| Field              | Type              | Description                                                             |
| ------------------ | ----------------- | ----------------------------------------------------------------------- |
| `created_at`       | String (ISO Date) | The timestamp when the request was received by the system.              |
| `processed_at`     | String (ISO Date) | The timestamp when the processing was completed.                        |
| `total_time_taken` | Number            | The total duration (in seconds) the system took to process the request. |

{% code overflow="wrap" expandable="true" %}

```json
"request_metadata": {
    "created_at": "2026-10-14T11:16:02.020Z",
    "processed_at": "2026-10-14T11:16:02.258Z",
    "total_time_taken": 0.238
}
```

{% endcode %}

## 2 - Core Response Payload – `result` Section

The core payload contains the requested product and the list of products Amazon associates with it. The API response is divided into the following groups within the `result` object:

1. `product`: Basic information about the requested ASIN.
2. `product.image`: The main image of the requested product.
3. `product.similar`: The array of similar products, up to the `similar_limit` value.

### A- Product Information (`result.product`)

Contains the basic identity of the requested ASIN: its brand, category path, title and main image. The `similar` array is also nested inside this object, so the source product and its similar products are always returned together.

| Field      | Type   | Description                                                                                                           |
| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------- |
| `asin`     | String | The ASIN of the requested product.                                                                                    |
| `brand`    | String | The brand name of the requested product.                                                                              |
| `category` | String | The full category path of the product, with levels separated by `/`.                                                  |
| `title`    | String | The product title as shown on Amazon.                                                                                 |
| `image`    | Object | The main image of the product. See `result.product.image` below.                                                      |
| `similar`  | Array  | The list of similar products. See `result.product.similar` below. Can be empty `[]` if no similar products are found. |

{% code overflow="wrap" expandable="true" %}

```json
"product": {
    "asin": "B0G2V8898X",
    "brand": "Spedal",
    "category": "Car & Vehicle Electronics/Vehicle Electronics Accessories/Audio & Video Accessories",
    "image": {
        "id": "41J-WgccuxL",
        "link": "https://m.media-amazon.com/images/I/41J-WgccuxL.jpg",
        "variant": "MAIN"
    },
    "similar": [ ... ],
    "title": "Spedal 2026 2-in-1 Wireless CarPlay & Android Auto Adapter"
}
```

{% endcode %}

#### **Product Image (`result.product.image`)**

The main image of the requested product. The same structure is used for the `image` object of every item in the `similar` array.

{% code overflow="wrap" expandable="true" %}

```json
"image": {
    "id": "41J-WgccuxL",
    "link": "https://m.media-amazon.com/images/I/41J-WgccuxL.jpg",
    "variant": "MAIN"
}
```

{% endcode %}

### B- Similar Products (`result.product.similar`)

The `similar` array sits inside `result.product`, next to the requested product's own fields. Each element represents one product related to the requested ASIN. The array contains at most as many elements as the `similar_limit` value (default `10`); it may contain fewer, or be empty `[]` when no similar products are found.

| Field           | Type   | Description                                                                  |
| --------------- | ------ | ---------------------------------------------------------------------------- |
| `asin`          | String | The ASIN of the similar product.                                             |
| `brand`         | String | The brand name of the similar product.                                       |
| `category`      | String | The full category path of the similar product, with levels separated by `/`. |
| `title`         | String | The title of the similar product.                                            |
| `image.id`      | String | The Amazon image identifier of the similar product.                          |
| `image.link`    | String | The direct URL of the similar product's image.                               |
| `image.variant` | String | The image variant (e.g., `"MAIN"`).                                          |

{% code overflow="wrap" expandable="true" %}

```json
{
    "asin": "B0G64V3PVR",
    "brand": "OTTOCAST",
    "category": "Car & Vehicle Electronics/Vehicle Electronics Accessories/Audio & Video Accessories",
    "image": {
        "id": "31WBjLekrEL",
        "link": "https://m.media-amazon.com/images/I/31WBjLekrEL.jpg",
        "variant": "MAIN"
    },
    "title": "OTTOCAST Mini Edge 2-in-1 Wireless CarPlay & Android Auto Adapter 2026"
},
{
    "asin": "B0HCCY69WS",
    "brand": "LAMTTO",
    "category": "Car & Vehicle Electronics/Vehicle Electronics Accessories/Audio & Video Accessories",
    "image": {
        "id": "41FoFyc2ctL",
        "link": "https://m.media-amazon.com/images/I/41FoFyc2ctL.jpg",
        "variant": "MAIN"
    },
    "title": "LAMTTO Wireless CarPlay and Android Auto Adapter with Gemini AI YouTube"
}
```

{% endcode %}

## Sample Output <a href="#sample-output" id="sample-output"></a>

{% code overflow="wrap" expandable="true" %}

```json
{
    "request_info": {
        "id": "f4b33568-4ac0-4762-be68-6c0224f6f291",
        "success": true,
        "status_code": 200,
        "error_details": [],
        "credits_used": 15330,
        "credit_used_this_request": 1,
        "credits_remaining": 1999984670,
        "credits_reset_at": "2026-10-17T07:17:40.000Z"
    },
    "request_parameters": {
        "output": "json",
        "language": "en_US",
        "include_html": false,
        "asin": "B0G2V8898X",
        "similar_limit": "10",
        "type": "SIMILAR_PRODUCTS"
    },
    "request_metadata": {
        "created_at": "2026-10-14T12:46:59.991Z",
        "processed_at": "2026-10-14T12:47:00.419Z",
        "total_time_taken": 0.428
    },
    "result": {
        "product": {
            "asin": "B0G2V8898X",
            "brand": "Spedal",
            "category": "Car & Vehicle Electronics/Vehicle Electronics Accessories/Audio & Video Accessories",
            "image": {
                "id": "41J-WgccuxL",
                "link": "https://m.media-amazon.com/images/I/41J-WgccuxL.jpg",
                "variant": "MAIN"
            },
            "similar": [
                {
                    "asin": "B0G64V3PVR",
                    "brand": "OTTOCAST",
                    "category": "Car & Vehicle Electronics/Vehicle Electronics Accessories/Audio & Video Accessories",
                    "image": {
                        "id": "31WBjLekrEL",
                        "link": "https://m.media-amazon.com/images/I/31WBjLekrEL.jpg",
                        "variant": "MAIN"
                    },
                    "title": "OTTOCAST Mini Edge 2-in-1 Wireless CarPlay & Android Auto Adapter 2026"
                },
                {
                    "asin": "B0HCCY69WS",
                    "brand": "LAMTTO",
                    "category": "Car & Vehicle Electronics/Vehicle Electronics Accessories/Audio & Video Accessories",
                    "image": {
                        "id": "41FoFyc2ctL",
                        "link": "https://m.media-amazon.com/images/I/41FoFyc2ctL.jpg",
                        "variant": "MAIN"
                    },
                    "title": "LAMTTO Wireless CarPlay and Android Auto Adapter with Gemini AI YouTube"
                },
                //...
            ],
         
        }
    }
}
```

{% endcode %}
