Skip to main content

ShopifyArticle

interface ShopifyArticle {
    id: string
    handle: string
    title: string
    content: string
    contentHtml: string
    excerpt: string | null
    excerptHtml: string | null
    publishedAt: string
    image: ShopifyImage | null
    blog: ShopifyBlog
    author: ShopifyArticleAuthor
    tags: string[]
    onlineStoreUrl: string | null
    seo: ShopifySeo
}

ShopifyBlog

interface ShopifyBlog {
    id: string
    handle: string
    title: string
    onlineStoreUrl: string | null
    seo: ShopifySeo
}

ShopifyArticleAuthor

interface ShopifyArticleAuthor {
    name: string
    email: string | null
    bio: string | null
}

ArticlesResult

Response from shoppy.articles.list()
interface ArticlesResult {
    items: ShopifyArticle[]
    pageInfo: ShopifyPageInfo
}

ArticleField

Available fields for .select() on articles.
type ArticleField =
    | 'id'
    | 'handle'
    | 'title'
    | 'content'
    | 'contentHtml'
    | 'excerpt'
    | 'excerptHtml'
    | 'publishedAt'
    | 'image'
    | 'blog'
    | 'author'
    | 'tags'
    | 'onlineStoreUrl'
    | 'seo'