Skip to main content

PublicTaxonomyBranch

TaxonomyBranch is an item within a taxonomyTree that maps out a Product Taxonomy hierarchy using Product Tags and Collections.

type PublicTaxonomyBranch {
  collection: PublicCollection
  collectionId: ID
  createdAt: Date!
  demandHqId: ID!
  parentTaxonomyBranch: PublicTaxonomyBranch
  parentTaxonomyBranchId: ID
  productTag: String!
  storefrontIds: [ID!]
  taxonomyBranchId: ID!
  taxonomyBranches(
  after: String
  before: String
  first: Int
  last: Int
): PublicTaxonomyBranchConnection!
  taxonomyLevel: TaxonomyLevel!
  taxonomyTree: String!
  title: String!
  updatedAt: Date!
  updatedBy: ID!
}

Fields​

PublicTaxonomyBranch.collection ● PublicCollection object​

Get the collection for a taxonomy branch.

Requires the publiccollection/read scope.

PublicTaxonomyBranch.collectionId ● ID scalar​

The collectionId associated with the TaxonomyBranch. Not required as a field, but is strongly suggested to be populated, and one is generally created with a TaxonomyBranch.

PublicTaxonomyBranch.createdAt ● Date! non-null scalar​

PublicTaxonomyBranch.demandHqId ● ID! non-null scalar​

PublicTaxonomyBranch.parentTaxonomyBranch ● PublicTaxonomyBranch object​

The parent TaxonomyBranch for this TaxonomyBranch.

Requires the publictaxonomybranch/read permission.

PublicTaxonomyBranch.parentTaxonomyBranchId ● ID scalar​

All TaxonomyBranches besides the root have a parentTaxonomyBranchId. Immutable.

PublicTaxonomyBranch.productTag ● String! non-null scalar​

The product tag associated with this TaxonomyBranch, used for filtering or display matching.

On a Root TaxonomyBranch, this is generally a taxPrefix that is used in all child TaxonomyBranches, i.e. "Taxonomy" for child branch productTags like "Taxonomy,Category,T-Shirts"

PublicTaxonomyBranch.storefrontIds ● [ID!] list scalar​

The storefronts this taxonomyTree is published to. This is only present on the Root TaxonomyBranch of a taxonomyTree and applies to all child taxonomyBranches.

PublicTaxonomyBranch.taxonomyBranchId ● ID! non-null scalar​

PublicTaxonomyBranch.taxonomyBranches ● PublicTaxonomyBranchConnection! non-null object​

List Child TaxonomyBranches for a TaxonomyBranch.

Requires the publictaxonomybranch/read permission.

PublicTaxonomyBranch.taxonomyBranches.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

PublicTaxonomyBranch.taxonomyBranches.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

PublicTaxonomyBranch.taxonomyBranches.first ● Int scalar​

Returns the first n elements from the list.

PublicTaxonomyBranch.taxonomyBranches.last ● Int scalar​

Returns the last n elements from the list.

PublicTaxonomyBranch.taxonomyLevel ● TaxonomyLevel! non-null enum​

The level of the TaxonomyBranch in the hierarchy. Immutable.

PublicTaxonomyBranch.taxonomyTree ● String! non-null scalar​

The tree this taxonomyBranch lies within. This has slug formatting (Lowercase, no spaces). Immutable.

PublicTaxonomyBranch.title ● String! non-null scalar​

The name of the taxonomyBranch.

PublicTaxonomyBranch.updatedAt ● Date! non-null scalar​

PublicTaxonomyBranch.updatedBy ● ID! non-null scalar​

Member of​

PublicTaxonomyBranch object ● PublicTaxonomyBranchConnection object ● PublicTaxonomyBranchEdge object