ShopifyCollection

interface

import { ShopifyCollection } from '@daffodil/driver/shopify'

A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse.

interface ShopifyCollection {
  __typename: "Collection"
  description: string
  descriptionHtml: Scalars['HTML']['output']
  handle: string
  id: string
  image: ShopifyImage
  metafield: ShopifyMetafield
  metafields: ShopifyMetafield[]
  onlineStoreUrl: Maybe<Scalars['URL']['output']>
  products: ShopifyProductConnection
  seo: ShopifySeo
  title: string
  trackingParameters: string
  updatedAt: Scalars['DateTime']['output']
}

Properties

__typename `"Collection"`

description `string`
Stripped description of the collection, single line with HTML tags removed.

descriptionHtml `Scalars['HTML']['output']`
The description of the collection, complete with HTML formatting.

handle `string`
A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

id `string`
A globally-unique ID.

image `ShopifyImage`
Image associated with the collection.

metafield `ShopifyMetafield`
A custom field, including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.

metafields `ShopifyMetafield[]`
A list of custom fields that a merchant associates with a Shopify resource.

onlineStoreUrl `Maybe<Scalars['URL']['output']>`
The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.

products `ShopifyProductConnection`
List of products in the collection.

seo `ShopifySeo`
The collection's SEO information.

title `string`
The collection’s name. Limit of 255 characters.

trackingParameters `string`
URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

updatedAt `Scalars['DateTime']['output']`
The date and time when the collection was last modified.