Walmart Suggest
GET
Get Walmart.com search autocomplete suggestions for a keyword via browser rendering, with optional US ZIP code localization.
Credit cost: 2 credits per call
ApiKeyAuthheader
x-api-key<token>Your API key. Include it in the x-api-key header for every request.
query*stringSearch keyword for Walmart autocomplete suggestions.
Example:
applesNotes:
- Partial keywords return related query suggestions (e.g.
apples→applesauce,apple juice). - Mirrors the Walmart.com search typeahead behavior.
- Walmart typeahead is loaded via JavaScript; this endpoint uses browser rendering.
zipcode?stringOptional US ZIP code to localize Walmart store and inventory context for suggestions.
Example:
95829Notes:
- 5-digit US ZIP code format.
- Omit to use Walmart's default location context.
- When provided, affects localized availability context on walmart.com.
fields?stringComma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).
is_async?booleanRun the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.
Default
falsesoft_fail?booleanReturn HTTP 200 even when the request fails; the error is in the error field of the body.
Default
falseSuccessful response
application/json- response
results?array<>curl -X GET 'https://api.piloterr.com/v2/walmart/suggest?query=string'Example Response
{ "results": [ { "url": "query=apples&typeahead=apples", "type": "QUERY", "image_url": "https://i5.walmartimages.com/asr/bcfd9451-a73b-411f-84e3-1d866f833ae8.3e996f05a24facfa2ac526d6c631401d.jpeg", "analytics_fm": 5, "display_name": "apples" }, { "url": "query=applesauce&typeahead=apples", "type": "QUERY", "image_url": "https://i5.walmartimages.com/asr/d71c007b-3ae2-433f-9ca2-41906af71500.bff31e2bb8bdfddd3bd46ae00f50135d.jpeg", "analytics_fm": 5, "display_name": "applesauce" }, { "url": "query=apple%20juice&typeahead=apples", "type": "QUERY", "image_url": "https://i5.walmartimages.com/asr/34a4bc66-9cdb-404c-8665-b6435742ed45.3402c97169db76e6c3784d67cc1ad581.jpeg", "analytics_fm": 5, "display_name": "apple juice" } ]}