The endpoint

One endpoint for retail product data.

POST /api/products/search returns name, price, description, and images for each search term.

Request

Send JSON with the search terms. Add limit when you want more than one product for a term.

POST /api/products/search
curl -s -X POST https://api.productendpoint.tech/api/products/search \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d "{\"terms\":[\"yoga mat\"],\"limit\":1}"

Limits

  • terms is required and holds 1 to 10 strings.
  • Each term must contain text after trimming.
  • limit is optional. It is an integer from 1 to 5.
  • When limit is omitted, the API uses 1.

Response fields

results follows the order of the terms you sent. Each product includes these fields. Sample URLs in the docs are placeholders. Prices in current responses are USD.

name Product name
price Numeric price
currency Currency code. Current responses use USD.
description Description text
images List of image URLs
url Product page URL

Cache

A successful lookup is saved and can be reused for about 24 hours. The term is matched after it is trimmed, lowercased, and collapsed to single spaces. A failed lookup is not saved.

A cached call returns the products stored for that term. Asking for a larger limit later still returns that stored set until the cache expires.

Auth

Every call needs an API key from the portal. Send it in either header.

Authorization: Bearer YOUR_API_KEY
X-API-Key: YOUR_API_KEY