List Collections

GET

/store/collections

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

Request Example

Shell

JavaScript

Java

Swift

curl '{backend_url}/store/collections' \
-H 'x-publishable-api-key: {your_publishable_api_key}'

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "collections": [
        {
            "id": "string",
            "title": "string",
            "handle": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {},
            "products": [
                {}
            ]
        }
    ]
}

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2 months ago

Reset a Customer's Password

Get a Collection