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

Anchor to PublicationPublication • Publication: A publication is a group of products and collections that is published to an app.

Was this section helpful?

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

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query publication($id: ID!) {
6    publication(id: $id) {
7      name
8      collections(first: 5) {
9        edges {
10          node {
11            id
12            title
13            updatedAt
14          }
15        }
16      }
17    }
18  }`,
19  {
20    variables: {
21      "id": "gid://shopify/Publication/-1"
22    },
23  },
24);
25
26const data = await response.json();
27

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/2024-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"
  }
}'

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

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

Response

JSON

1{
2  "publication": null
3}