/upcitemdb/products/search

POST /api/upcitemdb/products/search

Price: 20 credits

Search products by keyword, brand, category, product title or model number

How to use it

Find barcodes for products you can only name. At least one of `query` or `brand` is required; `category`, `product_title` and `model` only narrow a search that already has one of those, and each returns an empty list when nothing matches it. `catalog=book` searches a separate ISBN catalogue whose records carry `isbn` and `publisher` instead of `upc`. To go the other way — a barcode you already hold to its product — use `/upcitemdb/products`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string — Free-text query matched against the whole product record (default: ""; examples: "iphone 16 case", "kitchenaid stand mixer")
• brand string — Restrict to one brand (default: ""; examples: "Apple", "Kellogg's")
• category string — Restrict to one product category (default: ""; examples: "Cell Phones", "Grocery")
• product_title string — Restrict to products whose title contains this text (default: ""; examples: "case", "wireless")
• model string — Restrict to one manufacturer model number (default: ""; examples: "1101-4303-GN")
• catalog string — Which catalogue to search: general merchandise or books (default: "product"; one of: "product", "book"; examples: "product")
• count integer required — Max number of products to return (examples: 20; min: 1; max: 500)

Response

• @type string (default: "UpcitemdbProduct")
• ean string (default: "")
• upc string (default: "")
• isbn string (default: "")
• asin string (default: "")
• elid string (default: "")
• product_title string (default: "")
• description string (default: "")
• brand string (default: "")
• model string (default: "")
• publisher string (default: "")
• category string (default: "")
• color string (default: "")
• size string (default: "")
• dimension string (default: "")
• weight string (default: "")
• currency string (default: "")
• lowest_recorded_price number nullable
• highest_recorded_price number nullable
• images array (default: [])
• offers array (default: [])
  • @type string (default: "UpcitemdbOffer")
  • merchant string (default: "")
  • domain string (default: "")
  • listing_title string (default: "")
  • condition string (default: "")
  • availability string (default: "")
  • currency string (default: "")
  • price number nullable
  • list_price number nullable
  • shipping string (default: "")
  • link string (default: "")
  • updated_at integer (default: 0)

Errors

• 422 — The request body did not validate 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.