This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried.
The Search API supports the document types listed in the Introduction, each with its own schema. These schemas define the fields available for filtering, sorting, and free-text searching.
To learn more about working with the search query, see API Query Language and Sorting and Paging.
Search query and aggregation information.
Document type to search in.
Language to search in.
Documents matching the search query.
Aggregated data.
Paging metadata.
curl -X POST \
'https://www.wixapis.com/_api/site-search/v1/search' \
-H 'Content-type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"documentType": "STORES_PRODUCTS",
"search": {
"aggregations": [],
"sort": [],
"search": {
"fields": [],
"expression": "game"
},
"paging": {
"limit": 3
}
}
}'
{
"siteDocumentItems": [
{
"id": "5818aa78-849d-237c-6639-d2af6ba0d8f1",
"data": {
"_score": 149.54732,
"_updated": "2024-04-14T13:22:47.783Z",
"collections": ["Games"],
"currency": "EUR",
"description": "I'm a product description. This is a great place to "sell" your product and grab buyers' attention. Describe your product clearly and concisely. Use unique keywords. Write your own description instead of using manufacturers' copy.",
"discountedPrice": "€39.99",
"discountedPriceNumeric": 39.99,
"documentImage": {
"height": 9080,
"name": "c837a6_0fc432ddbaa847358c7d2598829b08e8~mv2.jpg",
"width": 9156
},
"documentType": "public/stores/products",
"id": "5818aa78-849d-237c-6639-d2af6ba0d8f1",
"inStock": true,
"infoSections": [
"Product Info",
"<p>I'm a product detail. I'm a great place to add more information about your product such as sizing, material, care and cleaning instructions. This is also a great space to write what makes this product special and how your customers can benefit from this item. Buyers like to know what they’re getting before they purchase, so give them as much information as possible so they can buy with confidence and certainty.</p>\n",
"Return and Refund Policy",
"<p>I’m a Return and Refund policy. I’m a great place to let your customers know what to do in case they are dissatisfied with their purchase. Having a straightforward refund or exchange policy is a great way to build trust and reassure your customers that they can buy with confidence.</p>\n",
"Shipping Info",
"<p>I'm a shipping policy. I'm a great place to add more information about your shipping methods, packaging and cost. Providing straightforward information about your shipping policy is a great way to build trust and reassure your customers that they can buy from you with confidence.</p>\n"
],
"onSale": false,
"sku": "0026",
"title": "Cyber Kid Infinite",
"url": "/product-page/cyber-kid-infinite"
}
},
{
"id": "b35a1597-da0f-9382-3162-e4ea5d4048fd",
"data": {
"_score": 149.54732,
"_updated": "2024-04-14T13:22:47.783Z",
"collections": ["Games"],
"currency": "EUR",
"description": "I'm a product description. This is a great place to "sell" your product and grab buyers' attention. Describe your product clearly and concisely. Use unique keywords. Write your own description instead of using manufacturers' copy.",
"discountedPrice": "€35.99",
"discountedPriceNumeric": 35.99,
"documentImage": {
"height": 9080,
"name": "c837a6_1fced547ddff4698a820b04cbf4e7622~mv2.jpg",
"width": 9156
},
"documentType": "public/stores/products",
"id": "b35a1597-da0f-9382-3162-e4ea5d4048fd",
"inStock": true,
"infoSections": [
"Product Info",
"<p>I'm a product detail. I'm a great place to add more information about your product such as sizing, material, care and cleaning instructions. This is also a great space to write what makes this product special and how your customers can benefit from this item. Buyers like to know what they’re getting before they purchase, so give them as much information as possible so they can buy with confidence and certainty.</p>\n",
"Return and Refund Policy",
"<p>I’m a Return and Refund policy. I’m a great place to let your customers know what to do in case they are dissatisfied with their purchase. Having a straightforward refund or exchange policy is a great way to build trust and reassure your customers that they can buy with confidence.</p>\n",
"Shipping Info",
"<p>I'm a shipping policy. I'm a great place to add more information about your shipping methods, packaging and cost. Providing straightforward information about your shipping policy is a great way to build trust and reassure your customers that they can buy from you with confidence.</p>\n"
],
"onSale": true,
"sku": "0024",
"title": "Ice Dome: Exile",
"url": "/product-page/ice-dome-exile"
}
},
{
"id": "f2ad9533-30cd-f145-dee4-3f50f4fe84f3",
"data": {
"_highlights": {
"title": ["Mach <mark>Gaming</mark> Chair"]
},
"_score": 149.27646,
"_updated": "2024-04-14T13:22:47.815Z",
"collections": ["Accessories", "On Sale", "Best Sellers"],
"currency": "EUR",
"description": "I'm a product description. This is a great place to "sell" your product and grab buyers' attention. Describe your product clearly and concisely. Use unique keywords. Write your own description instead of using manufacturers' copy.",
"discountedPrice": "€116.99",
"discountedPriceNumeric": 116.99,
"documentImage": {
"height": 4083,
"name": "c837a6_85410586580e46ce94659e34046a48c8~mv2.jpg",
"width": 4842
},
"documentType": "public/stores/products",
"id": "f2ad9533-30cd-f145-dee4-3f50f4fe84f3",
"inStock": true,
"infoSections": [
"Product Info",
"<p>I'm a product detail. I'm a great place to add more information about your product such as sizing, material, care and cleaning instructions. This is also a great space to write what makes this product special and how your customers can benefit from this item. Buyers like to know what they’re getting before they purchase, so give them as much information as possible so they can buy with confidence and certainty.</p>\n",
"Return and Refund Policy",
"<p>I’m a Return and Refund policy. I’m a great place to let your customers know what to do in case they are dissatisfied with their purchase. Having a straightforward refund or exchange policy is a great way to build trust and reassure your customers that they can buy with confidence.</p>\n",
"Shipping Info",
"<p>I'm a shipping policy. I'm a great place to add more information about your shipping methods, packaging and cost. Providing straightforward information about your shipping policy is a great way to build trust and reassure your customers that they can buy from you with confidence.</p>\n"
],
"onSale": true,
"sku": "0006",
"title": "Mach Gaming Chair",
"url": "/product-page/mach-gaming-chair"
}
}
],
"aggregationData": null,
"pagingOffsetMetadata": {
"count": 3,
"offset": 0,
"total": 10,
"tooManyToCount": false,
"hasNext": true
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.