GET /v1/public/storefronts/{slug}/collections

GET/v1/public/storefronts/{slug}/collections

Path parameters

slugstringrequired

Query parameters

categorystring

qstring

tagstring

preview_tokenstring

limitinteger<int32>

min 1 · max 100 · default: 30

offsetinteger<int32>

min 0 · default: 0

Responses

200OK

itemsCollectionOutput[] | nullrequired

Show properties

Array of CollectionOutput

activebooleanrequired

descriptionstring

idstringrequired

image_urlstring

product_countinteger<int32>

slugstringrequired

sort_orderinteger<int32>required

titlestringrequired

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/public/storefronts/string/collections"

const response = await fetch("/v1/public/storefronts/string/collections", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/public/storefronts/string/collections",
)

Response

{
  "items": [
    {
      "active": true,
      "description": "string",
      "id": "string",
      "image_url": "string",
      "product_count": 0,
      "slug": "string",
      "sort_order": 0,
      "title": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}