younifyd
Menu

comments

Query comments — supports a search `query`, `sortKey`, and cursor paging.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the comments action (under Comments).
  3. Fill in the fields below, then reference the result from later steps as {{comments.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 Comments($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: CommentSortKeys, $query: String) {
  comments(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        article
        author
        body
        bodyHtml
        createdAt
        id
        ip
        isPublished
        publishedAt
        status
        updatedAt
        userAgent
      }
    }
    nodes {
      article {
        author
        blog
        body
        createdAt
        defaultCursor
        handle
        id
        image
        isPublished
        publishedAt
        summary
        tags
        templateSuffix
        title
        updatedAt
      }
      author {
        email
        name
      }
      body
      bodyHtml
      createdAt
      id
      ip
      isPublished
      publishedAt
      status
      updatedAt
      userAgent
    }
    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 ofCREATED_ATID

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=title:green hoodie` | | created_at | time | Filter by the date and time when the comment was created. | | | - `created_at:>'2020-10-21T23:39:20Z'`<br/> - `created_at:<now`<br/> - `created_at:<=2024` | | 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 comment was published. | | | - `published_at:>'2020-10-21T23:39:20Z'`<br/> - `published_at:<now`<br/> - `published_at:<=2024` | | published_status | string | Filter by published status | - `any`<br/> - `published`<br/> - `unpublished` | | - `published_status:any`<br/> - `published_status:published`<br/> - `published_status:unpublished` | | status | string | | updated_at | time | Filter by the date and time when the comment 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": "CREATED_AT",
  "query": "string"
}

Response

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

edgesarray<object>
cursorobject
nodeobject
nodesarray<object>
articleobject
authorobject
bodyobject
bodyHtmlobject
createdAtobject
idobject
ipobject
isPublishedobject
publishedAtobject
statusobject
updatedAtobject
userAgentobject
pageInfoobject
endCursorstring
hasNextPageboolean
hasPreviousPageboolean
startCursorstring

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

Was this page helpful?