Piloterr

About You Product

GET
/v2/aboutyou/product

Read one About You product from a product URL or a keyword. A keyword opens the first search hit. Set region when the query does not already name the shop.

Credit cost: 2 credits per call

Autorisierung

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Abfrageparameter

query*string

Product URL or keyword. A keyword opens the first search result.

region?string

Shop code. Default is fr. A full link in query picks the shop, and a conflicting region returns 400.

Examples:

fr
de
ch-fr

The full list is the Shops table in the readme.

return_page_source?boolean

Return the rendered HTML instead of JSON.

fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Antworttext

Successful response

application/json
  1. response
id?integer
url?string
name?string
brand?string
color?string
image?string
price?number
region?string
currency?string
in_stock?boolean
price_display?string
article_number?string
original_price?number
original_price_display?string
Example Request
curl -X GET 'https://api.piloterr.com/v2/aboutyou/product?query=string'
Example Response
{  "id": 32191359,  "url": "https://www.aboutyou.fr/p/puma/baskets-basses-suede-bloom-32191359",  "name": "Baskets basses 'Suede Bloom'",  "brand": "PUMA",  "color": "rose",  "image": "https://cdn.aboutstatic.com/file/images/f69d3161a57ca8a8aff626a5acc399bf.jpg?brightness=0.96&quality=75&trim=1",  "price": 69.9,  "region": "fr",  "currency": "EUR",  "in_stock": true,  "price_display": "69,90 €",  "article_number": "PUMliff008000002",  "original_price": 89.9,  "original_price_display": "89,90 €"}