Choose a version:

blog

query

Returns a Blog resource by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Blog

•

Blog

Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant to be used as a type of magazine or newsletter for the shop, with content that changes over time.

articles • ArticleConnection! non-null: List of the blog's articles.
articlesCount• Count: Count of articles.
commentPolicy• CommentPolicy! non-null: Indicates whether readers can post comments to the blog and if comments are moderated or not.
createdAt• DateTime! non-null: The date and time when the blog was created.
events • EventConnection! non-null: The paginated list of events associated with the host subject.
feed• BlogFeed: FeedBurner provider details. Any blogs that aren't already integrated with FeedBurner can't use the service.
handle• String! non-null: A unique, human-friendly string for the blog. If no handle is specified, a handle will be generated automatically from the blog title. The handle is customizable and is used by the Liquid templating language to refer to the blog.
id• ID! non-null: A globally-unique ID.
metafield• Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
metafields • MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
metafieldsByIdentifiers• [Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
tags• [String!]! non-null: A list of tags associated with the 200 most recent blog articles.
templateSuffix• String: The name of the template a blog is using if it's using an alternate template. Returns null if a blog is using the default blog.liquid template.
title• String! non-null: The title of the blog.
translations• [Translation!]! non-null: The published translations associated with the resource.
updatedAt• DateTime: The date and time when the blog was update.
metafieldDefinitions • MetafieldDefinitionConnection! non-nullDeprecated: List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.

Was this section helpful?

Receive a single Blog
Retrieves a count of all articles from a blog
Retrieves a list of all articles from a blog

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query BlogShow($id: ID!) {

blog(id: $id) {

title

handle

}

}`,

{

variables: {

"id": "gid://shopify/Blog/397675442"

);

const data = await response.json();

query BlogShow($id: ID!) {
  blog(id: $id) {
    id
    title
    handle
  }
}

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 BlogShow($id: ID!) { blog(id: $id) { id title handle } }",
 "variables": {
    "id": "gid://shopify/Blog/397675442"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query BlogShow($id: ID!) {
    blog(id: $id) {
      id
      title
      handle
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Blog/397675442"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query BlogShow($id: ID!) {
      blog(id: $id) {
        id
        title
        handle
      }
    }`,
    "variables": {
      "id": "gid://shopify/Blog/397675442"
    },
  },
});

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 BlogShow($id: ID!) {
    blog(id: $id) {
      id
      title
      handle
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Blog/397675442"
}

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

Input variables

JSON

{

"id": "gid://shopify/Blog/397675442"

}

Response

JSON

{

"blog": {

"id": "gid://shopify/Blog/397675442",

"title": "Yo Blog",

"handle": "smallcheese-blog"

}