TaxonomyBranch

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

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

Fields

`TaxonomyBranch.collection` ● `Collection` object

The Collection associated with this TaxonomyBranch.

Requires the collection/read permission on the given DemandHq

`TaxonomyBranch.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.

`TaxonomyBranch.createdAt` ● `Date!` non-null scalar

`TaxonomyBranch.demandHqId` ● `ID!` non-null scalar

`TaxonomyBranch.parentTaxonomyBranch` ● `TaxonomyBranch` object

Get the parent TaxonomyBranch for a TaxonomyBranch.

Requires the user to have the taxonomyBranch/read permission on the associated DemandHq.

`TaxonomyBranch.parentTaxonomyBranchId` ● `ID` scalar

All TaxonomyBranches besides the root have a parentTaxonomyBranchId. Immutable.

`TaxonomyBranch.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"

`TaxonomyBranch.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.