This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

List Collections

Production Env

http://127.0.0.1:3658/m1/543334-505232-default

GET

/admin/collections

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://127.0.0.1:3658/m1/543334-505232-default/admin/collections'

Response Example

200 - Example 1

{
    "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"
            }
        }
    ]
}

Request

Query Params

Responses

🟢200OK

application/json

Body

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2024-05-20 07:45:58

Delete a Collection

Create a Collection