List Collections

Retrieve a list of product collections. The product collections can be filtered by fields such as handle or created_at. The product collections can also be paginated.

Responses

🟢200OK

application/json

Body

Example

{
    "count": 0,
    "offset": 0,
    "limit": 0,
    "collections": [
        {
            "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
            "title": "Summer Collection",
            "handle": "summer-collection",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "products": [
                {}
            ],
            "metadata": {
                "car": "white"
            }
        }
    ]
}

🟠400Client Error or Multiple Errors

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Collections

Request

Request samples

Responses