/costco/categories/products

POST /api/costco/categories/products

Price: 5 credits

List Costco products in a category (by URL slug): title, brand, model, price, list price, savings, image, rating and review count, features, badges and program types.

How to use it

List Costco products within a category, identified by its URL slug (e.g. 'whole-bean-coffee') or a category page URL. Returns products with id, title, brand, model, price, list_price, is_on_sale, image, rating, rating_count, categories, features, badges, promotion and program_types.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string required — Costco category URL slug or a category page URL (examples: "whole-bean-coffee", "https://www.costco.com/ground-coffee.html"; minLength: 1)
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "CostcoSearchProduct")
• id string required
• url string nullable
• brand string nullable
• model string nullable
• price number nullable
• list_price number nullable
• currency string nullable
• is_on_sale boolean nullable
• image string nullable
• rating number nullable
• rating_count integer nullable
• categories array (default: [])
• category string nullable
• alias string nullable
• features array (default: [])
• badges array (default: [])
• promotion string nullable
• program_types array (default: [])
• is_buyable boolean nullable
• is_member_only boolean nullable

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 — Category not found (no products for the given slug) 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.