ccrz.ccApiCart.removeCart

Deletes cart records, including wish lists. If a deleted cart or wish list was active for the current account, this method also determines which cart or wish list becomes active next.

Compatibility

This reference applies to:

Release Managed Package Version API Version
B2B Commerce for Visualforce Winter ’21 4.13 12
B2B Commerce for Visualforce Spring ’20 4.12 11
B2B Commerce for Visualforce Summer ’19 4.11 10
B2B Commerce for Visualforce Spring ’19 4.10 9
B2B Commerce for Visualforce Summer ’18 4.9 8

You can still call older versions of the API for this method, which can accept different input keys or return different output keys. Any differences in behavior for older versions aren't documented in this topic.

Note

Service Layer Classes

Logic Service Provider
ccrz.ccLogicCartRemoveCart

Inputs (Required)

Map<String, Object> that must include the following required keys:

ccrz.ccApi.API_VERSION
The version of the B2B Commerce for Visualforce API to reference for the method call. We recommend that you use the ccrz.ccApi.CURRENT_VERSION constant whenever possible, and only reference a specific version for compatibility if necessary.

If this key isn't specified, the method returns a ccrz.ccApi.NoApiVersionException.

Note

Include one of the following keys. If none of these keys are included, the method returns a ccrz.ccApi.MissingInputException.

ccrz.ccApiCart.CART_ENCID
String that specifies the encrypted ID of the cart to delete.
ccrz.ccApiCart.CART_ENCIDLIST
Set<String> of encrypted IDs of the carts to delete.
ccrz.ccApiCart.CART_ID
String that specifies the ID of a cart to delete.
ccrz.ccApiCart.CART_IDLIST
Set<String> of IDs of carts to delete.

Outputs

Map<String, Object> that can include the following keys:

ccrz.ccApi.API_VERSION
Integer that indicates which API version was used for the query.
ccrz.ccApi.MESSAGES
List<ccrz.cc_bean_Message>, where each ccrz.cc_bean_Message contains error information sent from the server to the client. Typically, these messages are included only when ccrz.ccApi.SUCCESS is FALSE.
ccrz.ccApi.SUCCESS
Boolean
Value Usage
true The call completed.
false The call encountered errors.

B2B Commerce for Visualforce doesn't always return an exception for any errors that can occur. When this value is false, consider rolling back the API transaction to a previous savepoint.

Tip