Package com.commercetools.api.client

Class ByProjectKeyMeShoppingListsByIDDelete

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

Deletes the ShoppingList for a given id. Returns a 200 OK status if successful.

A ResourceNotFound error is returned in the following scenarios:

  • If no ShoppingList exists for the given id.
  • If a ShoppingList exists 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.ShoppingList>> result = apiRoot
            .withProjectKey("{projectKey}")
            .me()
            .shoppingLists()
            .withId("{ID}")
            .delete()
            .withVersion(version)
            .execute()