GET

Get Collection

Retrieves a collection with the provided ID.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Learn more about app permissions.
Path Params
idstringRequired

Requested collection ID.

Query Params
includeNumberOfProductsboolean

Whether to return the collection.numberOfProducts field in the response. Defaults to false, in which case the value of collection.numberOfProducts will be 0.

Response Object
collectionCollection

The requested collection.

Get Collection and include number of products
Request
cURL
curl -X GET \
   'https://www.wixapis.com/stores/v1/collections/32fd0b3a-2d38-2235-7754-78a3f819274a?includeNumberOfProducts=true' \
   -H 'Authorization: <AUTH>'
Response
JSON
{
  "collection": {
    "id": "32fd0b3a-2d38-2235-7754-78a3f819274a",
    "name": "Coffee Products",
    "slug": "coffee-products",
    "visible": true,
    "description": "Some Coffee Products",
    "media": {
      "mainMedia": {
        "thumbnail": {
          "url": "https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.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/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg",
          "width": 6630,
          "height": 5304
        },
        "id": ""
      },
      "items": [
        {
          "thumbnail": {
            "url": "https://static.wixstatic.com/media/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.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/11062b_5ccf31f886ec449f84a18ecdf58e05ec~mv2.jpg/v1/fit/w_6630,h_5304,q_90/file.jpg",
            "width": 6630,
            "height": 5304
          },
          "id": ""
        }
      ]
    },
    "numberOfProducts": 5
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?