/petsplace/brands/search

POST /api/petsplace/brands/search

Price: 20 credits

List and search the brands carried by Pets Place. Returns each brand with its name, page alias, the number of products available under it, its logo image, and the brand page URL. Filter by a keyword to narrow the list to brands whose name contains it, or leave the keyword empty to list every brand. Order by popularity (most products first) or by name.

How to use it

Brand catalog for Pets Place (NL). Each result has name (brand name), alias (brand page slug), product_count (number of catalog products under this brand), image (brand logo when available), and url (brand landing page). keyword does a case-insensitive substring match on the brand name; an empty keyword returns the full brand list. Sort by popularity (highest product_count first) or name.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string — Filter brands by name (case-insensitive substring). Leave empty to list all brands. (default: ""; examples: "royal", "trixie", "hill")
• count integer required — Max number of results to return (min: 1)
• sort string — Result ordering (default: "popularity"; one of: "popularity", "name")

Response

• @type string (default: "PetsplaceBrand")
• name string required
• alias string nullable
• product_count integer (default: 0)
• image string nullable
• url 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 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.