/walmart/products

POST /api/walmart/products

Price: 10 credits

Get full Walmart product details by itemId (or product URL): title, brand, price, list_price, images, rating, reviews breakdown, specifications, features, warranty, badges, condition, return policy, variants, seller and availability.

How to use it

Fetch a single Walmart product by itemId (numeric) or a product URL. Returns one item with title, brand, brand_url, model, upc, price/list_price/currency, image+images, rating, rating_count, review_count and per-star rating breakdown, availability_status/is_in_stock, description, long_description, features, specifications (name/value), warranty, breadcrumbs+category, condition (new/refurbished/preowned grade), is_preowned, badges, return_policy (is_returnable/has_free_returns/return_window/text), variants (color/pack options) and seller (id/catalog_id/name/type/rating/review_count).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• item string required — Walmart product itemId or a product URL containing it (examples: "225142139", "https://www.walmart.com/ip/Keurig-K-elite-Brewer-Slate/225142139"; minLength: 1)

Response

• @type string (default: "WalmartProduct")
• id string required
• url string required
• alias string nullable
• brand string nullable
• brand_url string nullable
• model string nullable
• manufacturer_id string nullable
• upc string nullable
• price number nullable
• list_price number nullable
• currency string nullable
• image string nullable
• images array (default: [])
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• rating_five_count integer nullable
• rating_four_count integer nullable
• rating_three_count integer nullable
• rating_two_count integer nullable
• rating_one_count integer nullable
• availability_status string nullable
• is_in_stock boolean nullable
• description string nullable
• long_description string nullable
• features array (default: [])
• specifications array (default: [])
  • @type string (default: "WalmartProductSpecification")
  • name string required
  • value string nullable
• warranty string nullable
• breadcrumbs array (default: [])
• category string nullable
• product_type string nullable
• condition string nullable
• is_preowned boolean nullable
• badges array (default: [])
• return_policy object nullable
  • @type string (default: "WalmartProductReturnPolicy")
  • is_returnable boolean nullable
  • has_free_returns boolean nullable
  • return_window string nullable
  • text string nullable
• seller object nullable
  • @type string (default: "WalmartProductSeller")
  • id string nullable
  • catalog_id string nullable
  • name string nullable
  • type string nullable
  • rating number nullable
  • review_count integer nullable
• seller_count integer nullable
• variants array (default: [])
  • @type string (default: "WalmartProductVariant")
  • id string required
  • name string nullable
  • dimension string nullable
  • is_available boolean nullable
  • image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Product not found (well-formed but nonexistent itemId, or page has no product) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.