Choose a version:

publication

query

Retrieves a Publication by ID.

Returns null if the publication doesn't exist.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the Publication to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to PublicationPublication

•Publication

A group of products and collections that are published to an app.

Each publication manages which products and collections display on its associated Channel. Merchants can automatically publish products when they're created if autoPublish is enabled, or manually control publication through publication records.

Publications support scheduled publishing through future publish dates for online store channels, allowing merchants to coordinate product launches and promotional campaigns. The catalog field links to pricing and availability rules specific to that publication's context.

Anchor to autoPublishautoPublish

•Boolean!

non-null

Whether new products are automatically published to this publication.

Anchor to catalogcatalog

•Catalog

The catalog associated with the publication.

Anchor to collectionPublicationsV3collectionPublicationsV3

•ResourcePublicationConnection!

non-null

The list of collection publication records, each representing the publication status and details for a collection published to this publication (typically channel).

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to collectionscollections

•CollectionConnection!

non-null

The list of collections published to the publication.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to hasCollectionhasCollection

•Boolean!

non-null

Whether the collection is available to the publication.

Anchor to idid •ID! required: Collection ID to check.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to includedProductsincludedProducts

•ProductConnection!

non-null

The list of products included, but not necessarily published, in the publication.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to operationoperation

•PublicationOperation

A background operation associated with this publication.

Anchor to productPublicationsV3productPublicationsV3

•ResourcePublicationConnection!

non-null

The product publications for the list of products published to the publication.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productsproducts

•ProductConnection!

non-null

The list of products published to the publication.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to supportsFuturePublishingsupportsFuturePublishing

•Boolean!

non-null

Whether the publication supports future publishing.

Anchor to appapp

•App!

non-nullDeprecated

Anchor to namename

•String!

non-nullDeprecated

Was this section helpful?

Examples

Retrieve a publication that doesn't exist

Description

Retrieving a publication by an ID that doesn't exist returns `null`.

Query

query publication($id: ID!) {
  publication(id: $id) {
    name
    collections(first: 5) {
      edges {
        node {
          id
          title
          updatedAt
        }
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/Publication/-1"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query publication($id: ID!) { publication(id: $id) { name collections(first: 5) { edges { node { id title updatedAt } } } } }",
 "variables": {
    "id": "gid://shopify/Publication/-1"
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query publication($id: ID!) {
    publication(id: $id) {
      name
      collections(first: 5) {
        edges {
          node {
            id
            title
            updatedAt
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Publication/-1"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query publication($id: ID!) {
    publication(id: $id) {
      name
      collections(first: 5) {
        edges {
          node {
            id
            title
            updatedAt
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Publication/-1"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query publication($id: ID!) {
      publication(id: $id) {
        name
        collections(first: 5) {
          edges {
            node {
              id
              title
              updatedAt
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Publication/-1"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query publication($id: ID!) {
  publication(id: $id) {
    name
    collections(first: 5) {
      edges {
        node {
          id
          title
          updatedAt
        }
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/Publication/-1"
}'

Response

{
  "publication": null
}

Retrieve an existing publication

Query

query publication($id: ID!) {
  publication(id: $id) {
    name
    collections(first: 5) {
      edges {
        node {
          id
          title
          updatedAt
        }
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/Publication/244171671"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query publication($id: ID!) { publication(id: $id) { name collections(first: 5) { edges { node { id title updatedAt } } } } }",
 "variables": {
    "id": "gid://shopify/Publication/244171671"
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query publication($id: ID!) {
    publication(id: $id) {
      name
      collections(first: 5) {
        edges {
          node {
            id
            title
            updatedAt
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Publication/244171671"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query publication($id: ID!) {
    publication(id: $id) {
      name
      collections(first: 5) {
        edges {
          node {
            id
            title
            updatedAt
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Publication/244171671"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query publication($id: ID!) {
      publication(id: $id) {
        name
        collections(first: 5) {
          edges {
            node {
              id
              title
              updatedAt
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Publication/244171671"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query publication($id: ID!) {
  publication(id: $id) {
    name
    collections(first: 5) {
      edges {
        node {
          id
          title
          updatedAt
        }
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/Publication/244171671"
}'

Response

{
  "publication": {
    "name": "Online Store",
    "collections": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/Collection/79210309",
            "title": "Custom Other Items",
            "updatedAt": "2008-10-10T00:00:00Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Collection/94229130",
            "title": "All products more expensive than free",
            "updatedAt": "2006-02-02T00:00:00Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Collection/142458073",
            "title": "All snowboards",
            "updatedAt": "2006-02-02T00:00:00Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Collection/411960790",
            "title": "Bold snowboards",
            "updatedAt": "2006-02-02T00:00:00Z"
          }
        },
        {
          "node": {
            "id": "gid://shopify/Collection/431528632",
            "title": "All arbor products tagged deepsnow",
            "updatedAt": "2006-02-02T00:00:00Z"
          }
        }
      ]
    }
  }
}

Examples

Open in GraphiQL

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

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query publication($id: ID!) {

publication(id: $id) {

name

collections(first: 5) {

edges {

node {

title

updatedAt

}

}`,

{

variables: {

"id": "gid://shopify/Publication/-1"

);

const json = await response.json();

return json.data;

}

GQL

query publication($id: ID!) {
  publication(id: $id) {
    name
    collections(first: 5) {
      edges {
        node {
          id
          title
          updatedAt
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query publication($id: ID!) { publication(id: $id) { name collections(first: 5) { edges { node { id title updatedAt } } } } }",
 "variables": {
    "id": "gid://shopify/Publication/-1"
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query publication($id: ID!) {
    publication(id: $id) {
      name
      collections(first: 5) {
        edges {
          node {
            id
            title
            updatedAt
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Publication/-1"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query publication($id: ID!) {
      publication(id: $id) {
        name
        collections(first: 5) {
          edges {
            node {
              id
              title
              updatedAt
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Publication/-1"
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query publication($id: ID!) {
    publication(id: $id) {
      name
      collections(first: 5) {
        edges {
          node {
            id
            title
            updatedAt
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Publication/-1"
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'query publication($id: ID!) {
  publication(id: $id) {
    name
    collections(first: 5) {
      edges {
        node {
          id
          title
          updatedAt
        }
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/Publication/-1"
}'

Input variables

JSON

{

"id": "gid://shopify/Publication/-1"

}

Response

JSON

{

"publication": null

}