site

Example Query

1 query ExampleQuery {
2   site {
3     search {
4       searchProducts
5     }
6     categoryTree {
7       entityId
8       name
9       path
10       description
11       productCount
12       image
13       hasChildren
14       children
15     }
16     category {
17       id
18       entityId
19       name
20       path
21       defaultImage
22       description
23       breadcrumbs
24       products
25       metafields
26       seo
27     }
28     brands {
29       pageInfo
30       edges
31     }
32     products {
33       pageInfo
34       edges
35       collectionInfo
36     }
37     newestProducts {
38       pageInfo
39       edges
40       collectionInfo
41     }
42     bestSellingProducts {
43       pageInfo
44       edges
45       collectionInfo
46     }
47     featuredProducts {
48       pageInfo
49       edges
50       collectionInfo
51     }
52     product {
53       id
54       entityId
55       sku
56       path
57       name
58       description
59       plainTextDescription
60       warranty
61       minPurchaseQuantity
62       maxPurchaseQuantity
63     }
64     route {
65       node
66       redirect
67     }
68   }
69 }

Example response

1 {
2   "data": {
3     "site": {
4       "search": {
5         "searchProducts": {
6           "products": null,
7           "filters": null,
8           "suggestions": null
9         }
10       },
11       "categoryTree": [
12         {
13           "entityId": 0,
14           "name": "example",
15           "path": "example",
16           "description": "example",
17           "productCount": 0,
18           "image": {
19             "url": null,
20             "urlOriginal": null,
21             "urlTemplate": null,
22             "altText": null,
23             "isDefault": null
24           },
25           "hasChildren": true,
26           "children": [
27             null
28           ]
29         }
30       ],
31       "category": {
32         "id": "example",
33         "entityId": 0,
34         "name": "example",
35         "path": "example",
36         "defaultImage": {
37           "url": null,
38           "urlOriginal": null,
39           "urlTemplate": null,
40           "altText": null,
41           "isDefault": null
42         },
43         "description": "example",
44         "breadcrumbs": {
45           "pageInfo": null,
46           "edges": null
47         },
48         "products": {
49           "pageInfo": null,
50           "edges": null,
51           "collectionInfo": null
52         },
53         "metafields": {
54           "pageInfo": null,
55           "edges": null
56         },
57         "seo": {
58           "pageTitle": null,
59           "metaDescription": null,
60           "metaKeywords": null
61         }
62       },
63       "brands": {
64         "pageInfo": {
65           "hasNextPage": null,
66           "hasPreviousPage": null,
67           "startCursor": null,
68           "endCursor": null
69         },
70         "edges": [
71           {
72             "node": null,
73             "cursor": null
74           }
75         ]
76       },
77       "products": {
78         "pageInfo": {
79           "hasNextPage": null,
80           "hasPreviousPage": null,
81           "startCursor": null,
82           "endCursor": null
83         },
84         "edges": [
85           {
86             "node": null,
87             "cursor": null
88           }
89         ],
90         "collectionInfo": {
91           "totalItems": null
92         }
93       },
94       "newestProducts": {
95         "pageInfo": {
96           "hasNextPage": null,
97           "hasPreviousPage": null,
98           "startCursor": null,
99           "endCursor": null
100         },
101         "edges": [
102           {
103             "node": null,
104             "cursor": null
105           }
106         ],
107         "collectionInfo": {
108           "totalItems": null
109         }
110       },
111       "bestSellingProducts": {
112         "pageInfo": {
113           "hasNextPage": null,
114           "hasPreviousPage": null,
115           "startCursor": null,
116           "endCursor": null
117         },
118         "edges": [
119           {
120             "node": null,
121             "cursor": null
122           }
123         ],
124         "collectionInfo": {
125           "totalItems": null
126         }
127       },
128       "featuredProducts": {
129         "pageInfo": {
130           "hasNextPage": null,
131           "hasPreviousPage": null,
132           "startCursor": null,
133           "endCursor": null
134         },
135         "edges": [
136           {
137             "node": null,
138             "cursor": null
139           }
140         ],
141         "collectionInfo": {
142           "totalItems": null
143         }
144       },
145       "product": {
146         "id": "example",
147         "entityId": 0,
148         "sku": "example",
149         "path": "example",
150         "name": "example",
151         "description": "example",
152         "plainTextDescription": "example",
153         "warranty": "example",
154         "minPurchaseQuantity": 0,
155         "maxPurchaseQuantity": 0
156       },
157       "route": {
158         "node": {
159           "id": null,
160           "entityId": null,
161           "name": null,
162           "content": null,
163           "location": null
164         },
165         "redirect": {
166           "id": null,
167           "fromPath": null,
168           "to": null,
169           "toUrl": null
170         }
171       }
172     }
173   }
174 }

A site

Returns

a Site

searchSearchQueries

The Search queries.

categoryTreelist of CategoryTreeItems

A tree of categories.

brandsBrandConnection

Details of the brand.

productsProductConnection

Details of the products.

newestProductsProductConnection

Details of the newest products.

bestSellingProductsProductConnection

Details of the best selling products.

featuredProductsProductConnection

Details of the featured products.

routeRoute

Route for a node

contentContent

The page content.

currenciesCurrencyConnection

Store Currencies.

popularBrandsPopularBrandConnection

List of brands sorted by product count.

paymentWalletsPaymentWalletConnection

List of payment wallets.

promotionPromotion

Promotion for the current shopper.

categoryCategoryOptional

Retrieve a category object by the id.

productProductOptional

A single product object with variant pricing overlay capabilities.

settingsSettingsOptional

Store settings.

currencyCurrencyOptional

Currency details.

publicWishlistPublicWishlistOptional

Public Wishlist

cartCartOptional

The Cart of the current customer.

checkoutCheckoutOptional

The checkout of the current customer.

giftCertificateGiftCertificateOptional

Details of a gift certificate.

paymentMethodsPaymentMethodConnectionOptional

List of enabled payment methods for the current store and channel. Alpha: do not use in production.

brandBrandOptional

Details of a brand.

orderOrderWithPaymentsOptional

A single order.

paymentWalletWithInitializationDataPaymentWalletWithInitializationDataOptional

A single payment wallet with initialization data.

storedInstrumentsManifestStoredInstrumentsManifestOptional

The stored instruments manifest, resolved for the current environment.