younifyd
Menu

articles

Returns a paginated list of articles from the shop's blogs. Article objects are blog posts that contain content like text, images, and tags.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the articles action (under Articles).
  3. Fill in the fields below, then reference the result from later steps as {{articles.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
query Articles($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: ArticleSortKeys, $query: String) {
  articles(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        author
        blog
        body
        createdAt
        defaultCursor
        handle
        id
        image
        isPublished
        publishedAt
        summary
        tags
        templateSuffix
        title
        updatedAt
      }
    }
    nodes {
      author {
        name
      }
      blog {
        commentPolicy
        createdAt
        feed
        handle
        id
        tags
        templateSuffix
        title
        updatedAt
      }
      body
      createdAt
      defaultCursor
      handle
      id
      image {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      isPublished
      publishedAt
      summary
      tags
      templateSuffix
      title
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofAUTHORBLOG_TITLEIDPUBLISHED_ATTITLEUPDATED_AT

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=handle:summer-collection-announcement` | | author | string | Filter by the author of the article. | | blog_id | string | Filter by the ID of the blog the article belongs to. | | | - `blog_id:1234`<br/> - `blog_id:>=1234`<br/> - `blog_id:<=1234` | | blog_title | string | | created_at | time | Filter by the date and time when the article was created. | | | - `created_at:>'2020-10-21T23:39:20Z'`<br/> - `created_at:<now`<br/> - `created_at:<=2024` | | handle | string | Filter by the article's handle. | | | - `handle:summer-collection-announcement`<br/> - `handle:how-to-guide` | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | published_at | time | Filter by the date and time when the article was published. | | | - `published_at:>'2020-10-21T23:39:20Z'`<br/> - `published_at:<now`<br/> - `published_at:<=2024` | | published_status | string | Filter by published status | | tag | string | Filter objects by the `tag` field. | | | - `tag:my_tag` | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - `tag_not:my_tag` | | title | string | Filter by the title of the article. | | | - `title:summer-collection`<br/> - `title:green hoodie` | | updated_at | time | Filter by the date and time when the article was last updated. | | | - `updated_at:>'2020-10-21T23:39:20Z'`<br/> - `updated_at:<now`<br/> - `updated_at:<=2024` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

json
{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "AUTHOR",
  "query": "string"
}

Response

Read the result with {{articles.response.data.data.articles}}. If the API returns errors, the step fails and they are at {{articles.response.data.errors}}.

edgesarray<object>
cursorobject
nodeobject
nodesarray<object>
authorobject
blogobject
bodyobject
createdAtobject
defaultCursorobject
handleobject
idobject
imageobject
isPublishedobject
publishedAtobject
summaryobject
tagsobject
templateSuffixobject
titleobject
updatedAtobject
pageInfoobject
endCursorstring
hasNextPageboolean
hasPreviousPageboolean
startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.