Collection - Storefront GraphQL API

query

collectionItems

Fetch items within a particular collection identified by its slug.

Arguments

slug

Required

A short, human-readable, URL-friendly identifier of a collection. You can get slug value from the endpoint /service/application/catalog/v1.0/collections/.

String

The search query for entering partial or full name of product, brand, category, or collection.

filters

Boolean

True for fetching all filter parameters and False for disabling the filter parameters.

first

Int

The number of items to retrieve in each page.

after

String

Page ID to retrieve next set of results.

pageNo

Int

Page Number to retrieve next set of results.

pageType

String

Page Type to retrieve set of results can be cursor or number.

query

String

The search filter parameters. Filter parameters will be passed in f parameter as shown in the example below. Double Pipe (||) denotes the OR condition, whereas Triple-colon (:::) indicates a new filter parameter applied as an AND condition.

sortOn

Sort_on

The order in which the list of products should be sorted, e.g. popularity, price, latest and discount, in either ascending or descending order. See the supported values below.

Response

filters

[ProductFilters]

True for fetching all filter parameters and False for disabling the filter parameters.

items

[Product]

List of collection objects.

page

PageInfo

Page information for collections response.

sort_on

[ProductSortOn]

The order in which the list of products should be sorted, e.g. popularity, price, latest and discount, in either ascending or descending order. See the supported values below.

Query

1query collectionItems(
2  $slug: String!
3  $search: String
4  $filters: Boolean
5  $first: Int
6  $after: String
7  $pageNo: Int
8  $pageType: String
9  $query: String
10  $sortOn: Sort_on
11) {
12  collectionItems(
13    slug: $slug
14    search: $search
15    filters: $filters
16    first: $first
17    after: $after
18    pageNo: $pageNo
19    pageType: $pageType
20    query: $query
21    sortOn: $sortOn
22  ) {
23    items {
24      color
25      item_code
26      item_type
27      has_variant
28      uid
29      attributes
30      custom_config
31      description
32      discount
33      highlights
34      image_nature
35      is_dependent
36      name
37      product_group_tag
38      product_online_date
39      rating
40      rating_count
41      short_description
42      similars
43      slug
44      tags
45      teaser_tag
46      tryouts
47      type
48      sellable
49      identifiers
50      country_of_origin
51      no_of_boxes
52      promo_meta
53    }
54    page {
55      current
56      next_id
57      has_previous
58      has_next
59      item_total
60      type
61      size
62    }
63    sort_on {
64      display
65      is_selected
66      logo
67      name
68      value
69    }
70  }
71}

Try it

Input Variables

1{
2  "slug": "slug",
3  "search": "search",
4  "filters": true,
5  "first": 42,
6  "after": "after",
7  "pageNo": 42,
8  "pageType": "pageType",
9  "query": "query",
10  "sortOn": "latest"
11}

Response

1{
2  "collectionItems": {
3    "items": [
4      {
5        "color": "#e10098",
6        "item_code": "item_code",
7        "item_type": "item_type",
8        "has_variant": true,
9        "uid": 42,
10        "attributes": {},
11        "custom_config": {},
12        "description": "A description",
13        "discount": "discount",
14        "highlights": [
15          "highlights"
16        ],
17        "image_nature": "image_nature",
18        "is_dependent": true,
19        "name": "A name",
20        "product_group_tag": [
21          "product_group_tag"
22        ],
23        "product_online_date": "product_online_date",
24        "rating": 30.7,
25        "rating_count": 42,
26        "short_description": "short_description",
27        "similars": [
28          "similars"
29        ],
30        "slug": "slug",
31        "tags": [
32          "tags"
33        ],
34        "teaser_tag": "teaser_tag",
35        "tryouts": [
36          "tryouts"
37        ],
38        "type": "type",
39        "sellable": true,
40        "identifiers": [
41          "08a16b83-9094-4e89-8c05-2ccadd5c1c7e"
42        ],
43        "country_of_origin": "country_of_origin",
44        "no_of_boxes": 42,
45        "promo_meta": {}
46      }
47    ],
48    "page": {
49      "current": 42,
50      "next_id": "next_id",
51      "has_previous": true,
52      "has_next": true,
53      "item_total": 42,
54      "type": "type",
55      "size": 42
56    },
57    "sort_on": [
58      {
59        "display": "display",
60        "is_selected": true,
61        "logo": "logo",
62        "name": "A name",
63        "value": "value"
64      }
65    ]
66  }
67}

Was this section helpful?

« DepartmentIdentifier

Badge »