/petco/products/search

POST /api/petco/products/search

Price: 20 credits

Search Petco products by text with sorting and the site's filters, returning prices, Repeat Delivery prices, ratings, fulfilment flags and variants

How to use it

Search the Petco catalogue by text. Filter names and option labels are the ones on the Petco results page and depend on the query; an unknown one is rejected with the available choices, so pass one of those. Pass a returned id to the Petco product endpoint for full variant details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of products to return (min: 1; max: 10000)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "newest", "name_asc", "name_desc", "price_desc", "price_asc", "rating", "best_selling")
• filters array nullable — Filters from the Petco results sidebar; options of one filter match any of them, different filters combine (examples: [{"facet":"Brand","value":"Blue Buffalo"},{"facet":"Lifestage","value":"Puppy"}], [{"facet":"Price","value":"$25-$50"},{"facet":"Customer Rating","value":"5"}])
  • facet string required — Filter name as shown on Petco (examples: "Brand"; minLength: 1)
  • value string required — Option label as shown on Petco (examples: "Puppy"; minLength: 1)
• query string required — Search text (examples: "dog food", "cat litter"; minLength: 1)

Response

• @type string (default: "PetcoListingProduct")
• id string required
• sku string nullable
• catalog_entry_id string nullable
• name string nullable
• url string nullable
• brand string nullable
• description string nullable
• image string nullable
• price number nullable
• list_price number nullable
• repeat_delivery_price number nullable
• rating number nullable
• review_count integer nullable
• taxonomy string nullable
• pdp_template string nullable
• is_pickup_eligible boolean nullable
• is_same_day_delivery_eligible boolean nullable
• is_repeat_delivery_eligible boolean nullable
• is_in_store_only boolean nullable
• is_personalized boolean nullable
• is_rx_food boolean nullable
• is_sponsored boolean nullable
• category_ids array (default: [])
• attributes array (default: [])
  • @type string (default: "PetcoAttribute")
  • name string required
  • value string required
• variants array (default: [])
  • @type string (default: "PetcoListingVariant")
  • sku string required
  • catalog_entry_id string nullable
  • name string nullable
  • url string nullable
  • image string nullable
  • price number nullable
  • list_price number nullable
  • repeat_delivery_price number nullable
  • attributes array (default: [])
    • @type string (default: "PetcoAttribute")
    • name string required
    • value string required

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.