Description

Topic: Categories

Fields

ancestors: [CategoryAncestor!]!

Category ancestors

content_image_files: [StorefrontFile]

Image files referenced by "raw_content".

Translatable

Expandable

Permission bit: "files.read"

created_at: String!

The date and time when the category was created, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

custom_field_objects: StorefrontCustomFieldObjects

Custom field objects extracted and ready for expansion

Translatable

custom_fields: [CustomField!]!

featured: Boolean!

States whether or not the category is featured

Example: false

handle: String!

An URL-friendly unique string for the category automatically generated from its title

Example: "ipods"

has_children: Boolean!

Whether category has children or not

Example: false

id: String!

Unique category identifier. See also: Unique Identifiers

Example: "ca_EQzGqWoY"

image_files: [StorefrontFile]

Images files for this category

Translatable

Expandable

Permission bit: "files.read"

meta_description: String!

Meta description for SEO purposes

Translatable

meta_title: String!

SEO-friendly title of the category

Translatable

published: Boolean!

Whether server thinks category is published or not (depends on server time)

Example: false

published_at: String

The date and time when the category was published or null

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

raw_content: String!

Raw content of the category

Translatable

Example: "{}"

sort_order: CategorySortOrder!

The default order in which products in the category appear

title: String!

The name of the category

Translatable

Example: "IPods"

updated_at: String!

The date and time when the category was last updated, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

Used By

Queries

storefrontCategories

Types

StorefrontCategoryCount, StorefrontCategoryExpandableItems, StorefrontCustomFieldObjects, StorefrontMenuItem, StorefrontProduct

Preview (typescript)

interface StorefrontCategory {
ancestors: CategoryAncestor[]
content_image_files?: (StorefrontFile | null)[]
created_at: string
custom_field_objects?: StorefrontCustomFieldObjects | null
custom_fields: CustomField[]
featured: boolean
handle: string
has_children: boolean
id: string
image_files?: (StorefrontFile | null)[]
meta_description: string
meta_title: string
published: boolean
published_at?: string
raw_content: string
sort_order: CategorySortOrder
title: string
updated_at: string
}