API Referencev2

Products (v2)

POST /v2/products — Legacy JSON-body product search.

POST https://api.pricehero.ai/v2/products

Legacy. Prefer v3 catalog search for new integrations.

Transitional endpoint: same catalog logic as v1, but parameters are sent as a JSON body instead of the query string.

Request

curl -X POST https://api.pricehero.ai/v2/products \
  -H "Authorization: Bearer ph_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "search": "Louis Vuitton Speedy",
    "category": "handbags,watches",
    "attribute": "product",
    "model": "model_abc,model_def",
    "style": "style_xyz",
    "page": 0,
    "page_size": 15
  }'

Body parameters

ParameterTypeDefaultDescription
searchstringFree-text search
attributestringproductWhich taxonomy node rows to return: product, model, style, brand, category, family, case, or dial. Drives search filtering. Invalid values fall back to product.
pagenumber0Page index (0-based)
page_sizenumber15Page size (max 100)

Optional attribute facets

Use top-level JSON properties to narrow results. Catalog attributes (brand, model, style, family, case, dial, …) follow the same OR within a field, AND across fields rules as v3 catalog search.

  • category — Comma-separated category names or IDs that scope the search. Omit to use the default handbags,watches.

Other attribute keys depend on the category (e.g. handbags: brand, model, style, family; watches often add case, dial). Values are comma-separated entity ids where multiple ids mean OR within that field.

{
  "category": "handbags,watches",
  "brand": "brand_R7xVn3LpQ2sK8mTzH5YwE9aU4FbG1JdC6uN",
  "model": "model_abc,model_def",
  "style": "style_xyz",
  "case": "case_aaa,case_bbb",
  "dial": "dial_xyz"
}

Your API key must allow v2 (or v1). A 403 is returned if the key cannot access v2.

Response

Same envelope and product shape as v1: success, data, search, results, total_results, page, total_pages, stats. See Products (v1) for a representative JSON example.

Credits: catalog + pricing modules per successful billable response — see Credits.

Products (v2) — Price Hero Docs