Piloterr

Walmart Search

GET
/v2/walmart/search

Search Walmart by keyword or search URL. Returns product cards with offer price, unit price, rating, seller, shipping flags, and pagination.

Credit cost: 2 credits per call

Autorização

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parâmetros de consulta

query*string

Keyword or a Walmart search URL.

Example (keyword):

bread

Example (search URL):

https://www.walmart.com/search?q=bread

Notes:

  • page on the URL is used unless the page argument is set.
  • Facet filters already present on a search URL are kept.
  • Pass us_item_id or product_page_url to Walmart Product.
page?number

Page number, starting at 1.

Example:

2

Replaces page when query is already a search URL.

return_page_source?boolean

When true, return {"result": html} instead of the parsed cards.

fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Corpo da resposta

Successful response

application/json
  1. response
query?string
results?array<>
location?
pagination?
Example Request
curl -X GET 'https://api.piloterr.com/v2/walmart/search?query=string'
Example Response
{  "query": "bread",  "results": [    {      "title": "Artesano Original Bread, 20 oz",      "rating": 4.6,      "reviews": 6794,      "low_stock": false,      "seller_id": "F55CDC31AB754BB68FE0B39041159D63",      "sponsored": true,      "thumbnail": "https://i5.walmartimages.com/seo/Artesano-Original-Bread-20-oz_01388876-640a-4344-8563-53546da54f9a.71b053a91e953e5c41060f674f8decc4.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF",      "product_id": "2QPNQB69IOK6",      "us_item_id": "19883461746",      "description": "",      "seller_name": "Walmart.com",      "out_of_stock": false,      "product_type": "Breads & Buns",      "free_shipping": false,      "primary_offer": {        "currency": "USD",        "offer_id": "5CF8B0E4C3F1392485141A67B961BA75",        "offer_price": 3.86      },      "snap_eligible": true,      "price_per_unit": {        "unit": "each",        "amount": "19.3 ¢/oz"      },      "product_page_url": "https://www.walmart.com/ip/Artesano-Original-Bread-20-oz/19883461746?classType=REGULAR&athbdg=L1600",      "two_day_shipping": false,      "additional_sellers": 1,      "availability_status": "In stock",      "multiple_options_available": false,      "free_shipping_with_walmart_plus": false    },    {      "title": "New York Bakery Real Garlic Texas Toast, 8 Count, Frozen Bread",      "rating": 4.7,      "reviews": 15158,      "low_stock": false,      "seller_id": "F55CDC31AB754BB68FE0B39041159D63",      "sponsored": true,      "thumbnail": "https://i5.walmartimages.com/seo/New-York-Bakery-Real-Garlic-Texas-Toast-11-25-oz-8-Count-Frozen_3ab0e4a0-6747-4e1e-83e8-0cc9fc5bd16b.26a29b9061a3fb2fcc092de1c0766c8c.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF",      "product_id": "1RDU7FV5UP2S",      "us_item_id": "10805037",      "description": "",      "seller_name": "Walmart.com",      "out_of_stock": false,      "product_type": "Breads & Buns",      "free_shipping": false,      "primary_offer": {        "currency": "USD",        "offer_id": "7DD61A7A27F244BC97B965C9AE6AB629",        "offer_price": 3.12      },      "snap_eligible": true,      "price_per_unit": {        "unit": "each",        "amount": "27.6 ¢/oz"      },      "product_page_url": "https://www.walmart.com/ip/New-York-Bakery-Real-Garlic-Texas-Toast-11-25-oz-8-Count-Frozen/10805037?classType=REGULAR&athbdg=L1600",      "two_day_shipping": false,      "availability_status": "In stock",      "multiple_options_available": false,      "free_shipping_with_walmart_plus": false    }  ],  "location": {    "city": "Sacramento",    "store_id": "3081",    "postal_code": "95829",    "province_code": "CA"  },  "pagination": {    "next": "https://www.walmart.com/search?q=bread&page=2",    "page": 1,    "per_page": 48,    "total_pages": 12,    "total_results": 2219  }}