ProductTaxonomyValue
Describes a product taxonomy value.
Type Definition
type ProductTaxonomyValue {
translatedName: String
}Fields
| Field | Type | Description | Nullable | Relationship |
|---|---|---|---|---|
| translatedName | String | Returns the translated name. | Yes | None |
Relationships
- FilterValue.taxonomyValue: The
ProductTaxonomyValueobject is used as the type for thetaxonomyValuefield in theFilterValueobject. - ProductOptionValue.taxonomyValue: It is also used as the type for the
taxonomyValuefield in theProductOptionValueobject.
These relationships indicate that ProductTaxonomyValue provides taxonomy details related to filter values and product option values.
Usage Examples
Basic Query
{
productTaxonomyValue {
translatedName
}
}Field Selection
{
productTaxonomyValue {
translatedName
}
}Nested Queries
Since ProductTaxonomyValue only contains a scalar field translatedName and no nested objects, nested queries are not applicable.
Filtering and Sorting
The ProductTaxonomyValue type itself does not support filtering or sorting directly. Filtering or sorting would be applied on the parent objects such as FilterValue or ProductOptionValue that reference this type.
Implements
This type does not implement any interfaces.
Connections
ProductTaxonomyValue does not define any connection fields.
Related Types
- FilterValue: Contains a
taxonomyValuefield of typeProductTaxonomyValue. - ProductOptionValue: Contains a
taxonomyValuefield of typeProductTaxonomyValue.
Best Practices
- Use the
translatedNamefield to display localized taxonomy values in your UI. - Since
translatedNameis optional, always check for null or undefined values in your client code to avoid runtime errors. - Leverage the relationships from
FilterValueandProductOptionValueto access taxonomy information relevant to filters and product options.
Notes
- The
translatedNamefield is a computed field that returns the localized name of the taxonomy value based on the current locale or language settings. - This API currently requires no authentication, but this may change in future versions. Plan your integration accordingly.
- Because this type contains only a single optional scalar field, querying it has minimal performance impact.
- When using this field in large queries, consider caching results on the client side to reduce redundant requests.
Last updated on