Skip to content
Scrappa Get API key
Whole Foods API 1 credit/request

Whole Foods Product API Documentation

GET https://scrappa.co/api/wholefoods/product

Whole Foods Product API returns the details of one product: description, highlights, images, ingredients, the full nutrition facts panel (serving size, calories, nutrients with amount, unit and daily value), diets, availability and SNAP EBT eligibility.

Pass the ASIN in id (as returned by search) or a product page link in url. Pass store_id to get the price of that store, including a sale price. Without a store id the price is the general online price.

Some products have no price or no stock data at all: price, availability and ingredients are then left out, never set to 0. The unit price is only shown when it matches the price shown. Costs 1 credit per successful request. Unknown products and failed requests are free.

Whole Foods Product API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/wholefoods/product
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "product": {
            "id": "B0005XMS0C",
            "name": "Cape Cod Potato Chips, Potato Chips Reduced Fat, 5 Ounce",
            "brand": "Cape Cod",
            "diets": [
                "gluten-free",
                "kosher",
                "vegan"
            ],
            "image": "https://m.media-amazon.com/images/I/71W8JVJKdWL.jpg",
            "price": 4.29,
            "images": [
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

This endpoint has no required query parameters.

3 optional filters available.

id string Optional

ASIN of the product, 10 letters and digits, for example B0005XMS0C. Send id or url.

Example value 1234567890
url string Optional
Open example

Product page link on wholefoodsmarket.com. The ASIN is read from the end of the link. Send id or url.

Example value https://example.com/product
store_id string Optional

Whole Foods store id, 5 digits. Adds the price, sale price and unit price of this store.

Example value 1234567890

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "product": {
            "id": "B0005XMS0C",
            "name": "Cape Cod Potato Chips, Potato Chips Reduced Fat, 5 Ounce",
            "brand": "Cape Cod",
            "diets": [
                "gluten-free",
                "kosher",
                "vegan"
            ],
            "image": "https://m.media-amazon.com/images/I/71W8JVJKdWL.jpg",
            "price": 4.29,
            "images": [
                "https://m.media-amazon.com/images/I/71W8JVJKdWL.jpg",
                "https://m.media-amazon.com/images/I/81JCy9T1MwL.jpg",
                "https://m.media-amazon.com/images/I/61u4KX8Z3mL.jpg",
                "https://m.media-amazon.com/images/I/819qwXXHKeL.jpg",
                "https://m.media-amazon.com/images/I/61S6aEUUYdL.jpg",
                "https://m.media-amazon.com/images/I/51Jt46j7C-L.jpg"
            ],
            "on_sale": false,
            "category": "Snack chip and crisp",
            "currency": "USD",
            "nutrition": {
                "calories": 130,
                "nutrients": [
                    {
                        "name": "Total Fat",
                        "unit": "g",
                        "amount": 6,
                        "indent": 0,
                        "daily_value_percent": 8
                    },
                    {
                        "name": "Saturated Fat",
                        "unit": "g",
                        "amount": 0,
                        "indent": 1,
                        "daily_value_percent": 0
                    },
                    {
                        "name": "Trans Fat",
                        "unit": "g",
                        "amount": 0,
                        "indent": 1
                    },
                    {
                        "name": "Sodium",
                        "unit": "mg",
                        "amount": 125,
                        "indent": 0
                    },
                    {
                        "name": "Total Carbohydrate",
                        "unit": "g",
                        "amount": 18,
                        "indent": 0,
                        "daily_value_percent": 7
                    },
                    {
                        "name": "Dietary Fiber",
                        "unit": "g",
                        "amount": 2,
                        "indent": 1,
                        "daily_value_percent": 7
                    },
                    {
                        "name": "Sugars",
                        "unit": "g",
                        "amount": 0,
                        "indent": 1
                    },
                    {
                        "name": "Added Sugars",
                        "unit": "g",
                        "amount": 0,
                        "indent": 2
                    },
                    {
                        "name": "Protein",
                        "unit": "g",
                        "amount": 2,
                        "indent": 0
                    }
                ],
                "serving_size": "1oz (28g/about 19 chips)",
                "servings_per_container": "5 servings per container"
            },
            "highlights": [
                "Includes one (1) 5-ounce bag of Cape Cod less fat original potato chips",
                "Less fat kettle chips with 40% less fat than the leading potato chip",
                "Just as delicious as our classic chip and with the same Cape Cod crunch",
                "Non-GMO, gluten-free snack with no artificial colors, flavors or preservatives",
                "Every chip is an invitation to savor what's special about Cape Cod"
            ],
            "short_name": "Reduced Fat Potato Chips",
            "unit_price": 0.86,
            "description": "Try Cape Cod Less Fat Original potato chips for a remarkably similar taste to our original chips. With 40% less fat than the leading potato chip, these kettle chips have a simple recipe: choice potatoes, vegetable oil, and a sprinkling of sea salt. To top it of, we remove the excess oil and reduce the fat during our unique kettle cooking process. They're ridiculously good! Cape Cod Potato Chips are known for their quality taste, hearty crunch and distinctly remarkable flavors. These delicious chips are made with premium ingredients beginning with oil, salt and potatoes. Available in many traditional and unique varieties, Cape Cod Potato Chips maintain the tradition of using high quality ingredients in all its snacks.",
            "ingredients": "POTATOES, VEGETABLE OIL (CONTAINS ONE OR MORE OF THE FOLLOWING: CANOLA OIL, SAFFLOWER OIL AND/OR SUNFLOWER OIL), SALT.",
            "availability": "in_stock",
            "regular_price": 4.29,
            "unit_price_unit": "ounce",
            "max_order_quantity": 5
        }
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "product"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter or a value is invalid. This response is not billable.

{
    "errors": {
        "id": [
            "A product id (ASIN) or a product url is required, e.g. B0005XMS0C."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The product does not exist. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "product"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
503

Upstream Unavailable

Whole Foods could not be reached. This response is not billable. Retry shortly.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "product"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Whole Foods could not be reached. Please retry shortly."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.