/acehardware/stores/search

POST /api/acehardware/stores/search

Price: 20 credits

Find Ace Hardware stores around a point, nearest first, with address, hours and pickup options

How to use it

Returns Ace Hardware stores within radius_km of a latitude and longitude, nearest first, each with its distance. A returned id is the store_id that sets store prices and stock on the product endpoints.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of stores to return (min: 1; max: 5000)
• latitude number required — Latitude of the search centre (examples: 41.8781; min: -90; max: 90)
• longitude number required — Longitude of the search centre (examples: -87.6298; min: -180; max: 180)
• radius_km number — Search radius in kilometres (default: 50; max: 20000; >: 0)

Response

• @type string (default: "AcehardwareStore")
• id string required
• name string nullable
• display_name string nullable
• address string nullable
• address_2 string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• country string nullable
• latitude number nullable
• longitude number nullable
• distance_km number nullable
• phone string nullable
• fax string nullable
• email string nullable
• contact_name string nullable
• timezone string nullable
• hours array (default: [])
  • @type string (default: "AcehardwareStoreHours")
  • day string required
  • open_time string nullable
  • close_time string nullable
  • is_closed boolean nullable
  • label string nullable
• fulfillment_types array (default: [])
• location_types array (default: [])
• has_curbside_pickup boolean nullable
• has_in_store_pickup boolean nullable
• has_limited_access boolean nullable
• has_third_party_delivery boolean nullable
• has_paid_delivery_radius boolean nullable
• same_day_delivery string nullable
• delivery_radius number nullable
• delivery_surcharge_per_mile number nullable
• nearest_store_ids array (default: [])
• distribution_center_ids array (default: [])
• is_disabled boolean nullable
• description string nullable
• owner_name string nullable
• manager_name string nullable
• website_url string nullable
• store_page_url string nullable
• handyman_services_url string nullable
• paint_services_url string nullable
• parent_store_id string nullable
• is_branch_store boolean nullable
• is_locator_only boolean nullable
• services array (default: [])
• created_at integer nullable
• updated_at integer nullable
• details_updated_at integer nullable

Errors

• 422 — The coordinates or radius are out of range. 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 — The entity was not found, or a precondition failed 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.