Skip to Content
StoreOSv0.27.1
Storefront GraphQL APIReferenceObjects

Collection

typeCollection

Fields

  1. fields
_id*ID!
logo?
name?String
slug?String

URL handle used in storefront links (/collections/{slug})

description?String
parentCategory?ID

Parent collection ID for subcollection hierarchy

level?Int

Depth level in the hierarchy

sortOrder?Int

Position among sibling collections (ascending). Ties sort by name.

children?

Child subcollections (populated via virtual)

isDemo?Boolean
tenant?String
commits?
createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

updatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

Usages

Field of
Collection.childrenProduct.collectionsStorefrontCollection.childrenStorefrontProduct.collections
SDL
type Collection {  _id: ID!  logo: ServerFileReference  name: String  slug: String  description: String  parentCategory: ID  level: Int  sortOrder: Int  children: [Collection!]  isDemo: Boolean  tenant: String  commits: [ResourceCommitHistoryReference!]  createdAt: DateTime  updatedAt: DateTime}