Package com.commercetools.api.client

Class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyHead

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

Checks if a ShoppingList exists with the provided key for the authenticated Customer or anonymous user in a Store. Returns a 200 status if successful.

A Not Found error is returned in the following scenarios:

  • If no ShoppingList exists that matches the provided key in a Store.
  • If a ShoppingList matches the provided key but does not have a store specified, or the store field references a different Store.
  • If a ShoppingList matches the provided key 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.fasterxml.jackson.databind.JsonNode>> result = apiRoot
            .withProjectKey("{projectKey}")
            .inStoreKeyWithStoreKeyValue("{storeKey}")
            .me()
            .shoppingLists()
            .withKey("{key}")
            .head()
            .execute()