X-Kom Product Search API Documentation Search the X-Kom catalog by query or by a numeric category id from the categories route. Each item has a numeric id, name, producer, category, PLN price and old price, discount, full-size image URL, 1 to 5 rating, review count, availability and feature summary. Page and page size are honoured, up to 100 items per page. Cost: 1 credit per successful request with results. Failed, empty and validation responses are not billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
4 optional filters available.
string
Optional
Search words (use this or category). Example: laptop.
coffee shops
string
Optional
Numeric category id from the categories route (use this or query). Example: 159.
example
integer
Optional
Page number from 1.
1
integer
Optional
Items per page, 1 to 100. Defaults to 100.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"items": [
{
"id": 1175277,
"name": "Laptop",
"image": "https://cdn.x-kom.pl/i/produkt/product-large.jpg",
"price": 649,
"rating": 4.79,
"category": {
"id": 159,
"name": "Laptopy"
},
"currency": "PLN",
"discount": 50,
"producer": "Apple",
"old_price": 699,
"availability": "Dost\u0119pny",
"rating_scale": "1-5",
"review_count": 389
}
],
"currency": "PLN",
"pagination": {
"has_next": true,
"per_page": 1,
"total_pages": 65,
"current_page": 1,
"total_results": 6403
}
},
"meta": {
"credits": 1,
"billable": true,
"endpoint_family": "search"
},
"success": true
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A query or category is missing or a filter is unsupported. Not billed.
{
"errors": {
"query": [
"Send the search words as query or a numeric category id."
]
},
"message": "The request validation failed"
}Upstream Unavailable
X-Kom could not be reached. Retry. Not billed.
{
"meta": {
"billable": false
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "X-Kom is temporarily unavailable. Please retry."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.