/petco/products/availability

POST /api/petco/products/availability

Price: 1 credit

Get in-store stock of a Petco product variant at the stores nearest to a US ZIP code: quantity on hand, stock level and the store's address and hours

How to use it

Stock is per variant, so pass the catalog entry id of one size or flavor from the Petco product endpoint or a search result, not the product id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• variant_id string required — Catalog entry id of a Petco product variant (examples: "2503505"; minLength: 1)
• zip_code string required — US ZIP code (examples: "92101"; minLength: 1)
• count integer required — Max number of stores to return (min: 1; max: 5)

Response

• @type string (default: "PetcoStoreAvailability")
• store_variant_id string required
• store_id string required
• variant_id string required
• stock_quantity integer nullable
• stock_level string nullable
• is_in_stock boolean nullable
• store object nullable
  • @type string (default: "PetcoStore")
  • id string required
  • location_id string nullable
  • name string nullable
  • store_format string nullable
  • address string nullable
  • address_line2 string nullable
  • city string nullable
  • state string nullable
  • zip_code string nullable
  • phone string nullable
  • latitude number nullable
  • longitude number nullable
  • distance_miles number nullable
  • time_zone string nullable
  • opened_date string nullable
  • district_id string nullable
  • is_pickup_available boolean nullable
  • is_curbside_available boolean nullable
  • services array (default: [])
  • hours array (default: [])
    • @type string (default: "PetcoHours")
    • day string required
    • opens_at string nullable
    • closes_at string 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 — The ZIP code does not resolve to a location, or no store stock is recorded for this variant id. 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.