site | BigCommerce Developer Center

query ExampleQuery {
  site {
    search {
      searchProducts
    }
    categoryTree {
      entityId
      name
      path
      description
      productCount
      image
      hasChildren
      children
    }
    category {
      id
      entityId
      name
      path
      defaultImage
      description
      breadcrumbs
      products
      metafields
      seo
    }
    brands {
      pageInfo
      edges
    }
    products {
      pageInfo
      edges
      collectionInfo
    }
    newestProducts {
      pageInfo
      edges
      collectionInfo
    }
    bestSellingProducts {
      pageInfo
      edges
      collectionInfo
    }
    featuredProducts {
      pageInfo
      edges
      collectionInfo
    }
    product {
      id
      entityId
      sku
      path
      name
      description
      plainTextDescription
      warranty
      minPurchaseQuantity
      maxPurchaseQuantity
    }
    route {
      node
      redirect
    }
  }
}

{
  "data": {
    "site": {
      "search": {
        "searchProducts": {
          "products": null,
          "filters": null
        }
      },
      "categoryTree": [
        {
          "entityId": 0,
          "name": "example",
          "path": "example",
          "description": "example",
          "productCount": 0,
          "image": {
            "url": null,
            "urlOriginal": null,
            "urlTemplate": null,
            "altText": null,
            "isDefault": null
          },
          "hasChildren": true,
          "children": [
            null
          ]
        }
      ],
      "category": {
        "id": "example",
        "entityId": 0,
        "name": "example",
        "path": "example",
        "defaultImage": {
          "url": null,
          "urlOriginal": null,
          "urlTemplate": null,
          "altText": null,
          "isDefault": null
        },
        "description": "example",
        "breadcrumbs": {
          "pageInfo": null,
          "edges": null
        },
        "products": {
          "pageInfo": null,
          "edges": null,
          "collectionInfo": null
        },
        "metafields": {
          "pageInfo": null,
          "edges": null
        },
        "seo": {
          "pageTitle": null,
          "metaDescription": null,
          "metaKeywords": null
        }
      },
      "brands": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ]
      },
      "products": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ],
        "collectionInfo": {
          "totalItems": null
        }
      },
      "newestProducts": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ],
        "collectionInfo": {
          "totalItems": null
        }
      },
      "bestSellingProducts": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ],
        "collectionInfo": {
          "totalItems": null
        }
      },
      "featuredProducts": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ],
        "collectionInfo": {
          "totalItems": null
        }
      },
      "product": {
        "id": "example",
        "entityId": 0,
        "sku": "example",
        "path": "example",
        "name": "example",
        "description": "example",
        "plainTextDescription": "example",
        "warranty": "example",
        "minPurchaseQuantity": 0,
        "maxPurchaseQuantity": 0
      },
      "route": {
        "node": {
          "id": null
        },
        "redirect": {
          "id": null,
          "fromPath": null,
          "to": null,
          "toUrl": null
        }
      }
    }
  }
}

A site

Returns

an Object

searchObject

The Search queries.

categoryTreelist of Objects

A tree of categories.

brandsObject

Details of the brand.

productsObject

Details of the products.

newestProductsObject

Details of the newest products.

bestSellingProductsObject

Details of the best selling products.

featuredProductsObject

Details of the featured products.

routeObject

Route for a node

contentObject

The page content.

currenciesObject

Store Currencies.

popularBrandsObject

List of brands sorted by product count.

paymentWalletsObject

List of payment wallets.

promotionObject

Promotion for the current shopper.

categoryObject

Retrieve a category object by the id.

productObject

A single product object with variant pricing overlay capabilities.

settingsObject

Store settings.

currencyObject

Currency details.

publicWishlistObject

Public Wishlist

cartObject

The Cart of the current customer.

checkoutObject

The checkout of the current customer.

giftCertificateObject

Details of a gift certificate.

brandObject

Details of a brand.

orderObject

A single order.

paymentWalletWithInitializationDataObject

A single payment wallet with initialization data.

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	}

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