Choose a version:

publication

query

Lookup a publication by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Publication

•

Publication

A publication is a group of products and collections that is published to an app.

autoPublish• Boolean! non-null: Whether new products are automatically published to this publication.
catalog• Catalog: The catalog associated with the publication.
collectionPublicationsV3 • ResourcePublicationConnection! non-null: The collection publications for the list of collections published to the publication.
collections • CollectionConnection! non-null: The list of collections published to the publication.
hasCollection• Boolean! non-null: Whether the collection is available to the publication.
id• ID! non-null: A globally-unique ID.
includedProducts • ProductConnection! non-null: The list of products included, but not necessarily published, in the publication.
operation• PublicationOperation: A background operation associated with this publication.
productPublicationsV3 • ResourcePublicationConnection! non-null: The product publications for the list of products published to the publication.
products • ProductConnection! non-null: The list of products published to the publication.
supportsFuturePublishing• Boolean! non-null: Whether the publication supports future publishing.
app• App! non-null: The app associated with the publication.
name• String! non-null: Name of the publication.

Was this section helpful?

Retrieve a publication that doesn't exist
Retrieve an existing publication

Examples

Open in GraphiQL

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 data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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"
  }
}'

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 data = await response.json();

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"
    },
  },
});

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)

Input variables

JSON

{

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

}

Response

JSON

{

"publication": null

}