Package com.commercetools.api.client

Class ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet

java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet,VariantAttributes>
com.commercetools.api.client.ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet
All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, ErrorableTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, LocaleprojectingTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, ProjectionselectingTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, SupplychannelfilteringTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, VariantattributefilteringTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, ClientRequestCommand<VariantAttributes>, CreateHttpRequestCommand, HttpRequestCommand<VariantAttributes>, RequestCommand<VariantAttributes>
public class ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet extends TypeApiMethod<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet,VariantAttributes> implements ProjectionselectingTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, LocaleprojectingTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, VariantattributefilteringTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, SupplychannelfilteringTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, ErrorableTrait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>, Deprecatable200Trait<ByProjectKeyProductProjectionsKeyByKeyVariantAttributesGet>

Returns a lightweight representation of all Variants for a Product, including only the requested variant-level Attributes and minimal availability data.

Designed for building attribute selectors on product detail pages (PDPs) with large numbers of variants. Only available for Projects with productCatalogModel set to Modular.

Product-level Attributes are omitted from the response.

Required access scopes:

  • To retrieve the current representation of published Products (published data), the view_published_products:{projectKey} or view_products:{projectKey} scope is required.
  • To retrieve the staged representation of Products (draft data), the API Client must have the view_products:{projectKey} scope.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.variant_attributes.VariantAttributes>> result = apiRoot
            .withProjectKey("{projectKey}")
            .productProjections()
            .withKey("{key}")
            .variantAttributes()
            .get()
            .withFilterAttributes(filterAttributes)
            .execute()