# @nestjs-shopify/graphql

> A NestJS module for exposing a Shopify GraphQL Admin API proxy. The `ShopifyGraphqlProxyModule` allows you to expose the GraphQL Admin API without having to pass in an `X-Shopify-Access-Token`. The module automatically provides everything necessary to cal

Latest version **6.0.3** (published 2026-08-24) · 0 weekly downloads

## Install

```sh
npm install @nestjs-shopify/graphql
pnpm add @nestjs-shopify/graphql
yarn add @nestjs-shopify/graphql
bun add @nestjs-shopify/graphql
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 6.0.3 |
| Published | 2026-08-24 |
| First published | 2022-12-07 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 151 |
| Maintainers | tolgapaksoy |

## Links

- npm: https://www.npmjs.com/package/@nestjs-shopify/graphql
- Repository: https://github.com/nestjs-shopify/nestjs-shopify
- Issues: https://github.com/nestjs-shopify/nestjs-shopify/issues
- npm.io page: https://npm.io/package/@nestjs-shopify/graphql

## Recent versions

- 6.0.3 (latest) — 2026-08-24
- 6.0.2 — 2026-04-14
- 6.0.1 — 2025-03-25
- 6.0.0 — 2024-07-20
- 5.0.1 — 2024-05-09
- 5.0.0 — 2024-02-21
- 4.2.0 — 2024-01-15
- 4.1.0 — 2023-10-26
- 4.0.1 — 2023-09-27
- 4.0.0 — 2023-04-13
- 3.1.0 — 2023-02-27
- 3.0.0 — 2023-02-25
- 2.0.2 — 2022-12-14
- 2.0.1 — 2022-12-08
- 2.0.0 — 2022-12-08
- … 1 more at https://npm.io/package/@nestjs-shopify/graphql/versions

## README

# @nestjs-shopify/graphql

A NestJS module for exposing a Shopify GraphQL Admin API proxy. The `ShopifyGraphqlProxyModule` allows you to expose the GraphQL Admin API without having to pass in an `X-Shopify-Access-Token`. The module automatically provides everything necessary to call the Shopify GraphQL Admin API. Uses [`@shopify/shopify-api`](https://github.com/shopify/shopify-node-api) under the hood.

# Installation

Install required dependencies and this package using NPM:

```
npm i @shopify/shopify-api @nestjs-shopify/core @shopify-nestjs/express @nestjs-shopify/auth @nestjs-shopify/graphql
```

or using Yarn:

```
yarn add @shopify/shopify-api @nestjs-shopify/core @shopify-nestjs/express @nestjs-shopify/auth @nestjs-shopify/graphql
```

> **Note**
>
> Install `@nestjs-shopify/express` if you are using Express, or `@nestjs-shopify/fastify` if you are using Fastify.

# Usage

From your application root module, import the `ShopifyGraphqlProxyModule`:

```ts
// app.module.ts
import { ShopifyAuthModule } from '@nestjs-shopify/auth';
import { ShopifyExpressModule } from '@nestjs-shopify/express';
import { ShopifyGraphqlProxyModule } from '@nestjs-shopify/graphql';

@Module({
  imports: [
    ShopifyExpressModule.forRoot({
      apiKey: 'foo',
      apiSecret: 'bar',
      apiVersion: ApiVersion.Unstable,
      hostName: 'localhost:8081',
      isEmbeddedApp: true,
      scopes: ['test_scope'],
    }),
    ShopifyAuthModule.forRootOnline({
      basePath: 'user',
      returnHeaders: true,
    }),
    ShopifyGraphqlProxyModule,
  ],
})
export class AppModule {}
```

This will expose the `/graphql` endpoint.

Make sure to setup online session authentication using `ShopifyAuthModule` with `forRootOnline` or `forRootAsyncOnline`. The Admin GraphQL API proxy only works with online session tokens. Not with offline tokens.

---
_Source: https://npm.io/package/@nestjs-shopify/graphql · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._