/menards/products/availability

POST /api/menards/products/availability

Price: 5 credits

Get a Menards product's stock at every Menards store, ordered by distance from a chosen store

How to use it

Returns stock of one Menards product at every store, nearest first from the store set by store_id or nearest to zip_code, with each store's address and distance in miles.

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")
• product string required — Menards product id, Menards SKU or product URL (examples: "1699697311812720", "2416837", "https://www.menards.com/main/building-materials/lumber-boards/dimensional-lumber/2-x-4-construction-framing-lumber/1021114/p-1444422740098-c-13125.htm"; minLength: 1)
• in_stock_only boolean — Only stores that have the product in stock (default: false)

Response

• @type string (default: "MenardsAvailability")
• id string required
• sku string nullable
• name string nullable
• url string nullable
• store_id string nullable
• stores array (default: [])
  • @type string (default: "MenardsStoreStock")
  • store_id string required
  • name string nullable
  • address string nullable
  • city string nullable
  • state string nullable
  • zip_code string nullable
  • distance number nullable
  • stock_message string nullable
  • stock_quantity integer nullable
  • is_in_stock boolean nullable
  • is_clearance boolean nullable
  • is_discontinued boolean nullable
  • is_seasonal boolean nullable
  • is_special_order boolean nullable
  • is_vendor_managed boolean nullable

Errors

• 422 — No Menards store has this number, or none was found for the ZIP code. 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 product has this id or SKU. 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.