Skip to main content
shoppy.articles.select(fields)
Specifies which fields to include in the response. Use this to optimize query performance by only requesting needed data.

Parameters

ParamTypeRequiredDescription
fieldsArticleField[]YesArray of field names

Returns

ArticlesQueryBuilder (chainable)

Available Fields

type ArticleField =
    | 'id'
    | 'handle'
    | 'title'
    | 'content'
    | 'contentHtml'
    | 'excerpt'
    | 'excerptHtml'
    | 'publishedAt'
    | 'image'
    | 'blog'
    | 'author'
    | 'tags'
    | 'onlineStoreUrl'
    | 'seo'

Examples

Select specific fields

const { items } = await shoppy.articles
    .select(['title', 'handle', 'image'])
    .list()

Minimal data for listing

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

Full content for article page

const article = await shoppy.articles
    .select(['title', 'contentHtml', 'image', 'author', 'publishedAt', 'seo'])
    .get('gid://shopify/Article/123')