Collection - Storefront GraphQL API

query

collections

List of curated product collections with filtering options based on tags and collection names.

Arguments

query

String

List of tags to filter collections.

tag

[String]

List of tags to filter collections.

pageNo

Int

The page number to navigate through the given set of results.

pageSize

Int

The number of items to retrieve in each page.

Response

page

PageInfo!

Required

Pagination details for the collection listings. It includes information such as the current page number, total pages, and items per page.

items

[Collection!]!

Required

An array of collection details. Each item in the array represents a collection with various attributes and configurations.

filters

CollectionFilter

Filter options available for the collection listings. This includes tags and filter types that can be used to refine the search results.

Query

1query collections(
2  $query: String
3  $tag: [String]
4  $pageNo: Int
5  $pageSize: Int
6) {
7  collections(query: $query, tag: $tag, pageNo: $pageNo, pageSize: $pageSize) {
8    page {
9      current
10      next_id
11      has_previous
12      has_next
13      item_total
14      type
15      size
16    }
17    items {
18      uid
19      type
20      name
21      description
22      is_active
23      slug
24      allow_facets
25      allow_sort
26      sort_on
27      priority
28      visible_facets_keys
29      _custom_json
30      tags
31      meta
32      cron
33      app_id
34    }
35  }
36}

Try it

Input Variables

1{
2  "query": "query",
3  "tag": [
4    "tag"
5  ],
6  "pageNo": 42,
7  "pageSize": 42
8}

Response

1{
2  "collections": {
3    "page": {
4      "current": 42,
5      "next_id": "next_id",
6      "has_previous": true,
7      "has_next": true,
8      "item_total": 42,
9      "type": "type",
10      "size": 42
11    },
12    "items": [
13      {
14        "uid": "uid",
15        "type": "type",
16        "name": "A name",
17        "description": "A description",
18        "is_active": true,
19        "slug": "slug",
20        "allow_facets": true,
21        "allow_sort": true,
22        "sort_on": "sort_on",
23        "priority": 42,
24        "visible_facets_keys": [
25          "visible_facets_keys"
26        ],
27        "_custom_json": {},
28        "tags": [
29          "tags"
30        ],
31        "meta": {},
32        "cron": {},
33        "app_id": "app_id"
34      }
35    ]
36  }
37}

Was this section helpful?

« DepartmentIdentifier

Badge »