Skip to main content
shoppy.articles.list()
Executes the query and returns a list of articles with pagination info.

Parameters

None

Returns

ArticlesResult
{
  items: ShopifyArticle[]
  pageInfo: {
    hasNextPage: boolean
    hasPreviousPage: boolean
    startCursor: string
    endCursor: string
  }
}

Examples

Basic usage

const { items, pageInfo } = await shoppy.articles.list()

With chained methods

const { items, pageInfo } = await shoppy.articles
    .blog('news')
    .limit(10)
    .select(['title', 'handle', 'image', 'excerpt'])
    .list()

Check for more pages

const { items, pageInfo } = await shoppy.articles.limit(10).list()

if (pageInfo.hasNextPage) {
    // More articles available
}