# Response

## 🌳API Response Structure Overview

Root
\
├── <mark style="color:blue;">request\_info</mark> # Meta info about the request
\
├── <mark style="color:blue;">request\_parameters</mark> # Parameters used in the request
\
├── <mark style="color:blue;">request\_metadata</mark> # Timing and pagination details
\
├── <mark style="color:blue;">result</mark> # Main response content
\
│ ├── <mark style="color:yellow;">product</mark> # Product-level summary info
\
│ └── <mark style="color:yellow;">offer</mark> # Offer-related data
\
│         ├── <mark style="color:red;">offer\_results\[]</mark> # Array of offers from sellers
\
│      │ ├── offer\_id
\
│      │ ├── is\_prime
\
│      │ ├── price
\
│      │ ├── delivery
\
│      │ ├── seller
\
│      │ └── ...
\
│      └── <mark style="color:red;">available\_filters</mark> # Booleans indicating availability of filter types

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

These fields are located at the same level as `result` in the Offer API response. They contain **metadata about the API request**, including resource consumption, request parameters, and performance metrics.

### `request_info` (object)

Contains technical details about the request status, credits used.

| Field                      | Type         | Parent                  | Description                                            |
| -------------------------- | ------------ | ----------------------- | ------------------------------------------------------ |
| `id`                       | string       | request\_info           | Unique identifier for the API request.                 |
| `success`                  | boolean      | request\_info           | Indicates whether the request was successful.          |
| `status_code`              | number       | request\_info           | HTTP-style status code (200 = success).                |
| `error_details`            | array        | request\_info           | Array of any errors encountered (empty if successful). |
| `credits_used`             | number       | request\_info           | Total credits used by the requester up to this point.  |
| `credit_used_this_request` | number       | request\_info           | Credits used for this specific request.                |
| `credits_remaining`        | number       | request\_info           | How many credits the user still has.                   |
| `credits_reset_at`         | string       | request\_info           | Timestamp for when the credit usage will reset.        |
| `address.city`             | string\|null | request\_info > address | Inferred city from the IP (may be null).               |
| `address.zipCode[]`        | array        | request\_info > address | Zip code(s) inferred from IP.                          |

### &#x20;`request_parameters` (object)

Echoes the parameters that were passed in the original API call.

| Field          | Type    | Parent              | Description                                        |
| -------------- | ------- | ------------------- | -------------------------------------------------- |
| `output`       | string  | request\_parameters | Desired output format (e.g., "json").              |
| `language`     | string  | request\_parameters | Language/locale used in response (e.g., "en\_US"). |
| `include_html` | boolean | request\_parameters | Whether HTML content is included in results.       |
| `asin`         | string  | request\_parameters | Amazon Standard Identification Number used.        |
| `type`         | string  | request\_parameters | Type of request, usually "OFFER".                  |

### &#x20;`request_metadata` (object)

Provides internal data about the request's processing timeline and pagination.

| Field                         | Type   | Parent                       | Description                                     |
| ----------------------------- | ------ | ---------------------------- | ----------------------------------------------- |
| `created_at`                  | string | request\_metadata            | When the request was created (ISO date format). |
| `processed_at`                | string | request\_metadata            | When the request finished processing.           |
| `total_time_taken`            | number | request\_metadata            | Total time taken for processing (in seconds).   |
| `total_pages`                 | number | request\_metadata            | Total number of pages returned.                 |
| `total_results`               | number | request\_metadata            | Total number of results found.                  |
| `pages[].current_page`        | number | request\_metadata > pages\[] | Current page number.                            |
| `pages[].current_offer_count` | number | request\_metadata > pages\[] | Number of offers in current page.               |
| `pages[].not_match[]`         | array  | request\_metadata > pages\[] | Fields expected but missing from the response.  |
| `pages[].ms`                  | number | request\_metadata > pages\[] | Milliseconds taken to fetch this page.          |

## Core Response Payload – `result` Section

The core data container of the Offer API response. It includes summarized product information and all available seller offers for the product. This is where the primary value of the API lies.

| Field     | Type   | Parent | Description                                                                  |
| --------- | ------ | ------ | ---------------------------------------------------------------------------- |
| `product` | object | result | Contains core product details like title, rating, total ratings, image, etc. |
| `offer`   | object | result | Contains pricing and availability information from different sellers.        |

### `product` (Object)

**Contains high-level information about the product such as title, ASIN, rating, and number of offers.**

| Field           | Type   | Parent    | Description                                 |
| --------------- | ------ | --------- | ------------------------------------------- |
| `title`         | string | `product` | The product’s full title.                   |
| `rating`        | float  | `product` | Average customer rating (e.g., 4.5).        |
| `ratings_total` | int    | `product` | Total number of customer reviews.           |
| `image`         | string | `product` | Amazon image ID (used to build image URLs). |
| `asin`          | string | `product` | Amazon Standard Identification Number.      |
| `link`          | string | `product` | Link to the product’s detail page.          |
| `offer_count`   | int    | `product` | Total number of available offers.           |

<details>

<summary>Sample Output – <code>product</code> </summary>

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

```json
 "product": {
            "title": "Stanley Quencher H2.0 Tumbler with Handle and Straw 40 oz | Flowstate 3-Position Lid | Cup Holder Compatible for Travel | Insulated Stainless Steel Cup | BPA-Free | Toast",
            "rating": 4.5,
            "ratings_total": 58883,
            "image": "31J5v542jbL",
            "asin": "B0DQY6J9TL",
            "link": "https://amazon.com/dp/B0DQY6J9TL",
            "offer_count": 2
        }
```

{% endcode %}

</details>

### `offer` (Object)

**Holds all available offer-related data, including seller offers and available filters. This object has two main children:**

&#x20;`offer_results[]` → Array of seller offers

&#x20;`available_filters` → Indicates availability of different filtering options

### `offer_results` (Array of Objects)

**Each object in this array represents a distinct seller offer for the product, including pricing, delivery, and seller details.**

| Field           | Type    | Parent            | Description                                                 |
| --------------- | ------- | ----------------- | ----------------------------------------------------------- |
| `offer_id`      | string  | `offer_results[]` | Unique encoded identifier for the offer.                    |
| `is_prime`      | boolean | `offer_results[]` | Indicates if the offer is eligible for Amazon Prime.        |
| `offer_asin`    | string  | `offer_results[]` | ASIN associated with the offer.                             |
| `position`      | int     | `offer_results[]` | Display order in the offer list.                            |
| `buybox_winner` | boolean | `offer_results[]` | Indicates whether this offer is the current Buy Box winner. |

### `promotion`(Object)

**Information on coupons or discounts available for the offer.**

| Field        | Type    | Parent                        | Description                              |
| ------------ | ------- | ----------------------------- | ---------------------------------------- |
| `has_coupon` | boolean | `offer_results[] > promotion` | Indicates whether a coupon is available. |

### `price`(Object)

**The main price information for the offer.**

| Field      | Type   | Parent                    | Description                  |
| ---------- | ------ | ------------------------- | ---------------------------- |
| `symbol`   | string | `offer_results[] > price` | Currency symbol (e.g., "$"). |
| `value`    | string | `offer_results[] > price` | Numeric price value.         |
| `currency` | string | `offer_results[] > price` | Currency code (e.g., USD).   |
| `raw`      | string | `offer_results[] > price` | Formatted price string.      |

### `minimum_order_quantity` / `maximum_order_quantity` (Object)

**Specifies the order limits set by the seller for the offer.**

| Field   | Type | Parent                                     | Description                         |
| ------- | ---- | ------------------------------------------ | ----------------------------------- |
| `value` | int  | `offer_results[] > minimum_order_quantity` | Minimum quantity allowed per order. |
| `value` | int  | `offer_results[] > maximum_order_quantity` | Maximum quantity allowed per order. |

### `condition`(Object)

**Describes the condition of the item being offered (new, used, etc.).**

| Field      | Type    | Parent                        | Description                                   |
| ---------- | ------- | ----------------------------- | --------------------------------------------- |
| `is_new`   | boolean | `offer_results[] > condition` | Whether the item is new.                      |
| `title`    | string  | `offer_results[] > condition` | Condition label (e.g., “New”, “Used – Good”). |
| `comments` | string  | `offer_results[] > condition` | Additional notes, typically for used items.   |

### `delivery`(Object)

**Delivery and fulfillment details for the offer.**

| Field                          | Type    | Parent                       | Description                                            |
| ------------------------------ | ------- | ---------------------------- | ------------------------------------------------------ |
| `fulfilled_by_amazon`          | boolean | `offer_results[] > delivery` | If true, item is shipped by Amazon (FBA).              |
| `shipped_from_outside_country` | boolean | `offer_results[] > delivery` | Indicates if item is shipped from outside the country. |
| `countdown`                    | string  | `offer_results[] > delivery` | Countdown to order cut-off for fast shipping.          |

### `delivery.price`(Object)

**Shipping cost details.**

| Field      | Type    | Parent                               | Description                        |
| ---------- | ------- | ------------------------------------ | ---------------------------------- |
| `symbol`   | string  | `offer_results[] > delivery > price` | Currency symbol for shipping cost. |
| `value`    | string  | `offer_results[] > delivery > price` | Numeric shipping cost.             |
| `currency` | string  | `offer_results[] > delivery > price` | Currency code.                     |
| `raw`      | string  | `offer_results[] > delivery > price` | Formatted shipping price string.   |
| `is_free`  | boolean | `offer_results[] > delivery > price` | Whether shipping is free.          |

### `seller`(Object)

**Details about the seller who is providing the offer.**

| Field  | Type   | Parent                     | Description                       |
| ------ | ------ | -------------------------- | --------------------------------- |
| `name` | string | `offer_results[] > seller` | Seller's display name.            |
| `link` | string | `offer_results[] > seller` | Link to the seller's Amazon page. |

<details>

<summary>Sample Output – <code>offer_results</code> </summary>

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

```json
"offer_results": [
                {
                    "offer_id": "%2FawUBrUy1tL1HtpUTwqrYqS0Rh9756vboab8%2Fj3fodnmDS5OS1q9ZZi6Y2RwM3gSWOQzgLWLMHNLtDtneLUK%2BqNdlmsmxAtbTnHoOfCA46c9AlXy%2B5xRJ3iZtmP0eG08BDgrHlLXylyMqALuZP6jNQ%3D%3D",
                    "is_prime": true,
                    "offer_asin": "B0DQY6J9TL",
                    "position": 0,
                    "buybox_winner": true,
                    "promotion": {
                        "has_coupon": false
                    },
                    "price": {
                        "symbol": "$",
                        "value": "45.00",
                        "currency": "USD",
                        "raw": "$45.00"
                    },
                    "minimum_order_quantity": {
                        "value": 1
                    },
                    "maximum_order_quantity": {
                        "value": 2
                    },
                    "condition": {
                        "is_new": true,
                        "title": "New"
                    },
                    "delivery": {
                        "fulfilled_by_amazon": true,
                        "shipped_from_outside_country": false,
                        "countdown": "3 hrs 33 mins",
                        "price": {
                            "symbol": "$",
                            "value": "",
                            "currency": "USD",
                            "raw": "FREE",
                            "is_free": true
                        }
                    },
                    "seller": {
                        "name": "Amazon.com",
                        "link": "https://amazon.com"
                    }
                },
                {
                    "offer_id": "%2FawUBrUy1tL1HtpUTwqrYqS0Rh9756vbroWJ2Xr%2FcmaPa21a18TIeMcZzck2ITnUm%2BoknPHlOvGLsnbKiltKOGLwJ0MugJxk92efDv2DGF%2B9oFCn6XlT%2BWEVsgREfu8zpafU9EGspidwHGAKIq%2BDSZcKcHCnRF3Ea79VJ%2FqmQPQlAjPPklzYDA06oOoMkcb3",
                    "is_prime": true,
                    "offer_asin": "B0DQY6J9TL",
                    "position": 1,
                    "buybox_winner": false,
                    "promotion": {
                        "has_coupon": false
                    },
                    "price": {
                        "symbol": "$",
                        "value": "38.54",
                        "currency": "USD",
                        "raw": "$38.54"
                    },
                    "minimum_order_quantity": {
                        "value": 1
                    },
                    "maximum_order_quantity": {
                        "value": 1
                    },
                    "condition": {
                        "is_new": false,
                        "title": "Used - Good",
                        "comments": "Minor cosmetic damage on top, front or side of the item. Item may not come in original packaging."
                    },
                    "delivery": {
                        "fulfilled_by_amazon": true,
                        "shipped_from_outside_country": false,
                        "countdown": "3 hrs 33 mins",
                        "price": {
                            "symbol": "$",
                            "value": "",
                            "currency": "USD",
                            "raw": "FREE",
                            "is_free": true
                        }
                    },
                    "seller": {
                        "name": "Amazon Resale",
                        "link": "https://www.amazon.com/Warehouse-Deals/b?ie=UTF8&node=10158976011"
                    }
                }
            ]
```

{% endcode %}

</details>

### `available_filters`(Object)

**A set of boolean flags that describe available offer filters based on the current result set.**

| Field                              | Type    | Parent                      | Description                                   |
| ---------------------------------- | ------- | --------------------------- | --------------------------------------------- |
| `offers_prime`                     | boolean | `offer > available_filters` | True if there are Prime-eligible offers.      |
| `offers_free_shipping`             | boolean | `offer > available_filters` | True if there are offers with free shipping.  |
| `offers_condition_new`             | boolean | `offer > available_filters` | True if there are new condition offers.       |
| `offers_condition_used`            | boolean | `offer > available_filters` | True if there are used condition offers.      |
| `offers_condition_used_like_new`   | boolean | `offer > available_filters` | True if there are "Used – Like New" offers.   |
| `offers_condition_used_very_good`  | boolean | `offer > available_filters` | True if there are "Used – Very Good" offers.  |
| `offers_condition_used_good`       | boolean | `offer > available_filters` | True if there are "Used – Good" offers.       |
| `offers_condition_used_acceptable` | boolean | `offer > available_filters` | True if there are "Used – Acceptable" offers. |

<details>

<summary>Sample Output – <code>available_filters</code></summary>

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

```json
"available_filters": {
                "offers_prime": false,
                "offers_free_shipping": false,
                "offers_condition_new": false,
                "offers_condition_used": false,
                "offers_condition_used_like_new": false,
                "offers_condition_used_very_good": false,
                "offers_condition_used_good": false,
                "offers_condition_used_acceptable": false
            }
```

{% endcode %}

</details>


---

# 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://easyparser.gitbook.io/easyparser-documentation/real-time-integration/offer/response.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.