Package com.commercetools.api.client

Class ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet

java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet,VariantProjectionPagedQueryResponse>
com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet
All Implemented Interfaces:
AttributefilteringTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, LocaleprojectingTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, PagingTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, PriceselectingTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, ProjectionselectingvariantTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, QueryTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, SortableTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, ClientRequestCommand<VariantProjectionPagedQueryResponse>, CreateHttpRequestCommand, HttpRequestCommand<VariantProjectionPagedQueryResponse>, RequestCommand<VariantProjectionPagedQueryResponse>
public class ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet,VariantProjectionPagedQueryResponse> implements ProjectionselectingvariantTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, PriceselectingTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, LocaleprojectingTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, AttributefilteringTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, SortableTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, PagingTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, QueryTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsGet>

Queries Variant Projections in the specified Store.

Only Variants belonging to Products distributed through the Store's configured channels are returned. By default, this endpoint returns the current representation of Variants where the published flag is true.

If a ProductTailoring exists for a Product and the given Store, the returned Variant Projections include the tailored Product name, slug, and description, along with the tailored Variant images, assets, and attributes. The staged query parameter selects either the current or staged tailored data. When no Product Tailoring exists for a Product and Store, the Variant Projection is returned without Product Tailoring data.

Required access scopes:

  • To retrieve the current representation of published Variants, the view_published_products:{projectKey} scope is required.

  • To retrieve the staged representation, the API Client must have the view_products:{projectKey} scope.

  • To access Variant Projections in the context of a Store, the view_products:{projectKey}:{storeKey} scope is required.


   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.variant.VariantProjectionPagedQueryResponse>> result = apiRoot
            .withProjectKey("{projectKey}")
            .inStoreKeyWithStoreKeyValue("{storeKey}")
            .variantProjections()
            .get()
            .execute()