# Product

The `walmart_product` source is designed to retrieve Walmart product result pages. We can return the HTML for any Walmart page you like. Additionally, we can deliver **structured (parsed) output for Walmart product pages**.

## Request samples

The example below illustrates how you can get a parsed Walmart product page result.

{% tabs %}
{% tab title="cURL" %}

```shell
curl 'https://realtime.oxylabs.io/v1/queries' \
--user 'USERNAME:PASSWORD' \
-H 'Content-Type: application/json' \
-d '{
        "source": "walmart_product", 
        "product_id": "15296401808",
        "parse": true
    }'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
from pprint import pprint


# Structure payload.
payload = {
    'source': 'walmart_product',
    'product_id': '15296401808',
    'parse': True,
}

# Get response.
response = requests.request(
    'POST',
    'https://realtime.oxylabs.io/v1/queries',
    auth=('USERNAME', 'PASSWORD'),
    json=payload,
)

# Instead of response with job status and results url, this will return the
# JSON response with the result.
pprint(response.json())
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const https = require("https");

const username = "USERNAME";
const password = "PASSWORD";
const body = {
    source: "walmart_product",
    product_id: "15296401808",
    parse: true,
};

const options = {
    hostname: "realtime.oxylabs.io",
    path: "/v1/queries",
    method: "POST",
    headers: {
        "Content-Type": "application/json",
        Authorization:
            "Basic " + Buffer.from(`${username}:${password}`).toString("base64"),
    },
};

const request = https.request(options, (response) => {
    let data = "";

    response.on("data", (chunk) => {
        data += chunk;
    });

    response.on("end", () => {
        const responseData = JSON.parse(data);
        console.log(JSON.stringify(responseData, null, 2));
    });
});

request.on("error", (error) => {
    console.error("Error:", error);
});

request.write(JSON.stringify(body));
request.end();
```

{% endtab %}

{% tab title="HTTP" %}

```http
# The whole string you submit has to be URL-encoded.

https://realtime.oxylabs.io/v1/queries?source=walmart_product&product_id=15296401808&parse=true&access_token=12345abcde
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$params = array(
    'source' => 'walmart_product',
    'product_id' => '15296401808',
    'parse' => true
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://realtime.oxylabs.io/v1/queries");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_USERPWD, "USERNAME" . ":" . "PASSWORD");

$headers = array();
$headers[] = "Content-Type: application/json";
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
echo $result;

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);
```

{% endtab %}

{% tab title="Golang" %}

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	const Username = "USERNAME"
	const Password = "PASSWORD"

	payload := map[string]interface{}{
		"source":       "walmart_product",
		"product_id":   "15296401808",
		"parse":        true,
	}

	jsonValue, _ := json.Marshal(payload)

	client := &http.Client{}
	request, _ := http.NewRequest("POST",
		"https://realtime.oxylabs.io/v1/queries",
		bytes.NewBuffer(jsonValue),
	)

	request.SetBasicAuth(Username, Password)
	response, _ := client.Do(request)

	responseText, _ := ioutil.ReadAll(response.Body)
	fmt.Println(string(responseText))
}

```

{% endtab %}

{% tab title="C#" %}

```csharp
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Json;
using System.Threading.Tasks;

namespace OxyApi
{
    class Program
    {
        static async Task Main()
        {
            const string Username = "USERNAME";
            const string Password = "PASSWORD";

            var parameters = new {
                source = "walmart_product",
                product_id = "15296401808",
                parse = true
            };

            var client = new HttpClient();

            Uri baseUri = new Uri("https://realtime.oxylabs.io");
            client.BaseAddress = baseUri;

            var requestMessage = new HttpRequestMessage(HttpMethod.Post, "/v1/queries");
            requestMessage.Content = JsonContent.Create(parameters);

            var authenticationString = $"{Username}:{Password}";
            var base64EncodedAuthenticationString = Convert.ToBase64String(System.Text.ASCIIEncoding.UTF8.GetBytes(authenticationString));
            requestMessage.Headers.Add("Authorization", "Basic " + base64EncodedAuthenticationString);

            var response = await client.SendAsync(requestMessage);
            var contents = await response.Content.ReadAsStringAsync();

            Console.WriteLine(contents);
        }
    }
}
```

{% endtab %}

{% tab title="Java" %}

```java
package org.example;

import okhttp3.*;
import org.json.JSONObject;
import java.util.concurrent.TimeUnit;

public class Main implements Runnable {
    private static final String AUTHORIZATION_HEADER = "Authorization";
    public static final String USERNAME = "USERNAME";
    public static final String PASSWORD = "PASSWORD";

    public void run() {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("source", "walmart_product");
        jsonObject.put("product_id", "15296401808");
        jsonObject.put("parse", true);

        Authenticator authenticator = (route, response) -> {
            String credential = Credentials.basic(USERNAME, PASSWORD);
            return response
                    .request()
                    .newBuilder()
                    .header(AUTHORIZATION_HEADER, credential)
                    .build();
        };

        var client = new OkHttpClient.Builder()
                .authenticator(authenticator)
                .readTimeout(180, TimeUnit.SECONDS)
                .build();

        var mediaType = MediaType.parse("application/json; charset=utf-8");
        var body = RequestBody.create(jsonObject.toString(), mediaType);
        var request = new Request.Builder()
                .url("https://realtime.oxylabs.io/v1/queries")
                .post(body)
                .build();

        try (var response = client.newCall(request).execute()) {
            if (response.body() != null) {
                try (var responseBody = response.body()) {
                    System.out.println(responseBody.string());
                }
            }
        } catch (Exception exception) {
            System.out.println("Error: " + exception.getMessage());
        }

        System.exit(0);
    }

    public static void main(String[] args) {
        new Thread(new Main()).start();
    }
}
```

{% endtab %}

{% tab title="JSON" %}

```json
{
    "source": "walmart_product", 
    "product_id": "15296401808", 
    "parse": true
}
```

{% endtab %}
{% endtabs %}

We use synchronous [**Realtime**](https://developers.oxylabs.io/scraping-solutions/web-scraper-api/integration-methods/realtime) integration method in our examples. If you would like to use [**Proxy Endpoint**](https://developers.oxylabs.io/scraping-solutions/web-scraper-api/integration-methods/proxy-endpoint) or asynchronous [**Push-Pull**](https://developers.oxylabs.io/scraping-solutions/web-scraper-api/integration-methods/push-pull) integration, refer to the [**integration methods**](https://developers.oxylabs.io/scraping-solutions/web-scraper-api/integration-methods) section.

## Request parameter values

### Generic

<table><thead><tr><th width="185">Parameter</th><th width="340.3333333333333">Description</th><th>Default Value</th></tr></thead><tbody><tr><td><mark style="background-color:green;"><strong><code>source</code></strong></mark></td><td>Sets the scraper.</td><td><code>walmart_product</code></td></tr><tr><td><mark style="background-color:green;"><strong><code>product_id</code></strong></mark></td><td>Walmart product ID.</td><td>-</td></tr><tr><td><code>render</code></td><td>Enables JavaScript rendering when set to <code>html</code>. <a href="../../features/js-rendering-and-browser-control/javascript-rendering"><strong>More info</strong></a><strong>.</strong></td><td>-</td></tr><tr><td><code>parse</code></td><td>Returns parsed data when set to <code>true</code>.</td><td><code>false</code></td></tr><tr><td><code>callback_url</code></td><td>URL to your callback endpoint. <a href="../../../integration-methods/push-pull#callback"><strong>More info</strong></a>.</td><td>-</td></tr><tr><td><code>user_agent_type</code></td><td>Device type and browser. The full list can be found <a href="../../features/http-context-and-job-management/user-agent-type"><strong>here</strong></a>.</td><td><code>desktop</code></td></tr></tbody></table>

&#x20;    \- mandatory parameter

### Localization

Adapt results to specific stores, shipping locations. Find the list of Walmart Store IDs here:

{% file src="<https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FvNaqNjeSvxDggN1BwPku%2Fwww_walmart_com_stores.csv?alt=media&token=0298ff89-dad6-4314-aed4-ddbe8f2ddd2e>" %}

You can also find the official page of Walmart Stores [**here**](https://www.walmart.com/store-directory)**.**

<table><thead><tr><th width="164">Parameter</th><th width="398">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>domain</code></td><td>Domain localization for Walmart. Available values: <code>com</code>, <code>com.mx</code>, <code>ca</code>, <code>co.cr</code>. Default: <code>com</code>.</td><td>String</td></tr><tr><td><code>fulfillment_type</code></td><td>Set the fulfillment type. Supported values: <code>pickup</code>, <code>delivery</code>, <code>shipping</code>.</td><td>String</td></tr><tr><td><code>delivery_zip</code></td><td>Set the shipping-to location.</td><td>String</td></tr><tr><td><code>store_id</code></td><td>Set the store location.</td><td>String</td></tr></tbody></table>

Fulfillment type parameter availability varies by Walmart domain:

<table><thead><tr><th width="341">Domain</th><th>Supported fulfillment types</th></tr></thead><tbody><tr><td><code>walmart.com</code></td><td><code>pickup</code>, <code>delivery</code>, <code>shipping</code></td></tr><tr><td><code>walmart.com.mx</code></td><td><code>pickup</code>, <code>delivery</code></td></tr><tr><td><code>walmart.ca</code></td><td><code>pickup</code>, <code>delivery</code></td></tr><tr><td><code>walmart.co.cr</code></td><td><code>pickup</code></td></tr></tbody></table>

For international `store_id` lists, see the files below:

{% file src="<https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FsqX7MVSRLTctxuUul1R3%2Fwww_walmart_com_mx_stores.csv?alt=media&token=5932fa5c-8521-4df4-95bf-dcab19038e73>" %}

{% file src="<https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FywZb2H7rxZBWHQGHQY1J%2Fwww_walmart_ca_stores.csv?alt=media&token=992cc9bc-f62d-486a-9c38-5634340fa3e3>" %}

{% file src="<https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2Fl2keVL05Bkf2baAMcLjV%2Fwalmart_co_cr_stores.json?alt=media&token=977cdb80-97eb-4e38-a926-b0f301907e42>" %}

{% hint style="info" %}
If target store is too far away from the given postal code - we will attempt to use the postal code of the target store, otherwise the location will not be set properly. In the case we can't set the `delivery_zip` - Walmart will return their default results without store targeting.
{% endhint %}

## Structured data

{% hint style="info" %}
In the following sections, parsed JSON code snippets are shortened where more than one item for the result type is available.
{% endhint %}

<details>

<summary>Walmart product page structured output</summary>

```javascript
{
    "results": [
        {
            "content": {
                "price": {
                    "price": 157.97,
                    "currency": "USD",
                    "price_strikethrough": 199.99
                },
                "rating": {
                    "count": 94,
                    "rating": 4.5
                },
                "seller": {
                    "id": "ED6F630F4BA94318A00A1D0BAACD0A48",
                    "url": "/seller/7648?itemId=701606028&pageName=item&returnUrl=%2Fip%2FApple-iPhone-Xs-64GB-Unlocked-GSM-CDMA-4G-LTE-Phone-w-Dual-12MP-Camera-Gold-Fair-Cosmetics-Fully-Functional%2F701606028",
                    "name": "Kiss Electronics Inc",
                    "catalog_id": "7648",
                    "official_name": "Kiss Electronics Inc"
                },
                "general": {
                    "url": "https://www.walmart.com/ip/Apple-iPhone-Xs-64GB-Unlocked-GSM-CDMA-4G-LTE-Phone-w-Dual-12MP-Camera-Gold-Fair-Cosmetics-Fully-Functional/701606028",
                    "meta": {
                        "sku": "701606028",
                        "gtin": "683346585136"
                    },
                    "badge": "Best seller",
                    "brand": "Apple",
                    "title": "Pre-Owned Apple iPhone XS - Carrier Unlocked - 64GB Gold",
                    "images": [
                        "https://i5.walmartimages.com/seo/Apple-iPhone-Xs-64GB-Unlocked-GSM-CDMA-4G-LTE-Phone-w-Dual-12MP-Camera-Gold-Fair-Cosmetics-Fully-Functional_d6dacc88-10c1-46e0-b528-c626915adadc.4c6907ee5896ccbc68382cb59470a6d8.jpeg?odnHeight=117&odnWidth=117&odnBg=FFFFFF"
                    ],
                    "main_image": "https://i5.walmartimages.com/seo/Apple-iPhone-Xs-64GB-Unlocked-GSM-CDMA-4G-LTE-Phone-w-Dual-12MP-Camera-Gold-Fair-Cosmetics-Fully-Functional_d6dacc88-10c1-46e0-b528-c626915adadc.4c6907ee5896ccbc68382cb59470a6d8.jpeg?odnHeight=640&odnWidth=640&odnBg=FFFFFF",
                    "description": "<p>Super Retina. In Big and Bigger. An all-screen design gives you a large, beautiful canvas for everything you love to do. Custom-built OLED. The OLED panels in iPhone Xs allow for an HDR display with the industry's best color accuracy, true blacks, and remarkable brightness and contrast. They're the sharpest displays, with the highest pixel density, on any Apple device. A new level of water resistance. The most durable glass in a smartphone, sealed and precision-fitted with surgical-grade stainless steel band, helps create a more water-resistant enclosure - up to 2 meters for 30 minutes. iPhone Xs even resists spills from Coffee, Tea, Soda, and more. A whole new level of intelligence. The A12 Bionic, with our next-generation Neural Engine, delivers incredible performance. It uses real-time machine learning to transform the way you experience photos, gaming, augmented reality, and more. Sensors, processors, algorithms, and you. An innovative dual-camera system integrates the ISP, the Neural Engine, and advanced algorithms to unlock new creative possibilities and help you capture incredible photos. A picture is worth a trillion operations. The iPhone Xs dual-camera system harnesses the unprecedented power of the Neural Engine and its ability to perform five trillion operations per second. Together with the Apple-designed ISP, it works like the world's fastest photographer's assistant to help turn your pictures into showstoppers. Security made simple. Face ID reinvent the way we unlock, log in, and pay. Some of our most sophisticated technologies - the True Depth camera system, the Secure Enclave, and the Neural Engine - make it the most secure facial authentication ever in a smartphone. And even faster and easier to use.</p><ul>   <li>Phone is tested, working and functional. May have scruff, scratched, cracks or other minor issues that don't affect the functionality of phone.</li>   <li>5.8-inch Super AMOLED Capacitive Touchscreen, 1125 x 2436 pixels</li>   <li>iOS, Apple A12 Bionic, Hexa-Core, Apple GPU (4-Core Graphics)</li>   <li>Dual 12MP(f/1.8, 28mm, OIS) &amp; 12MP(f/2.4, 52mm, 2x optical Zoom) Cameras with Quad-LED Dual-Tone Flash &amp; 7MP Front Camera with f/2.2, 32mm</li>   <li>Internal Memory: 64GB, 4GB RAM</li>   <li>IP68 Dust/Water Resistant (Up to 2m for 30 mins), Scratch-Resistant Glass, Oleophobic Coating</li>   <li>Dimensions: 5.65 x 2.79 x 0.30 inches, Weight: 6.24 oz</li>  </ul>"
                },
                "location": {
                    "city": "Sacramento",
                    "state": "CA",
                    "store_id": "3081",
                    "zip_code": "95829"
                },
                 "variations": [
                    {
                        "state": "IN_STOCK",
                        "product_id": "7328JAQF0Y2S",
                        "selected_options": [
                            {
                                "key": "Carrier",
                                "value": "Verizon"
                            },
                            {
                                "key": "Capacity",
                                "value": "256GB"
                            },
                            {
                                "key": "Color",
                                "value": "Desert Titanium"
                            }
                        ]
                    },
                "breadcrumbs": [
                    {
                        "url": "/cp/cell-phones/1105910",
                        "category_name": "Cell Phones"
                    },
                    {
                        "url": "/cp/unlocked-phones/1073085",
                        "category_name": "Unlocked Phones"
                    },
                    {
                        "url": "/cp/gsm-unlocked/8230659",
                        "category_name": "GSM Unlocked"
                    }
                ],
                "fulfillment": {
                    "pickup": false,
                    "delivery": false,
                    "shipping": true,
                    "out_of_stock": false,
                    "free_shipping": true,
                    "pickup_information": "Pickup, Not available",
                    "delivery_information": "Delivery, Not available",
                    "shipping_information": "Shipping, Arrives Oct 18, Free"
                },
                "specifications": [
                    {
                        "key": "Processor Brand",
                        "value": "Apple"
                    },
                    {
                        "key": "Display Technology",
                        "value": "Retina Display"
                    },
                    {
                        "key": "Phone Feature",
                        "value": "Wireless Charging"
                    },
                    ...
                ],
                "parse_status_code": 12000
            },
            "created_at": "2024-09-16 08:09:03",
            "updated_at": "2024-09-16 08:09:06",
            "page": 1,
            "url": "https://www.walmart.com//ip/Apple-iPhone-Xs-64GB-Unlocked-GSM-CDMA-4G-LTE-Phone-w-Dual-12MP-Camera-Gold-Fair-Cosmetics-Fully-Functional/701606028",
            "job_id": "7253339040034008521",
            "is_render_forced": false,
            "status_code": 200,
            "parser_type": "walmart_product_new"
        }
    ]
}
```

</details>

## Output data dictionary

#### HTML example

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FRf4RZ1wmy4zXw66lS7VB%2Fimage.png?alt=media&#x26;token=2ef55632-2fad-4b05-af18-388ceef49abb" alt=""><figcaption></figcaption></figure>

**JSON structure**

The table below presents a detailed list of each product page element we parse, along with its description and data type. The table also includes some metadata.

<table><thead><tr><th width="235">Key</th><th width="327">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>general</code></td><td>An object with general product page result details.</td><td>object</td></tr><tr><td><code>price</code></td><td>Object contains details on product pricing.</td><td>object</td></tr><tr><td><code>rating</code></td><td>Rating information for the product.</td><td>object</td></tr><tr><td><code>seller</code></td><td>Information about the seller.</td><td>object</td></tr><tr><td><code>variations</code> (optional)</td><td>List of variations of the product.</td><td>array</td></tr><tr><td><code>breadcrumbs</code></td><td>Hierarchy of categories leading to the product.</td><td>object</td></tr><tr><td><code>location</code></td><td>Provides information on the location in which the request was run in.</td><td>object</td></tr><tr><td><code>fulfillment</code></td><td>Object contains information on product fulfillment options.</td><td>object</td></tr><tr><td><code>specifications</code></td><td>Array of key-value pairs detailing specific attributes or features of the product.</td><td>array</td></tr><tr><td><code>parse_status_code</code></td><td>The status code of the parsing job. You can see the parser status codes described <a href="https://github.com/oxylabs/gitbook-public-english/blob/master/scraping-solutions/web-scraper-api/targets/walmart/broken-reference/README.md"><strong>here</strong></a>.</td><td>integer</td></tr><tr><td><code>created_at</code></td><td>The timestamp when the scraping job was created.</td><td>timestamp</td></tr><tr><td><code>updated_at</code></td><td>The timestamp when the scraping job was finished.</td><td>timestamp</td></tr><tr><td><code>page</code></td><td>Page number from which the product data was extracted</td><td>integer</td></tr><tr><td><code>url</code></td><td>URL of the product page on Walmart's website</td><td>string</td></tr><tr><td><code>job_id</code></td><td>The ID of the job associated with the scraping job.</td><td>string</td></tr><tr><td><code>status_code</code></td><td>The status code of the scraping job. You can see the scraper status codes described <a href="https://github.com/oxylabs/gitbook-public-english/blob/master/scraping-solutions/web-scraper-api/targets/walmart/broken-reference/README.md"><strong>here</strong></a>.</td><td>integer</td></tr><tr><td><code>is_render_forced</code></td><td>Identifies whether rendering has been forced for this request.</td><td>boolean</td></tr><tr><td><code>parser_type</code></td><td>Type of parser used for extracting the data (e.g., "walmart_product_new").</td><td>string</td></tr></tbody></table>

### **General**

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FaSvaIbnN2i7qaTbrSNTn%2Fimage.png?alt=media&#x26;token=27f54f1a-4b4e-42a9-a276-ee0dc617d0c8" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th>Key (general)</th><th width="295">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>url</code></td><td>The URL of the product.</td><td>string</td></tr><tr><td><code>main_image</code></td><td>The URL of the main product image</td><td>integer</td></tr><tr><td><code>images</code></td><td>Array of URLs to images of the product.</td><td>array</td></tr><tr><td><code>title</code></td><td>Title or name of the product.</td><td>string</td></tr><tr><td><code>description</code></td><td>Detailed description of the product.</td><td>string</td></tr><tr><td><code>brand</code></td><td>The brand of the product.</td><td>string</td></tr><tr><td><code>badge</code></td><td>Indicator of specific attributes such as promotions, product features, certifications, or brand affiliations.</td><td>list of strings</td></tr><tr><td><code>meta</code></td><td>Metadata of the product.</td><td>object</td></tr><tr><td><code>meta.sku</code></td><td>Stock Keeping Unit (SKU) of the product.</td><td>string</td></tr><tr><td><code>meta.gtin</code></td><td>Global Trade Item Number (GTIN) of the product.</td><td>string</td></tr></tbody></table>

### Price

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FbHuOFRLgYIupTiXEYNJ7%2FScreenshot%202024-10-16%20at%2015.45.26.png?alt=media&#x26;token=554df0e4-ddf4-40a7-9aba-2a4e109b295c" alt=""><figcaption></figcaption></figure>

```json
...
"price": {
    "price": 12.49,
    "price_strikethrough": 23.72,
    "currency": "USD"
},
...
```

<table><thead><tr><th width="240">Key (price)</th><th width="314">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>price</code></td><td>The current price of the product without any deductions.</td><td>float</td></tr><tr><td><code>price_strikethrough</code></td><td>The strikethrough price is either a Was Price, a Bundle Price, or a List Price.</td><td>float</td></tr><tr><td><code>currency</code></td><td>The ISO 4217 three-letter currency code for the product price.</td><td>string</td></tr></tbody></table>

### Rating

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2F84TI93TzejkPgpwIIChL%2Fimage.png?alt=media&#x26;token=cd8e08f9-a9fa-4c89-9772-27b579b9f298" alt=""><figcaption></figcaption></figure>

```json
...
 "rating": {
    "count": 64,
    "rating": 4.7
},
...
```

<table><thead><tr><th>Key (rating)</th><th width="295">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>rating</code></td><td>Average rating of the product.</td><td>float</td></tr><tr><td><code>count</code></td><td>Number of ratings for the product.</td><td>integer</td></tr></tbody></table>

### Seller

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FryFLiO5nrH9GHpey52M7%2Fimage.png?alt=media&#x26;token=ebc6f6d3-1734-4fa5-8d25-06626ecd3258" alt="" width="440"><figcaption></figcaption></figure>

```javascript
...
"seller": {
    "id": "ED6F630F4BA94318A00A1D0BAACD0A48",
    "url": "/seller/7648?itemId=701606028&pageName=item&returnUrl=%2Fip%2FApple-iPhone-Xs-64GB-Unlocked-GSM-CDMA-4G-LTE-Phone-w-Dual-12MP-Camera-Gold-Fair-Cosmetics-Fully-Functional%2F701606028",
    "name": "Kiss Electronics Inc",
    "catalog_id": "7648",
    "official_name": "Kiss Electronics Inc"
},
...
```

<table><thead><tr><th>Key (seller)</th><th width="307">Describtion</th><th>Type</th></tr></thead><tbody><tr><td><code>name</code></td><td>Name of the seller.</td><td>string</td></tr><tr><td><code>official_name</code></td><td>Official registered name of the seller entity.</td><td>string</td></tr><tr><td><code>id</code></td><td>Unique identifier assigned to the seller by the platform.</td><td>string</td></tr><tr><td><code>url</code></td><td>The URL that leads to the seller's official website or storefront.</td><td>string</td></tr><tr><td><code>catalog_id</code></td><td>ID of catalog.</td><td>string</td></tr></tbody></table>

### Specifications

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FJhGxFxEzCg9eeZ08CpGp%2Fimage.png?alt=media&#x26;token=3e1324a0-4da0-401c-83ed-8ee434587ace" alt=""><figcaption></figcaption></figure>

```javascript
...
"specifications": [
    ...
    {
        "key": "Brand",
        "value": "LEGO"
    },
    {
        "key": "Age Range",
        "value": "9 Years & Up"
    },
]
...
```

<table><thead><tr><th>Key (specifications)</th><th width="332">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>key</code></td><td>Specific attribute or characteristic of the product.</td><td>string</td></tr><tr><td><code>value</code></td><td>Corresponding value or description of the attribute specified by the specifications key.</td><td>string</td></tr></tbody></table>

### Fulfillment

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FYL57m0Lzh5w3zhCokJOk%2FScreenshot%202024-10-16%20at%2015.38.34.png?alt=media&#x26;token=dc921c20-9d51-4876-bbef-e2147b150143" alt=""><figcaption></figcaption></figure>

```javascript
...
"fulfillment": {
                    "pickup": false,
                    "delivery": false,
                    "shipping": true,
                    "out_of_stock": false,
                    "free_shipping": true,
                    "pickup_information": "Pickup, Not available",
                    "delivery_information": "Delivery, Not available",
                    "shipping_information": "Shipping, Arrives Oct 24, Free"
                },
...
```

<table><thead><tr><th width="250">Key (fulfillment)</th><th width="325">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>pickup</code></td><td>Indicates if the product is available to be fulfilled via in-store pickup.</td><td>boolean</td></tr><tr><td><code>pickup_information</code></td><td>The pickup message, when pickup = true.</td><td>string</td></tr><tr><td><code>delivery</code></td><td>Indicates if the product is available to be fulfilled via delivery from local store.</td><td>boolean</td></tr><tr><td><code>delivery_information</code></td><td>The delivery from local store message, when delivery = true.</td><td>string</td></tr><tr><td><code>shipping</code></td><td>Indicates if the product is available to be fulfilled via home shipping.</td><td>boolean</td></tr><tr><td><code>shipping_information</code></td><td>The shipping message, if shown.</td><td>string</td></tr><tr><td><code>free_shipping</code></td><td>Indicates if shipping is free of charge.</td><td>boolean</td></tr><tr><td><code>out_of_stock</code></td><td>Indicates if the product is currently out of stock.</td><td>boolean</td></tr></tbody></table>

### Variations

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FS4HMve6hBeQeffyUGhXf%2Fimage.png?alt=media&#x26;token=50a77457-6171-4764-bec4-a8de79d83bd6" alt=""><figcaption></figcaption></figure>

```javascript
...
"variations": [
    {
        "state": "IN_STOCK",
        "product_id": "7328JAQF0Y2S",
        "selected_options": [
            {
                "key": "Color",
                "value": "Black"
            },
]
...
```

<table><thead><tr><th width="284">Key (variations)</th><th width="298">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>state</code></td><td>Availability state of the product variation.</td><td>string</td></tr><tr><td><code>product_id</code></td><td>Unique identifier for each product variation.</td><td>string</td></tr><tr><td><code>selected_options</code></td><td>Array containing selected options that define the variation.</td><td>array</td></tr><tr><td><code>selected_options.key</code></td><td>Key describing the option selected.</td><td>string</td></tr><tr><td><code>selected_options.value</code></td><td>Value of the option selected.</td><td>string</td></tr></tbody></table>

### Breadcrumbs

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FiVn1eT3Q3EdEyCgFC6is%2FScreenshot%202024-10-16%20at%2015.36.54.png?alt=media&#x26;token=fa6567a6-4db2-4f36-ab27-bc7b70a377b8" alt=""><figcaption></figcaption></figure>

```javascript
... 
"breadcrumbs": [
    {
        "url": "/cp/cell-phones/1105910",
        "category_name": "Cell Phones"
    },
    {
        "url": "/cp/phones-with-plans/1073085",
        "category_name": "Phones With Plans"
    },
    {
        "url": "/cp/postpaid-phones/8230659",
        "category_name": "Postpaid Phones"
    }
    ...
],
...
```

<table><thead><tr><th>Key (breadcrumbs)</th><th width="312">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>category_name</code></td><td>The name of the category.</td><td>string</td></tr><tr><td><code>url</code></td><td>The URL of the category</td><td>string</td></tr></tbody></table>

### Location

<figure><img src="https://63892162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzrXw45naRpCZ0Ku9AjY1%2Fuploads%2FTrK9oPtIzH7mwKDKDS2y%2FScreenshot%202024-10-16%20at%2015.31.30.png?alt=media&#x26;token=a7a756ce-1072-4c62-86df-5160b9ac6dbc" alt="" width="384"><figcaption></figcaption></figure>

```javascript
...
"location": {
    "city": "Sacramento",
    "state": "CA",
    "store_id": "8915",
    "zip_code": "95829"
},
...
```

<table><thead><tr><th>Key (location)</th><th width="297">Description</th><th>Type</th></tr></thead><tbody><tr><td><code>city</code></td><td>The city the request was run on.</td><td>string</td></tr><tr><td><code>state</code></td><td>The state the request was run on.</td><td>string</td></tr><tr><td><code>zip_code</code></td><td>The zip code the request was run on.</td><td>string</td></tr><tr><td><code>store_id</code></td><td>The ID of the store that the request was run on.</td><td>string</td></tr></tbody></table>
