Skip to Content
StoreOSv0.27.1
Storefront GraphQL APIReferenceObjects

StorefrontCollection

typeStorefrontCollection

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)

tenant?String
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

Returned by
QUERYcollectionQUERYcollectionById
SDL
type StorefrontCollection {  _id: ID!  logo: ServerFileReference  name: String  slug: String  description: String  parentCategory: ID  level: Int  sortOrder: Int  children: [Collection!]  tenant: String  createdAt: DateTime  updatedAt: DateTime}