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

Whole Foods Store API Documentation

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

Whole Foods Store API returns the name, status, phone number, address, coordinates, time zone, opening date and Prime eligibility of one Whole Foods Market store.

Use it to check a store id before you search. An id that is not a Whole Foods store returns 422. Costs 1 credit per successful request. Failed requests are free.

Whole Foods Store API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/wholefoods/store
Auth header
x-api-key
Cost
1 credit/request
store_id = 1234567890
Response preview
200 OK
{
    "data": {
        "store": {
            "id": "10245",
            "name": "Tribeca",
            "phone": "2123496555",
            "status": "Open",
            "address": {
                "city": "New York",
                "state": "NY",
                "street": "270 Greenwich St",
                "country": "United States of America",
                "postal_code": "10007-1150"
            },
...

Parameters

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

Runnable path

1 required parameter needed before sending a request.

store_id string Required

Whole Foods store id, 5 digits, for example 10245.

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": {
        "store": {
            "id": "10245",
            "name": "Tribeca",
            "phone": "2123496555",
            "status": "Open",
            "address": {
                "city": "New York",
                "state": "NY",
                "street": "270 Greenwich St",
                "country": "United States of America",
                "postal_code": "10007-1150"
            },
            "latitude": 40.715467,
            "timezone": "America/New_York",
            "longitude": -74.0119,
            "opened_at": "2018-07-24",
            "prime_eligible": true
        }
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "store"
    },
    "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": {
        "store_id": [
            "A store id is required, e.g. 10245."
        ]
    },
    "message": "The request validation failed"
}
422

Unknown Store

The store id has the right format but is not a Whole Foods store. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "store"
    },
    "error": {
        "code": "UNKNOWN_STORE",
        "message": "The store id is not a Whole Foods store."
    },
    "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": "store"
    },
    "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.