YOOX API endpoint
Searches or browses YOOX products in the required `department`. Optional filters are `q`, `category`, `designer`, `color`, `size`, `price_min`, `price_max` and `on_sale`; `sort` takes `relevance`, `newest`, `price_asc`, `price_desc` or `discount`; `limit` is 1 to 100. Each product has brand, name, price, currency, stock status, image and URL, with `facets` for colors, sizes and sorts. May return `503`.
/yoox/searchSearches or browses YOOX by required department (women, men, or kids) with optional q, category, designer, color, size, price_min, price_max, on_sale, sort, page, and limit. Sort values are relevance, newest, price_asc, price_desc, and discount. Requires x-api-key. YOOX pages are Akamai-protected and may return 503 when the render fleet cannot clear the challenge.
Notable response behavior:
503 rather than timing out.503 with a message saying so. Retry later.503, never an empty result.| Field | Filled in, of 60 checked | Values in the sample |
|---|---|---|
| id | 60 | |
| url | 60 | yoox.com |
| name | 60 | “Clutches” and 32 other values |
| brand | 60 | “THEMOIRè” and 37 other values |
| image_url | 60 | yoox.com |
| price | 60 | 57 to 2,264, median 323 |
| currency | 60 | USD in all 60 |
| in_stock | 60 | true in 60 of 60 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| department | string | Yes | Department Allowed values: women, men, kids. | women | |
| q | string | No | Free-text search | ||
| category | string | No | Category slug from yoox-categories | ||
| designer | string | No | Designer slug from yoox-designers | ||
| color | string | No | Color filter | ||
| size | string | No | Size filter | ||
| price_min | number | No | Minimum price | ||
| price_max | number | No | Maximum price | ||
| on_sale | boolean | No | Sale items only | ||
| sort | string | No | Sort Allowed values: relevance, newest, price_asc, price_desc, discount. | ||
| page | integer | No | 1-based page Minimum: 1. | ||
| limit | integer | No | Results per page Minimum: 1. Maximum: 100. | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/yoox/search?department=women&q=coffee&on_sale=true&sort=relevance&page=1&limit=10" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"department": "women",
"query": "gucci",
"page": 1,
"limit": 48,
"count": 1,
"products": [
{
"id": "123456",
"name": "Gucci handbag",
"brand": "Gucci",
"price": 950,
"currency": "USD",
"in_stock": true
}
]
}
}Request schema
No body schema
Response schema
#/definitions/yoox.searchDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | yoox.SearchResponse | No | ||||
| data.count | integer | No | ||||
| data.department | string | No | ||||
| data.facets | yoox.Facets | No | ||||
| data.facets.colors | array | No | ||||
| data.facets.sizes | array | No | ||||
| data.facets.sorts | array | No | ||||
| data.limit | integer | No | ||||
| data.page | integer | No | ||||
| data.products | array | No | ||||
| data.products[].brand | string | No | ||||
| data.products[].currency | string | No | ||||
| data.products[].id | string | No | ||||
| data.products[].image_url | string | No | ||||
| data.products[].in_stock | boolean | No | ||||
| data.products[].name | string | No | ||||
| data.products[].price | number | No | ||||
| data.products[].url | string | No | ||||
| data.query | string | No | ||||
| data.source_url | string | No | ||||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/yoox/search?department=women&q=coffee&on_sale=true&sort=relevance&page=1&limit=10" \
-H "x-api-key: $CRAWLORA_API_KEY"