GraphQL Admin API

https://shopify.dev/docs/api/admin-graphql/latest
Admin
The Admin API lets you build apps and integrations that extend and enhance the Shopify admin.
Tokens:3,877
Snippets:41
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Shopify CLI and initialize app for React Router

Source: https://shopify.dev/docs/api/admin-graphql/latest

Installs the Shopify CLI globally and initializes a new Shopify app project using React Router.

```bash
npm install -g @shopify/cli@latest
shopify app init
```

--------------------------------

### Install notes for cURL utility

Source: https://shopify.dev/docs/api/admin-graphql/latest

Notes on availability and installation references for making API queries via cURL.

```bash
# cURL is often available by default on macOS and Linux.
# See http://curl.se/docs/install.html for more details.
```

--------------------------------

### Install @shopify/shopify-api package for Node.js

Source: https://shopify.dev/docs/api/admin-graphql/latest

Adds the official Shopify API client library to any Node.js project using npm or yarn.

```ts
npm install --save @shopify/shopify-api
# or
yarn add @shopify/shopify-api
```

--------------------------------

### Install shopify_api gem for Ruby

Source: https://shopify.dev/docs/api/admin-graphql/latest

Adds the official Shopify API gem to a Ruby project via Bundler.

```ruby
bundle add shopify_api
```

--------------------------------

### Query GraphQL Admin API using Shopify Node.js client

Source: https://shopify.dev/docs/api/admin-graphql/latest

Initialize a GraphQL client with a session object and execute a query in Node.js.

```ts
const client = new shopify.clients.Graphql({session});
const response = await client.query({data: 'query { shop { name } }'});
```

--------------------------------

### Query GraphQL Admin API using Shopify Ruby client

Source: https://shopify.dev/docs/api/admin-graphql/latest

Create a session with development store credentials and query the Admin GraphQL client in Ruby.

```ruby
session = ShopifyAPI::Auth::Session.new(
  shop: 'your-development-store.myshopify.com',
  access_token: access_token,
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session,
)
response = client.query(query: 'query { shop { name } }')
```

--------------------------------

### products

Source: https://shopify.dev/docs/api/admin-graphql/latest

Executes a GraphQL query against the Admin API to fetch products with pagination and cost point tracking. Responses include requested fields alongside query cost metrics and throttle status.

```APIDOC
## products

### Description
Queries product records using the GraphQL Admin API. Returns requested product fields along with query cost calculations in the response extensions.

### Query Arguments
- **first** (Int) - Optional - Number of items to fetch from the beginning of the list.

### Request Example
```graphql
{
  products(first: 1) {
    edges {
      node {
        title
      }
    }
  }
}
```

### Response
#### Success Response (200 OK)
- **data.products.edges** (array) - List of product edges.
- **data.products.edges[n].node.title** (string) - Title of the product.
- **extensions.cost.requestedQueryCost** (number) - The calculated maximum cost of the query.
- **extensions.cost.actualQueryCost** (number) - The actual cost executed for the query.
- **extensions.cost.throttleStatus.maximumAvailable** (float) - Maximum available rate limit bucket size.
- **extensions.cost.throttleStatus.currentlyAvailable** (number) - Remaining available cost points.
- **extensions.cost.throttleStatus.restoreRate** (float) - Rate at which points are restored per second.

#### Response Example
```json
{
  "data": {
    "products": {
      "edges": [
        {
          "node": {
            "title": "Hiking backpack"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 3,
      "actualQueryCost": 3,
      "throttleStatus": {
        "maximumAvailable": 1000.0,
        "currentlyAvailable": 997,
        "restoreRate": 50.0
      }
    }
  }
}
```
```

--------------------------------

### Query products in Node.js

Source: https://shopify.dev/docs/api/admin-graphql/latest

Execute a GraphQL query using the Node.js client initialized with an authenticated session.

```ts
const queryString = `{
  products (first: 3) {
    edges {
      node {
        id
        title
      }
    }
  }
}`

// `session` is built as part of the OAuth process
const client = new shopify.clients.Graphql({session});
const products = await client.query({
  data: queryString,
});
```

--------------------------------

### Query products in Ruby

Source: https://shopify.dev/docs/api/admin-graphql/latest

Query product IDs and titles using the ShopifyAPI GraphQL Admin client in Ruby with an active session.

```ruby
query = <<~GQL
  {
    products (first: 3) {
      edges {
        node {
          id
          title
        }
      }
    }
  }
GQL

# session is built as part of the OAuth process
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)
products = client.query(
  query: query,
)
```

--------------------------------

### Query products in React Router

Source: https://shopify.dev/docs/api/admin-graphql/latest

Authenticate an incoming request and query the first three product IDs and titles via the admin GraphQL client inside a loader function.

```ts
import { authenticate } from "../shopify.server";

export async function loader({request}) {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
    query getProducts {
      products (first: 3) {
        edges {
          node {
            id
            title
          }
        }
      }
    }`,
  );
  const json = await response.json();
  return { products: json?.data?.products?.edges };
}
```

--------------------------------

### Query products with rate limit cost extensions

Source: https://shopify.dev/docs/api/admin-graphql/latest

GraphQL Admin API query to fetch product data along with the returned JSON response containing query cost and throttle status under extensions.

```graphql
{
  products(first: 1) {
    edges {
      node {
        title
      }
    }
  }
}
```

```json
{
  "data": {
    "products": {
      "edges": [
        {
          "node": {
            "title": "Hiking backpack"
          }
        }
      ]
    }
  },
  "extensions": {
    "cost": {
      "requestedQueryCost": 3,
      "actualQueryCost": 3,
      "throttleStatus": {
        "maximumAvailable": 1000.0,
        "currentlyAvailable": 997,
        "restoreRate": 50.0
      }
    }
  }
}
```

--------------------------------

### Query products using cURL

Source: https://shopify.dev/docs/api/admin-graphql/latest

Send a POST HTTP request to the GraphQL Admin API endpoint using cURL to fetch the ID and title of the three most recently added products.

```bash
# Get the ID and title of the three most recently added products
curl -X POST   https://{store_name}.myshopify.com/admin/api/2026-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "{
    products(first: 3) {
      edges {
        node {
          id
          title
        }
      }
    }
  }"
}'
```

--------------------------------

### Query products via Direct API Access

Source: https://shopify.dev/docs/api/admin-graphql/latest

Use fetch with a direct API access endpoint to execute a GraphQL query and log the resulting data.

```ts
const response = await fetch('shopify:admin/api/2026-10/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `{
      products(first: 3) {
        edges {
          node {
            id
            title
          }
        }
      }
    }`,
  }),
});

const { data } = await response.json();
console.log(data);
```

--------------------------------

### Query GraphQL Admin API using cURL

Source: https://shopify.dev/docs/api/admin-graphql/latest

Send a raw HTTP POST request to the Admin GraphQL endpoint with the X-Shopify-Access-Token header.

```bash
# Replace {SHOPIFY_ACCESS_TOKEN} with your actual access token
  curl -X POST \
  https://{shop}.myshopify.com/admin/api/2026-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {SHOPIFY_ACCESS_TOKEN}' \
  -d '{
  "query": "query { shop { name } }"
  }'
```

--------------------------------

### Enable embedded Direct API access configuration

Source: https://shopify.dev/docs/api/admin-graphql/latest

Enables Direct API access in App Home to allow authenticated requests directly via the web fetch API.

```toml
# Enable Direct API access in App Home.
[access.admin]
embedded_app_direct_api_access = true
```

--------------------------------

### POST https://{store_name}.myshopify.com/admin/api/2026-10/graphql.json

Source: https://shopify.dev/docs/api/admin-graphql/latest

Executes GraphQL queries and mutations on the Shopify Admin API. Queries are sent via POST HTTP requests containing the GraphQL query string in the request body.

```APIDOC
## POST https://{store_name}.myshopify.com/admin/api/2026-10/graphql.json

### Description
Executes GraphQL queries and mutations on the Shopify store. Queries begin with one of the objects listed under QueryRoot, which serves as the schema's entry point.

### Method
POST

### Endpoint
`https://{store_name}.myshopify.com/admin/api/2026-10/graphql.json`

### Parameters
#### Path Parameters
- **store_name** (string) - Required - The name/subdomain of the Shopify store.

#### Request Headers
- **Content-Type** (string) - Required - Must be `application/json`.
- **X-Shopify-Access-Token** (string) - Required - The OAuth access token.

#### Request Body
- **query** (string) - Required - The GraphQL query or mutation string to execute.

### Request Example
```json
{
  "query": "{\n    products(first: 3) {\n      edges {\n        node {\n          id\n          title\n        }\n      }\n    }\n  }"
}
```

### Request Example (cURL)
```bash
curl -X POST https://{store_name}.myshopify.com/admin/api/2026-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "{
    products(first: 3) {
      edges {
        node {
          id
          title
        }
      }
    }
  }"
}'
```
```

--------------------------------

### Authenticate and query GraphQL Admin API in React Router

Source: https://shopify.dev/docs/api/admin-graphql/latest

Authenticate an incoming admin request inside a React Router loader and execute a GraphQL query.

```js
import { authenticate } from "../shopify.server";

export async function loader({request}) {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `query { shop { name } }`,
  );
}
```

--------------------------------

### Query GraphQL Admin API with Direct API Access

Source: https://shopify.dev/docs/api/admin-graphql/latest

Send a GraphQL query using Direct API access where authentication is automatically handled.

```ts
// Authentication is handled automatically!
const response = await fetch('shopify:admin/api/2026-10/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `query { shop { name } }`,
  }),
});

const { data } = await response.json();
console.log(data);
```
Tokens:
Raw