Package com.commercetools.api.client

Class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet

java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet,ShoppingListPagedQueryResponse>
com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet
All Implemented Interfaces:
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGetMixin, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, PagedQueryResourceRequest<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet,ShoppingListPagedQueryResponse,com.commercetools.api.predicates.query.shopping_list.ShoppingListQueryBuilderDsl>, PagingTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, QueryTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, SimplePagedQueryResourceRequest<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet,ShoppingListPagedQueryResponse,com.commercetools.api.predicates.query.shopping_list.ShoppingListQueryBuilderDsl>, SortableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, ClientRequestCommand<ShoppingListPagedQueryResponse>, CreateHttpRequestCommand, HttpRequestCommand<ShoppingListPagedQueryResponse>, RequestCommand<ShoppingListPagedQueryResponse>
public class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet,ShoppingListPagedQueryResponse> implements ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGetMixin, ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, SortableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, PagingTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, QueryTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet>

Returns ShoppingLists that match the given Query Predicate in a Store. Returns 200 OK status if successful.

A ResourceNotFound error is returned in the following scenarios:

  • If no ShoppingLists exist in a Store.
  • If a ShoppingList exists but does not have a store specified, or the store field references a different Store.
  • If a ShoppingList exists in a Store but does not contain either an anonymousId that matches the anonymous_id:{id} scope, or a customer with id value that matches the customer:{id} scope.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shopping_list.ShoppingListPagedQueryResponse>> result = apiRoot
            .withProjectKey("{projectKey}")
            .inStoreKeyWithStoreKeyValue("{storeKey}")
            .me()
            .shoppingLists()
            .get()
            .execute()