/menards/products/search

POST /api/menards/products/search

Price: 20 credits

Search Menards products by keyword with store price and stock, brand, price, category and attribute filters

How to use it

Search the Menards catalogue by keyword; price and stock are those of the store set by store_id, or of the store nearest to zip_code. attributes takes any other filter by the name Menards shows on its listings. Pass a returned id to the Menards product endpoint for specifications, accessories, questions and aisle location.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• store_id string nullable — Menards store number that sets price and stock (examples: "3053", "3378")
• zip_code string nullable — US ZIP code; the nearest Menards store sets price and stock (examples: "54701")
• count integer required — Max number of products to return (min: 1; max: 5000)
• sort string — Result ordering (default: "best_match"; one of: "best_match", "price_low_to_high", "price_high_to_low")
• brands array nullable — Brand names (examples: ["Bosch"], ["Bosch","SKIL"])
• min_price number nullable — Minimum list price in USD (min: 0)
• max_price number nullable — Maximum list price in USD (>: 0)
• in_stock_today boolean — Only products in stock at the store today (default: false)
• on_sale boolean — Only sale-priced products (default: false)
• attributes object nullable — Other filters as shown on Menards listings: filter name to accepted values (examples: {"Power Source":["Cordless"]}, {"Availability Options":["Delivery Eligible"]})
  • * array
• query string required — Search keywords (examples: "cordless drill", "ceiling fan"; minLength: 1)
• category_id string nullable — Menards category id to search within (examples: "13067", "9072")

Response

• @type string (default: "MenardsListingProduct")
• id string required
• sku string nullable
• model_number string nullable
• url string nullable
• name string nullable
• image string nullable
• hover_image string nullable
• price number nullable
• price_label string nullable
• price_note string nullable
• unit string nullable
• sale_price number nullable
• list_price number nullable
• rebate_amount number nullable
• is_limited_time boolean nullable
• price_steps array (default: [])
  • @type string (default: "MenardsPriceStep")
  • label string required
  • price number nullable
  • note string nullable
• badge string nullable
• vendor_code string nullable
• category_id string nullable
• store_id string nullable
• position integer nullable
• variant_count integer nullable
• variants array (default: [])
  • @type string (default: "MenardsVariantRef")
  • id string required
  • name string nullable
  • image string nullable
• promotions array (default: [])
• is_available boolean nullable
• has_delivery boolean nullable
• has_pickup boolean nullable
• delivery_message string nullable
• pickup_message string nullable
• stock_message string nullable
• stock_quantity integer nullable
• minimum_quantity integer nullable
• increment_quantity integer nullable

Errors

• 422 — The store, ZIP code or a filter value does not apply, or the query is a Menards SKU. 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 — No Menards category has this category_id. 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.