Package com.commercetools.api.client

Class ByProjectKeyInStoreKeyByStoreKeyVariantProjectionsKeyByKeyGet

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

Retrieves a Variant Projection by its key in the specified Store.

Only returns Variants belonging to Products distributed through the Store's configured channels.

If a ProductTailoring exists for the Product and the given Store, the returned Variant Projection includes 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 the Product and Store, the Variant Projection is returned without Product Tailoring data.

Required access scopes:

  • To retrieve the current representation, 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.VariantProjection>> result = apiRoot
            .withProjectKey("{projectKey}")
            .inStoreKeyWithStoreKeyValue("{storeKey}")
            .variantProjections()
            .withKey("{key}")
            .get()
            .execute()