For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP
Resources

GraphQL Storefront Queries

inventory

Example Query

1 query ExampleQuery {
2   inventory {
3     locations {
4       pageInfo {
5         hasNextPage
6         hasPreviousPage
7         startCursor
8         endCursor
9       }
10       edges {
11         node
12         cursor
13       }
14     }
15   }
16 }

Example response

1 {
2   "data": {
3     "inventory": {
4       "locations": {
5         "pageInfo": {
6           "hasNextPage": null,
7           "hasPreviousPage": null,
8           "startCursor": null,
9           "endCursor": null
10         },
11         "edges": [
12           {
13             "node": null,
14             "cursor": null
15           }
16         ]
17       }
18     }
19   }
20 }

An inventory

Was this page helpful?

node

shopperPreferences

Returns

an Inventory

locationsInventoryLocationConnection

Locations