Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Query Collections

Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
See Stores Pagination for more information.

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

This endpoint requires the Read Products or the Manage Products permission scope.

POST

https://www.wixapis.com/stores/v1/collections/query

Body Params

NAME
TYPE
DESCRIPTION
query

object

Response Object

NAME
TYPE
DESCRIPTION
collections

Array<object>

metadata

object

totalResults

integer

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Example 1

Request

curl

Copy Code
1curl -X POST \
2 'https://www.wixapis.com/stores/v1/collections/query' \
3 --data-binary '{}' \
4 -H 'Content-Type: application/json' \
5 -H 'Authorization: <AUTH>'

Response

json

1
2{
3 "collections": [
4 {
5 "id": "00000000-000000-000000-000000000001",
6 "name": "Artificially added category",
7 "media": {
8 "mainMedia": {
9 "thumbnail": {
10 "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",
11 "width": 50,
12 "height": 50
13 },
14 "mediaType": "image",
15 "title": "",
16 "image": {
17 "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",
18 "width": 2489,
19 "height": 2251
20 },
21 "id": ""
22 },
23 "items": [ {
24 "thumbnail": {
25 "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",
26 "width": 50,
27 "height": 50
28 },
29 "mediaType": "image",
30 "title": "",
31 "image": {
32 "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",
33 "width": 2489,
34 "height": 2251
35 },
36 "id": ""
37 }]
38 }
39 },
40 {
41 "id": "7f79cca8-80b6-d24b-e6f8-356187d95050",
42 "name": "C A C T I",
43 "media": {
44 "mainMedia": {
45 "thumbnail": {
46 "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",
47 "width": 50,
48 "height": 50
49 },
50 "mediaType": "image",
51 "title": "",
52 "image": {
53 "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",
54 "width": 1920,
55 "height": 1920
56 },
57 "id": ""
58 },
59 "items": [ {
60 "thumbnail": {
61 "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",
62 "width": 50,
63 "height": 50
64 },
65 "mediaType": "image",
66 "title": "",
67 "image": {
68 "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",
69 "width": 1920,
70 "height": 1920
71 },
72 "id": ""
73 }]
74 }
75 }
76 ],
77 "metadata": {
78 "items": 100,
79 "offset": 0
80 },
81 "totalResults": 2
82}
Example 2