products

Product search against Online via cache and upstream providers

Search Online products by terms

POST

https://product-searchandretrieve-main-9089129.zuplo.app

/api/products/search

Accepts 1–10 search terms and an optional per-term product limit. Important: A failed provider lookup for an individual term is not an HTTP error. The response is still 200 with that term's source set to null, products empty, and a human-readable error string on the result object. Multi-term requests can therefore be partially successful.

Search Online products by terms › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Search Online products by terms › Request Body

SearchRequest

terms

string[] · minItems: 1 · maxItems: 10 · required

Search terms (1–10). Each item must be a non-empty string after trim. The server trims whitespace before searching.

Example: {"0":"yoga mat","1":"resistance bands"}

limit

integer · min: 1 · max: 5

Maximum products to return per term. Defaults to 1 when omitted. Note: limit is not part of the cache key; a higher later limit only returns what that cached batch stored.

Example: 1

Default: 1

Search Online products by terms › Responses

Search completed. Each entry in results corresponds to one input term in order. Individual terms may have failed (source: null) while others succeeded.

SearchResponse

TermResult[] · required

One result object per input term, in the same order

POST/api/products/search

curl https://product-searchandretrieve-main-9089129.zuplo.app/api/products/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "terms": [
    "yoga mat"
  ]
}'

Example Request Body

{
  "terms": [
    "yoga mat"
  ]
}

json

application/json

Example Responses

{
  "results": [
    {
      "term": "yoga mat",
      "source": "cache",
      "cachedFrom": "vendor_a",
      "fetchedAt": "2026-08-20T14:02:11.000Z",
      "products": [
        {
          "name": "Gaiam Yoga Mat",
          "price": 24.99,
          "currency": "USD",
          "description": "Extra thick non-slip yoga mat for home workouts.",
          "images": [
            "https://m.shopnline.com/images/I/example.jpg"
          ],
          "url": "https://www.shoponline.com/dp/B00EXAMPLE"
        }
      ]
    }
  ]
}

json

application/json

health