DevTools
The module adds a Shopify panel and its GraphQL explorers to Nuxt DevTools. You find them in the Nuxt group of DevTools, under Modules.
Requirements
The Shopify panel needs Nuxt DevTools 4, which runs on Nuxt 4.5 or later.
By default, Nuxt 4 installs an older DevTools. On Nuxt 4.5 or later, add DevTools 4 to your dev dependencies, and Nuxt loads it instead:
npm install -D @nuxt/devtools@4
pnpm add -D @nuxt/devtools@4
bun add -D @nuxt/devtools@4
See Upgrading to v4 for everything else that changes in DevTools 4.
The Shopify panel
Requests
The Requests tab lists the last 100 requests of the module's clients during server-side rendering, in your server routes and in the browser. The requests of the Shopify routes, such as adding to the cart, show up as server route requests. For each request, it shows the time, the API, the operation, where it was sent from, whether it failed and how long it took. Requests from server-side rendering and the browser also show their page.
Click a request to see its query, its variables and the response. When Shopify sends errors or extensions, such as the query cost of the Admin API, you see them too. Open in explorer opens the request in the explorer of its API, in a new browser tab, with its query and variables filled in.
When requests fail, the Requests tab and the Shopify entry in DevTools show how many in red.
The buttons above the table:
- open the DevTools tab of each explorer,
- clear the list.
Operations
The Operations tab lists the GraphQL queries and mutations that the type generation found, with their API, their type and their file. Click one to open it in your editor. When the types can't be generated, the tab shows why.
Fragments
When the type generation finds fragments, the Fragments tab lists them with their API and their file. Click one to open it in your editor.
Config
The Config tab shows the configuration the module uses, including the values from runtime config and environment variables. Tokens, secrets, passwords and custom headers are hidden, and storage options only show their driver.
Explorers
Every enabled explorer also gets its own tab, so you can try queries without leaving DevTools.
Turning it off
To leave the Shopify panel and the explorer tabs out of DevTools, set devtools to false:
export default defineNuxtConfig({
shopify: {
devtools: false,
},
})