store | BigCommerce Developer Center

query ExampleQuery {
  store {
    account {
      id
    }
    appExtensions {
      pageInfo
      edges
    }
    channel {
      id
      currencies
      dateCreated
      dateModified
      externalId
      iconUrl
      isListableFromUi
      isVisible
      name
      platform
    }
    channels {
      pageInfo
      edges
    }
    id
    locales {
      pageInfo
      edges
    }
    metafield {
      id
      description
      key
      namespace
      permissionSet
      resourceId
      value
      ownerClientId
      createdAt
      updatedAt
    }
    metafields {
      pageInfo
      edges
    }
    product {
      id
      basicInformation
      isFeatured
      urlPath
      overridesForLocale
      overridesForChannel
      seoInformation
      storefrontDetails
      preOrderSettings
      customFields
    }
    products {
      pageInfo
      edges
    }
  }
}

{
  "data": {
    "store": {
      "account": {
        "id": "example"
      },
      "appExtensions": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ]
      },
      "channel": {
        "id": "example",
        "currencies": {
          "defaultCurrencyCode": null,
          "enabledCurrencyCodes": null
        },
        "dateCreated": "DateTime",
        "dateModified": "DateTime",
        "externalId": "example",
        "iconUrl": "example",
        "isListableFromUi": true,
        "isVisible": true,
        "name": "example",
        "platform": "example"
      },
      "channels": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ]
      },
      "id": "example",
      "locales": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ]
      },
      "metafield": {
        "id": "example",
        "description": "example",
        "key": "example",
        "namespace": "example",
        "permissionSet": "APP_ONLY",
        "resourceId": "example",
        "value": "example",
        "ownerClientId": "example",
        "createdAt": "DateTime",
        "updatedAt": "DateTime"
      },
      "metafields": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ]
      },
      "product": {
        "id": "example",
        "basicInformation": {
          "description": null,
          "name": null
        },
        "isFeatured": true,
        "urlPath": {
          "path": null
        },
        "overridesForLocale": {
          "basicInformation": null,
          "seoInformation": null,
          "storefrontDetails": null,
          "urlPath": null,
          "preOrderSettings": null
        },
        "overridesForChannel": {
          "isFeatured": null
        },
        "seoInformation": {
          "metaDescription": null,
          "pageTitle": null
        },
        "storefrontDetails": {
          "warranty": null,
          "availabilityDescription": null,
          "searchKeywords": null
        },
        "preOrderSettings": {
          "message": null
        },
        "customFields": {
          "pageInfo": null,
          "edges": null
        }
      },
      "products": {
        "pageInfo": {
          "hasNextPage": null,
          "hasPreviousPage": null,
          "startCursor": null,
          "endCursor": null
        },
        "edges": [
          {
            "node": null,
            "cursor": null
          }
        ]
      }
    }
  }
}

A store.

Returns

an Object

appExtensionsObject

A list of App Extensions that the requesting API account has installed on the store.

channelsObject

List of channels.

idString

The ID of the object.

localesObject

Retrieves a list of locales for the store.

metafieldsObject

List of metafields.

productsObject

List of products.

sharedProductModifiersObject

List of shared product modifiers.

sharedProductOptionsObject

List of shared product options.

storeHashString

Store hash.

storeReferenceIdString

Store reference ID.

translationsObject

List of store translations.

webhooksObject

Webhooks list fetch request.

accountObject

An account.

channelObject

A channel.

metafieldObject

Single metafield.

productObject

Single product.

settingsObject

Store settings.

webhookObject

Webhook fetch request.

1	query ExampleQuery {
2	store {
3	account {
4	id
5	}
6	appExtensions {
7	pageInfo
8	edges
9	}
10	channel {
11	id
12	currencies
13	dateCreated
14	dateModified
15	externalId
16	iconUrl
17	isListableFromUi
18	isVisible
19	name
20	platform
21	}
22	channels {
23	pageInfo
24	edges
25	}
26	id
27	locales {
28	pageInfo
29	edges
30	}
31	metafield {
32	id
33	description
34	key
35	namespace
36	permissionSet
37	resourceId
38	value
39	ownerClientId
40	createdAt
41	updatedAt
42	}
43	metafields {
44	pageInfo
45	edges
46	}
47	product {
48	id
49	basicInformation
50	isFeatured
51	urlPath
52	overridesForLocale
53	overridesForChannel
54	seoInformation
55	storefrontDetails
56	preOrderSettings
57	customFields
58	}
59	products {
60	pageInfo
61	edges
62	}
63	}
64	}

1	{
2	"data": {
3	"store": {
4	"account": {
5	"id": "example"
6	},
7	"appExtensions": {
8	"pageInfo": {
9	"hasNextPage": null,
10	"hasPreviousPage": null,
11	"startCursor": null,
12	"endCursor": null
13	},
14	"edges": [
15	{
16	"node": null,
17	"cursor": null
18	}
19	]
20	},
21	"channel": {
22	"id": "example",
23	"currencies": {
24	"defaultCurrencyCode": null,
25	"enabledCurrencyCodes": null
26	},
27	"dateCreated": "DateTime",
28	"dateModified": "DateTime",
29	"externalId": "example",
30	"iconUrl": "example",
31	"isListableFromUi": true,
32	"isVisible": true,
33	"name": "example",
34	"platform": "example"
35	},
36	"channels": {
37	"pageInfo": {
38	"hasNextPage": null,
39	"hasPreviousPage": null,
40	"startCursor": null,
41	"endCursor": null
42	},
43	"edges": [
44	{
45	"node": null,
46	"cursor": null
47	}
48	]
49	},
50	"id": "example",
51	"locales": {
52	"pageInfo": {
53	"hasNextPage": null,
54	"hasPreviousPage": null,
55	"startCursor": null,
56	"endCursor": null
57	},
58	"edges": [
59	{
60	"node": null,
61	"cursor": null
62	}
63	]
64	},
65	"metafield": {
66	"id": "example",
67	"description": "example",
68	"key": "example",
69	"namespace": "example",
70	"permissionSet": "APP_ONLY",
71	"resourceId": "example",
72	"value": "example",
73	"ownerClientId": "example",
74	"createdAt": "DateTime",
75	"updatedAt": "DateTime"
76	},
77	"metafields": {
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	},
91	"product": {
92	"id": "example",
93	"basicInformation": {
94	"description": null,
95	"name": null
96	},
97	"isFeatured": true,
98	"urlPath": {
99	"path": null
100	},
101	"overridesForLocale": {
102	"basicInformation": null,
103	"seoInformation": null,
104	"storefrontDetails": null,
105	"urlPath": null,
106	"preOrderSettings": null
107	},
108	"overridesForChannel": {
109	"isFeatured": null
110	},
111	"seoInformation": {
112	"metaDescription": null,
113	"pageTitle": null
114	},
115	"storefrontDetails": {
116	"warranty": null,
117	"availabilityDescription": null,
118	"searchKeywords": null
119	},
120	"preOrderSettings": {
121	"message": null
122	},
123	"customFields": {
124	"pageInfo": null,
125	"edges": null
126	}
127	},
128	"products": {
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	}
142	}
143	}
144	}