Article - admin-graphql - OBJECT

Version: 2024-10

Description:

An article in the blogging system.

Access Scopes

`read_content` access scope or `read_online_store_pages` access scope.

Fields

• author: ArticleAuthor - The name of the author of the article.
• blog: Blog! - The blog containing the article.
• body: HTML! - The text of the article's body, complete with HTML markup.
• commentsCount: Count - Count of comments.
• createdAt: DateTime! - The date and time (ISO 8601 format) when the article was created.
• defaultCursor: String! - A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID.
• handle: String! - A unique, human-friendly string for the article that's automatically generated from the article's title. The handle is used in the article's URL.
• id: ID! - A globally-unique ID.
• image: Image - The image associated with the article.
• isPublished: Boolean! - Whether or not the article is visible.
• metafield: Metafield - A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• privateMetafield: PrivateMetafield - Returns a private metafield by namespace and key that belongs to the resource.
• publishedAt: DateTime - The date and time (ISO 8601 format) when the article became or will become visible. Returns null when the article isn't visible.
• summary: HTML - A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.
• tags: String! - A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
• templateSuffix: String - The name of the template an article is using if it's using an alternate template. If an article is using the default `article.liquid` template, then the value returned is `null`.
• title: String! - The title of the article.
• translations: Translation! - The published translations associated with the resource.
• updatedAt: DateTime - The date and time (ISO 8601 format) when the article was last updated.

Connections

• comments: CommentConnection!
• events: EventConnection!
• metafieldDefinitions: MetafieldDefinitionConnection!
• metafields: MetafieldConnection!
• privateMetafields: PrivateMetafieldConnection!

Related queries

• article Returns an Article resource by ID.
• articles List of the shop's articles.

Related mutations

• articleCreate Creates an article.
• articleUpdate Updates an article.

Related Unions

• MetafieldReferencer Types of resources that may use metafields to reference other resources.

Examples

• Receive a single Article

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ArticleShow($id: ID!) { article(id: $id) { id author { name } createdAt handle } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Article/959752435\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query ArticleShow($id: ID!) {\n      article(id: $id) {\n        id\n        author {\n          name\n        }\n        createdAt\n        handle\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Article/959752435\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ArticleShow($id: ID!) {\n    article(id: $id) {\n      id\n      author {\n        name\n      }\n      createdAt\n      handle\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Article/959752435\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ArticleShow($id: ID!) {\n    article(id: $id) {\n      id\n      author {\n        name\n      }\n      createdAt\n      handle\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Article/959752435\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ArticleShow($id: ID!) {\n    article(id: $id) {\n      id\n      author {\n        name\n      }\n      createdAt\n      handle\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Article/959752435\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ArticleShow($id: ID!) {\n  article(id: $id) {\n    id\n    author {\n      name\n    }\n    createdAt\n    handle\n  }\n}"
        

  input: {
    "id": "gid://shopify/Article/959752435"
  }

  response: {
    "data": {
      "article": {
        "id": "gid://shopify/Article/959752435",
        "author": {
          "name": "dennis"
        },
        "createdAt": "2012-01-01T00:00:00Z",
        "handle": "you-should-buy-this"
      }
    }
  }