/petco/products

POST /api/petco/products

Price: 20 credits

Get a Petco product: every size or flavor variant with prices, Repeat Delivery prices, online stock, ingredients, specifications and images, plus rating statistics and the review summary

How to use it

Pass the product id from Petco search or category results, or a product URL. Prices and flags are per variant, so read the variant marked selected or pick one by its attributes. Use the catalog entry id of a variant for store availability.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Petco product id or product URL (examples: "5030043", "https://www.petco.com/product/taste-of-the-wild-pacific-stream-grain-free-dry-dog-food-with-smoked-salmon-28-lbs-2998871"; minLength: 1)

Response

• @type string (default: "PetcoProduct")
• id string required
• name string nullable
• url string nullable
• brand string nullable
• description string nullable
• image string nullable
• selected_variant_id string nullable
• rating number nullable
• review_count integer nullable
• text_review_count integer nullable
• ratings_only_review_count integer nullable
• recommended_count integer nullable
• not_recommended_count integer nullable
• review_photo_count integer nullable
• question_count integer nullable
• answer_count integer nullable
• first_review_at integer nullable
• last_review_at integer nullable
• review_summary string nullable
• rating_distribution array (default: [])
  • @type string (default: "PetcoRatingCount")
  • rating integer required
  • count integer required
• is_pickup_available boolean nullable
• is_shipping_available boolean nullable
• is_same_day_available boolean nullable
• is_live_animal boolean nullable
• categories array (default: [])
  • @type string (default: "PetcoCategory")
  • id string required
  • name string nullable
  • url string nullable
• variants array (default: [])
  • @type string (default: "PetcoVariant")
  • catalog_entry_id string required
  • sku string nullable
  • name string nullable
  • alias string nullable
  • url string nullable
  • upc string nullable
  • price number nullable
  • list_price number nullable
  • repeat_delivery_price number nullable
  • repeat_delivery_first_order_price number nullable
  • pickup_price number nullable
  • stock_status string nullable
  • stock_quantity integer nullable
  • dimensions string nullable
  • taxonomy string nullable
  • pet_type string nullable
  • pdp_template string nullable
  • description string nullable
  • details array (default: [])
  • ingredients array (default: [])
  • guaranteed_analysis array (default: [])
  • directions string nullable
  • warnings array (default: [])
  • vitamins_and_supplements array (default: [])
  • attributes array (default: [])
    • @type string (default: "PetcoAttribute")
    • name string required
    • value string required
  • specifications array (default: [])
    • @type string (default: "PetcoSpecification")
    • group string nullable
    • name string required
    • value string required
  • images array (default: [])
  • is_selected boolean nullable
  • is_discontinued boolean nullable
  • is_recalled boolean nullable
  • is_pickup_eligible boolean nullable
  • is_pickup_restricted boolean nullable
  • is_same_day_delivery_eligible boolean nullable
  • is_repeat_delivery_eligible boolean nullable
  • is_online_only boolean nullable
  • is_in_store_only boolean nullable
  • is_special_delivery boolean nullable
  • is_freight boolean nullable
  • is_frozen boolean nullable
  • is_live_food boolean nullable
  • is_rx boolean nullable
  • is_rx_food boolean nullable
  • is_personalized boolean nullable
  • is_restricted boolean nullable
  • is_grain_free boolean nullable
  • is_all_natural boolean nullable
  • is_holistic boolean nullable
  • is_organic boolean nullable
  • is_vegetarian boolean nullable
  • is_limited_ingredients 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 — No Petco product has this id or URL. 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.