Package com.commercetools.api.client

Class ByProjectKeyProductProjectionsGet

java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyProductProjectionsGet,ProductProjectionPagedQueryResponse>
com.commercetools.api.client.ByProjectKeyProductProjectionsGet
All Implemented Interfaces:
AttributefilteringTrait<ByProjectKeyProductProjectionsGet>, ByProjectKeyProductProjectionsGetMixin, Deprecatable200Trait<ByProjectKeyProductProjectionsGet>, ErrorableTrait<ByProjectKeyProductProjectionsGet>, ExpandableTrait<ByProjectKeyProductProjectionsGet>, LocaleprojectingTrait<ByProjectKeyProductProjectionsGet>, PagedQueryResourceRequest<ByProjectKeyProductProjectionsGet,ProductProjectionPagedQueryResponse,com.commercetools.api.predicates.query.product.ProductProjectionQueryBuilderDsl>, PagingTrait<ByProjectKeyProductProjectionsGet>, PriceselectingTrait<ByProjectKeyProductProjectionsGet>, ProjectionselectingTrait<ByProjectKeyProductProjectionsGet>, QueryTrait<ByProjectKeyProductProjectionsGet>, SimplePagedQueryResourceRequest<ByProjectKeyProductProjectionsGet,ProductProjectionPagedQueryResponse,com.commercetools.api.predicates.query.product.ProductProjectionQueryBuilderDsl>, SortableTrait<ByProjectKeyProductProjectionsGet>, StoreprojectingtailoringTrait<ByProjectKeyProductProjectionsGet>, ClientRequestCommand<ProductProjectionPagedQueryResponse>, CreateHttpRequestCommand, HttpRequestCommand<ProductProjectionPagedQueryResponse>, RequestCommand<ProductProjectionPagedQueryResponse>
public class ByProjectKeyProductProjectionsGet extends TypeApiMethod<ByProjectKeyProductProjectionsGet,ProductProjectionPagedQueryResponse> implements ByProjectKeyProductProjectionsGetMixin, ProjectionselectingTrait<ByProjectKeyProductProjectionsGet>, PriceselectingTrait<ByProjectKeyProductProjectionsGet>, LocaleprojectingTrait<ByProjectKeyProductProjectionsGet>, StoreprojectingtailoringTrait<ByProjectKeyProductProjectionsGet>, AttributefilteringTrait<ByProjectKeyProductProjectionsGet>, ExpandableTrait<ByProjectKeyProductProjectionsGet>, SortableTrait<ByProjectKeyProductProjectionsGet>, PagingTrait<ByProjectKeyProductProjectionsGet>, QueryTrait<ByProjectKeyProductProjectionsGet>, ErrorableTrait<ByProjectKeyProductProjectionsGet>, Deprecatable200Trait<ByProjectKeyProductProjectionsGet>

Retrieves the projected representation of Products by query predicates.

By default, this endpoint returns the current representation of Products where the published flag is true. If a Product is unpublished (published=false), the endpoint returns a Not Found error.

Required access scopes:

  • To retrieve the current representation of published Products (published data), the view_published_products:{projectKey} scope is required.

  • To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the view_products:{projectKey} scope.


   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.product.ProductProjectionPagedQueryResponse>> result = apiRoot
            .withProjectKey("{projectKey}")
            .productProjections()
            .get()
            .execute()