Server Utilities

All auto-imported server utilities and

Auto-Imported Utilities

These utilities are auto-imported in your server/ directory — no imports needed:

Utility	Purpose
`useShopifyAdmin(event)`	Authenticate admin requests (token exchange, session)
`useShopifyWebhook(event)`	Validate webhook HMAC + parse payload
`useShopifyFlow(event)`	Authenticate Shopify Flow extension requests
`useShopifyPublic(event)`	Authenticate public/checkout extension requests
`useShopifyPos(event)`	Authenticate POS extension requests
`useShopifyFulfillmentService(event)`	Authenticate fulfillment service callbacks
`useShopifyLogin(event)`	Handle merchant login (non-embedded apps)
`useShopifyUnauthenticatedAdmin(shop)`	Offline session admin API access
`registerShopifyWebhooks(session)`	Register webhooks for a shop

`#shopify/server` Exports

For use in Nitro plugins and advanced server-side configuration, import from #shopify/server:

import {
  configureShopify,
  getShopifyApi,
  getResolvedConfig,
  getSessionStorage,
  registerShopifyWebhooks,
  createAdminApiContext
} from '#shopify/server'

Functions

Export	Description
`configureShopify(config)`	Configure session storage, hooks, webhooks, and billing
`getShopifyApi()`	Get the initialized `@shopify/shopify-api` instance
`getResolvedConfig()`	Get the fully resolved module configuration
`getSessionStorage()`	Get the configured session storage adapter
`registerShopifyWebhooks(session)`	Register webhooks for a specific shop session
`createAdminApiContext(session)`	Create an Admin API context (GraphQL) for a session

Types

import type {
  AdminApiContext,
  GraphQLClient,
  GraphQLQueryOptions,
  GraphQLResponse
} from '#shopify/server'

Type	Description
`AdminApiContext`	Object with `graphql()` client method
`GraphQLClient`	Typed GraphQL client function
`GraphQLQueryOptions`	Options for GraphQL queries (variables, etc.)
`GraphQLResponse`	Response type from GraphQL operations

Test Helpers

The module exports test helpers through shopify-app-nuxt/test-helpers:

import { testConfig, testSession } from 'shopify-app-nuxt/test-helpers'

// Returns a dummy configuration for testing
const config = testConfig()

// Returns a mock Shopify session
const session = testSession()

// Both accept overrides
const customConfig = testConfig({ apiKey: 'custom-key' })
const customSession = testSession({ shop: 'custom-shop.myshopify.com' })

Edit this pageorReport an issue

GraphQL Codegen

Auto-generate typed Admin API queries with the codegen module option.

Composables

Client-side composables for App Bridge and authenticated fetch.