Skip to main content

aggregatedAdditionalProperties

Fetch BU-specific aggregated additional properties based on tenant dynamic entity templates defined on the Business Unit Group hierarchy.

**Returns:** Business unit specific aggregated additional properties.

aggregatedAdditionalProperties(
  businessUnitId: String!
  entityType: EntityType
  itemCategoryId: String
  includeAllItemCategories: Boolean
): [AggregatedAdditionalProperty]

Arguments​

aggregatedAdditionalProperties.businessUnitId ● String! non-null scalar​

The ID of the business unit.

aggregatedAdditionalProperties.entityType ● EntityType enum​

The type of the entity the aggregated additional properties will be returned for. If not provided, the endpoint will return the aggregated additional properties for all entity types found.

aggregatedAdditionalProperties.itemCategoryId ● String scalar​

The ID of the item category. When provided, its properties are returned alongside the item-category-agnostic ones.

aggregatedAdditionalProperties.includeAllItemCategories ● Boolean scalar​

When true, returns the aggregated additional properties for every item category found in the hierarchy in addition to the item-category-agnostic ones. Ignored when itemCategoryId is provided.

Type​

AggregatedAdditionalProperty object​

Extended additional property with metadata from the template.