Get search products results
Use this resource to get a list of products according to provided parameters. At least ean or phrase parameter is required. Read more: <a href="../../tutorials/jak-jednym-requestem-wystawic-oferte-powiazana-z-produktem-D7Kj9gw4xFA#jak-znalezc-produkt" target="_blank">PL</a> / <a href="../../tutorials/list-offer-assigned-product-one-request-D7Kj9M71Bu6#how-to-find-a-product" target="_blank">EN</a>. This resource is limited with Leaky Bucket mechanism, read more <a href="../../tutorials/informacje-podstawowe-b21569boAI1#ograniczenie-liczby-zapytan-limity" target="_blank">PL</a> / <a href="../../tutorials/basic-information-VL6YelvVKTn#limiting-the-number-of-queries-limits" target="_blank">EN</a>.
Request
- Base URL: https://api.allegro.pl
- URL: https://api.allegro.pl/sale/products
- Auth: OAuth 2 (authorization code, authorization URL https://allegro.pl/auth/oauth/authorize, token URL https://allegro.pl/auth/oauth/token, scopes: allegro:api:sale:offers:read)
Query parameters
Search phrase.
Search mode. If not specified, we are searching by GTIN, MPN, product's name, parameters, etc.
- GTIN - restricts the search filtering to GTINs (Global Trade Item Number), e.g. EAN, ISBN, UPC.
- MPN - restricts the search filtering to MPNs (Manufacturer Part Number).
Language indicates the language for searching products. Allows to specify the language of the given phrase.
The category identifier to filter results. This can only be used when searching by phrase.
You can filter and customize your search results to find exactly what you need by applying filters ids and their dictionary values to query according to the flowing pattern: id=value. When the filter definition looks like:
{
"id": "127448",
"name": "Kolor",
"type": "SINGLE",
"values": [
{
"name": "biały",
"value": "127448_2"
},
{
"name": "czarny",
"value": "127448_1"
}
]
}
You can use 'Kolor' filter to query results, i.e.:
- 127448=127448_2 for "biały"
- 127448=127448_1 for "czarny".
A "cursor" to the next set of results.
Enables additional search options: - SIMILAR_CATEGORIES - searching in the indicated category (category.id) and in 'similar categories' (works only if category.id is a leaf category).
Headers
Expected language of messages.
Response
Successful operation.
Changes
No recorded changes to this operation across all 1 revision of this API.