Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering. See Stores Pagination for more information.
Query options.
Whether number of products should be included in the response.
Wether to include collection description in the response. When false is passed, collection.description will return null.
List of collections.
Details on the paged set of results returned.
Total number of results returned.
curl -X POST \
'https://www.wixapis.com/stores/v1/collections/query' \
--data-binary '{
"query": {
"filter": {
"name": "my collection"
}
}
}' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'{
"collections": [
{
"id": "00000000-000000-000000-000000000001",
"name": "my collection",
"slug": "my-collection",
"visible": true,
"media": {
"mainMedia": {
"thumbnail": {
"url": "https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_2489,h_2251,q_90/file.jpg",
"width": 2489,
"height": 2251
},
"id": ""
},
"items": [
{
"thumbnail": {
"url": "https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/697bc8_43b2c20a2d4144c797ca3cf4d2a7290f~mv2_d_2489_2251_s_2.jpg/v1/fit/w_2489,h_2251,q_90/file.jpg",
"width": 2489,
"height": 2251
},
"id": ""
}
]
}
},
{
"id": "7f79cca8-80b6-d24b-e6f8-356187d95050",
"name": "C A C T I",
"slug": "c-a-c-t-i",
"visible": true,
"media": {
"mainMedia": {
"thumbnail": {
"url": "https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_1920,h_1920,q_90/file.jpg",
"width": 1920,
"height": 1920
},
"id": ""
},
"items": [
{
"thumbnail": {
"url": "https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
"width": 50,
"height": 50
},
"mediaType": "image",
"title": "",
"image": {
"url": "https://static.wixstatic.com/media/697bc8_49e72a53cd064655ba1991bf1d7c1deb~mv2_d_1920_1920_s_2.jpg/v1/fit/w_1920,h_1920,q_90/file.jpg",
"width": 1920,
"height": 1920
},
"id": ""
}
]
}
}
],
"metadata": {
"items": 100,
"offset": 0
},
"totalResults": 2
}This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.