/acehardware/products/availability

POST /api/acehardware/products/availability

Price: 1 credit

Get an Ace Hardware product's stock at a store, with ship-to-home and ship-to-store quantities

How to use it

Returns how many units of one Ace Hardware product the store set by store_id holds and where in the store, plus the quantities available to ship to a home or to that store. Store numbers come from the Ace Hardware store search endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Ace Hardware product id or product URL (examples: "2835460", "https://www.acehardware.com/departments/tools/hand-tools/claw-hammers/2835460"; minLength: 1)
• store_id string required — Ace Hardware store number (examples: "09861", "18244")

Response

• @type string (default: "AcehardwareAvailability")
• id string required
• name string nullable
• store_id string required
• store_quantity integer nullable
• is_in_stock_at_store boolean nullable
• store_location string nullable
• ship_to_home_quantity integer nullable
• ship_to_store_quantity integer nullable
• distribution_center_ids array (default: [])
• distribution_center_location string nullable

Errors

• 422 — No Ace Hardware store has this store number. 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 Ace Hardware product has this 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.