# Ace Hardware API

> Ace Hardware departments, products, prices and store stock (unverified)

- Vendor: `acehardwareapi` · version 1.0 · category E-commerce · tags ace hardware api, acehardware api, hardware store api, home improvement api, ace product data api, ace store inventory api
- Datasource: custom HTTP routes
- Marketplace page: https://apiclay.com/api/acehardwareapi
- This document: https://apiclay.com/docs/acehardwareapi.md
- OpenAPI 3.1: https://apiclay.com/api/acehardwareapi/openapi.json
- MCP: connect https://api.apiclay.com/v1/mcp (see https://apiclay.com/llms.txt), then `apiclay_describe_api` with vendor `acehardwareapi`
- Updated: 2026-11-09

## About

## Ace Hardware API

Ace Hardware's department tree, store records, category product pages, catalog details with prices, and per-store stock, from the endpoints behind acehardware.com.

Data comes from **acehardware.com** (https://www.acehardware.com). Every route below calls the site's own endpoint directly and returns the upstream response unchanged.

Typical flow: `/menus` -&gt; `/categories` -&gt; `/products` -&gt; `/product` -&gt; `/inventory` (store codes via `/stores`)

### Routes

#### POST `/menus` - Menus (department tree)
The whole category tree, five levels deep. Departments are the children of the root item named `Departments`.

No parameters.

Returns (fields the source code reads; not yet verified live):
- `data.categoriesTree.items[]`: root items; the one with `content.name` = `Departments` holds the departments (`Brands` holds brand nodes)
- `...childrenCategories[]`: `categoryId`, `categoryCode`, `isDisplayed`, `content.name`, `content.slug` (category page path for `/products`), nested `childrenCategories`

#### POST `/categories` - Categories (subcategory tree)
The same tree as `/menus`. Find a department by `content.slug` and walk its `childrenCategories` down to the leaves.

No parameters.

Returns (fields the source code reads; not yet verified live):
- `data.categoriesTree.items[].childrenCategories[]...`: `categoryId`, `content.name`, `content.slug`, `isDisplayed`

#### GET `/stores` - Stores (store record by code)
One store's record.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | string | yes | Filter on the store code, e.g. `code eq 11232`. |

Returns (fields the source code reads; not yet verified live):
- `items[].code`, `items[].name`
- `items[].address`: `address1`, `cityOrTown`, `stateOrProvince`, `postalOrZipCode`, `countryCode`
- `items[].geo.lat`, `items[].geo.lng`
- `items[].fulfillmentTypes[].code`: `SP` (store pickup), `DL` (delivery)
- `items[].attributes[]`: e.g. `tenant~nearest-locations`

#### GET `/products` - Products (category page, HTML)
A category's product listing page (HTML).

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| category_path | path | string | yes | Category page path (`content.slug` from `/menus` or `/categories`), e.g. `departments/home-and-decor/novelty-items/lighters/66880`. |
| pageSize | query | string | no | Products per page. The page title says "(N items found)"; pass N to get them all. |

Returns (HTML; elements the source code reads):
- `li.mz-productlist-item`: one product, with attributes `data-mz-product` (product code), `data-price`, `data-discount`
- `a.mz-productlisting-title`: product name; `div.mz-productlisting-image a`: product link and image
- `h1.mz-pagetitle`: title with the item count

#### GET `/product` - Product (catalog details and price)
Catalog records for one or more product codes.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | string | yes | `productCode eq <code>`; join several with ` or `, e.g. `productCode eq  or productCode eq `. Codes come from `/products`. |
| pageSize | query | string | no | Results per page, e.g. `10` (one product) or `250` (bulk lookup). |
| x-vol-purchase-location | header | string | yes | Store code, e.g. `11232`. |

Returns (fields the source code reads; not yet verified live):
- `items[].productCode`, `items[].upc`
- `items[].content.productName`, `content.productFullDescription`, `content.productImages[].imageUrl`
- `items[].price.price`, `items[].price.salePrice`
- `items[].properties[]`: attributes; `tenant~delivery-flag` = `Y` when the item can be delivered

#### POST `/inventory` - Inventory (one product at one store)
Store and warehouse stock for one product.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | body (JSON) | string | yes | Product code from `/products`. |
| storeCode | body (JSON) | string | yes | Store code, e.g. `11232`. |
| quantity | body (JSON) | number | no | Quantity to check, e.g. `1`. |
| x-vol-purchase-location | header | string | yes | Same store code. |

Returns (fields the source code reads; not yet verified live):
- `storeInventory.stockAvailable`: units at the store (pickup and delivery)
- `rscInventory.stockAvailable`: units in the regional warehouse (shipping)

#### POST `/availability` - Availability (stock for many products)
Stock for a list of products at a list of stores.

| Param | In | Type | Required | Description |
|---|---|---|---|---|
| productCodes | body (JSON) | array | yes | Up to 200 product codes from `/products`. |
| locationCodes | body (JSON) | array | yes | Store codes, e.g. `["11232"]`. |

Returns (fields the source code reads; not yet verified live):
- `items[]`: `productCode`, `locationCode`, `stockAvailable`

### Not yet available

| Endpoint | Why |
|---|---|
| store prices on `/products` | the site reads the store from a `myStore` cookie built from the store record; not included, so the page shows default prices |
| store selection (`location/set`) | sets the store on the site session; `/stores` returns the same store record |

### Caveats

- These routes were written from MealMe's source code and have not been tested live yet (the site blocks plain requests from the test machine).
- The source site uses bot protection (Cloudflare challenge); calls may be blocked until that is handled.
- Upstream calls change over time (embedded keys, field names). Verify responses before relying on them.
- Not affiliated with acehardware.com or Ace Hardware Corporation.</code>

## Pricing

- Pay as you go: 0.01 credits/request
- Trial: 1 free requests per buyer
- Billing order: trial requests -> subscribed plan requests -> pay as you go. 1 credit's USD value is shown on the marketplace page.

## HTTP routes

Only the public, buyer-facing parts of each route are listed; vendor-side credentials stay on the gateway.

### POST /menus — Menus (department tree)
- Gateway: `POST https://api.apiclay.com/v1/api/acehardwareapi/menus`
- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /categories — Categories (subcategory tree)
- Gateway: `POST https://api.apiclay.com/v1/api/acehardwareapi/categories`
- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### GET /stores — Stores (store record by code)
- Gateway: `GET https://api.apiclay.com/v1/api/acehardwareapi/stores`
- Public query params: `filter` (string, required)
- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### GET /products — Products (category page, HTML)
- Gateway: `GET https://api.apiclay.com/v1/api/acehardwareapi/products`
- Public query params: `pageSize` (string), `category_path` (string, required)
- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### GET /product — Product (catalog details and price)
- Gateway: `GET https://api.apiclay.com/v1/api/acehardwareapi/product`
- Public headers: `x-vol-purchase-location` (required)
- Public query params: `pageSize` (string), `filter` (string, required)
- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /inventory — Inventory (one product at one store)
- Gateway: `POST https://api.apiclay.com/v1/api/acehardwareapi/inventory`
- Public headers: `x-vol-purchase-location` (required)
- Body sample (JSON):

```json
{"productCode": "7001407", "storeCode": "11232", "quantity": 1}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 10 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

### POST /availability — Availability (stock for many products)
- Gateway: `POST https://api.apiclay.com/v1/api/acehardwareapi/availability`
- Body sample (JSON):

```json
{"productCodes": ["7001407"], "locationCodes": ["11232"]}
```

- Upstream proxy: ApiClay proxy paid by the vendor (data cap 2 MB per call). Fetched through an ApiClay proxy paid by the vendor; a response larger than the route's data cap fails with 502 and is refunded in full.

## Call example

```bash
curl -X POST "https://api.apiclay.com/v1/api/acehardwareapi/menus" \
  -H "token: <YOUR_APICLAY_TOKEN>"
```

Index of every published API: https://apiclay.com/llms.txt
