Skip to main content

TaxonomyBranchCreateInput

The input for creating a TaxonomyBranch.

input TaxonomyBranchCreateInput {
  collectionId: ID
  demandHqId: ID!
  parentTaxonomyBranchId: ID
  productTag: String!
  storefrontIds: [ID!]
  taxonomyLevel: TaxonomyLevel!
  taxonomyTree: String!
  title: String!
}

Fields​

TaxonomyBranchCreateInput.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.

TaxonomyBranchCreateInput.demandHqId ● ID! non-null scalar​

TaxonomyBranchCreateInput.parentTaxonomyBranchId ● ID scalar​

All TaxonomyBranches besides the root have a parentTaxonomyBranchId. Immutable.

TaxonomyBranchCreateInput.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"

TaxonomyBranchCreateInput.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.

TaxonomyBranchCreateInput.taxonomyLevel ● TaxonomyLevel! non-null enum​

The level of the TaxonomyBranch in the hierarchy. Immutable.

TaxonomyBranchCreateInput.taxonomyTree ● String! non-null scalar​

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

TaxonomyBranchCreateInput.title ● String! non-null scalar​

The name of the taxonomyBranch.

Member of​

createTaxonomyBranch mutation