CommerceCart Class

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.BatchResult[] addItemsToCart(String webstoreId, String effectiveAccountId, String activeCartOrId, List<ConnectApi.BatchInput> cartItems)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

cartItems

Type: List<ConnectApi.BatchInput>

The list can contain up to 100 ConnectApi.BatchInput objects. In the ConnectApi.BatchInput constructor, the input object must be ConnectApi.CartItemInput.

Return Value

Type: ConnectApi.BatchResult[]

The ConnectApi.BatchResult.getResult() method returns a ConnectApi.CartItem object.

The returned objects correspond to each of the input objects and are returned in the same order as the input objects.

The method call fails only if an error occurs that affects the entire operation (such as a parsing failure). If an individual object causes an error, the error is embedded within the ConnectApi.BatchResult list.

Usage

Buyers with read access to carts can add, update, and delete items in carts.

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartItem addItemToCart(String webstoreId, String effectiveAccountId, String activeCartOrId, ConnectApi.CartItemInput cartItemInput)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

cartItemInput

Type: ConnectApi.CartItemInput

A ConnectApi.CartItemInput object representing an item to add to the cart.

Return Value

Type: ConnectApi.CartItem

Usage

Buyers with read access to carts can add, update, and delete items in carts.

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

API Version

54.0

Requires Chatter

No

Signature

public static ConnectApi.CartCouponCollection applyCartCoupon(String webstoreId, String effectiveAccountId, String activeCartOrId, ConnectApi.cartCouponInput cartCouponInput)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

cartCouponInput

Type: ConnectApi.cartCouponInput

Coupon code for the coupon.

Return Value

Type: ConnectApi.CartCouponCollection

API Version

50.0

Requires Chatter

No

Signature

public static ConnectApi.CartToWishlistResult copyCartToWishlist(String webstoreId, String effectiveAccountId, String activeCartOrId, ConnectApi.CartToWishlistInput cartToWishlistInput)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

cartToWishlistInput

Type: ConnectApi.CartToWishlistInput

A ConnectApi.CartToWishlistInput object indicating the wishlist to copy products to.

Return Value

Type: ConnectApi.CartToWishlistResult

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartSummary createCart(String webstoreId, ConnectApi.CartInput cart)

Parameters

webstoreId

Type: String

ID of the webstore.

cart

Type: ConnectApi.CartInput

A ConnectApi.CartInput object representing a cart.

Return Value

Type: ConnectApi.CartSummary

Usage

Buyers with read access to carts can create and delete carts.

API Version

49.0

Requires Chatter

No

Signature

public static Void deleteCart(String webstoreId, String effectiveAccountId, String activeCartOrId)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

Return Value

Type: Void

Usage

Buyers with read access to carts can create and delete carts.

API Version

54.0

Requires Chatter

No

Signature

public static Void deleteCartCoupon(String webstoreId, String effectiveAccountId, String activeCartOrId, String cartCouponId)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

cartCouponId

Type: String

ID of the cart coupon.

Return Value

Type: Void

API Version

49.0

Requires Chatter

No

Signature

public static Void deleteCartItem(String webstoreId, String effectiveAccountId, String activeCartOrId, String cartItemId)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

cartItemId

Type: String

ID of the cart item.

Return Value

Type: Void

Usage

Buyers with read access to carts can add, update, and delete items in carts.

API Version

54.0

Requires Chatter

No

Signature

public static ConnectApi.CartCouponCollection getCartCoupons(String webstoreId, String effectiveAccountId, String activeCartOrId)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

Return Value

Type: ConnectApi.CartCouponCollection

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartItemCollection getCartItems(String webstoreId, String effectiveAccountId, String activeCartOrId)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

Return Value

Type: ConnectApi.CartItemCollection

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartItemCollection getCartItems(String webstoreId, String effectiveAccountId, String activeCartOrId, String pageParam)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

pageParam

Type: String

Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

Return Value

Type: ConnectApi.CartItemCollection

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartItemCollection getCartItems(String webstoreId, String effectiveAccountId, String activeCartOrId, String pageParam, ConnectApi.CartItemSortOrder sortParam)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

pageParam

Type: String

Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

sortParam

Type: ConnectApi.CartItemSortOrder

Sort order for items in a cart. Values are:

• CreatedDateAsc—Sorts by oldest creation date.
• CreatedDateDesc—Sorts by most recent creation date.
• NameAsc—Sorts by name in ascending alphabetical order (A–Z).
• NameDesc—Sorts by name in descending alphabetical order (Z–A).
• SalesPriceAsc—Sorts from lowest to highest negotiated price.
• SalesPriceDesc—Sorts from highest to lowest negotiated price.

If null, the default is CreatedDateDesc.

Return Value

Type: ConnectApi.CartItemCollection

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartItemCollection getCartItems(String webstoreId, String effectiveAccountId, String activeCartOrId, String pageParam, Integer pageSize)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

pageParam

Type: String

Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.CartItemCollection

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartItemCollection getCartItems(String webstoreId, String effectiveAccountId, String activeCartOrId, String pageParam, Integer pageSize, ConnectApi.CartItemSortOrder sortParam)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

pageParam

Type: String

Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Type: ConnectApi.CartItemSortOrder

Sort order for items in a cart. Values are:

• CreatedDateAsc—Sorts by oldest creation date.
• CreatedDateDesc—Sorts by most recent creation date.
• NameAsc—Sorts by name in ascending alphabetical order (A–Z).
• NameDesc—Sorts by name in descending alphabetical order (Z–A).
• SalesPriceAsc—Sorts from lowest to highest negotiated price.
• SalesPriceDesc—Sorts from highest to lowest negotiated price.

If null, the default is CreatedDateDesc.

Return Value

Type: ConnectApi.CartItemCollection

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartItemCollection getCartItems(String webstoreId, String effectiveAccountId, String activeCartOrId, String productFields, String pageParam, Integer pageSize, ConnectApi.CartItemSortOrder sortParam)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

productFields

Type: String

Comma-separated list of up to five product fields. Results include fields that you have access to. Some product fields (such as productName and sku) are returned even when not included in the productFields parameter.

pageParam

Type: String

Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Type: ConnectApi.CartItemSortOrder

Sort order for items in a cart. Values are:

• CreatedDateAsc—Sorts by oldest creation date.
• CreatedDateDesc—Sorts by most recent creation date.
• NameAsc—Sorts by name in ascending alphabetical order (A–Z).
• NameDesc—Sorts by name in descending alphabetical order (Z–A).
• SalesPriceAsc—Sorts from lowest to highest negotiated price.
• SalesPriceDesc—Sorts from highest to lowest negotiated price.

If null, the default is CreatedDateDesc.

Return Value

Type: ConnectApi.CartItemCollection

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartSummary getCartSummary(String webstoreId, String effectiveAccountId, String activeCartOrId)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete. If you specify active and there isn’t an active cart, you get an error.

Return Value

Type: ConnectApi.CartSummary

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartSummary getOrCreateActiveCartSummary(String webstoreId, String effectiveAccountId, String activeCartOrId)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete. If you specify active and there isn’t an active cart, one is created.

Return Value

Type: ConnectApi.CartSummary

Usage

Buyers with read access to carts can create and delete carts.

API Version

53.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommerceActionResult makeCartPrimary(String webstoreId, String activeCartOrId, String effectiveAccountId)

Parameters

webstoreId

Type: String

ID of the webstore.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

Return Value

Type: ConnectApi.CommerceActionResult

API Version

50.0

Requires Chatter

No

Signature

public static ConnectApi.CartMessagesVisibilityResult setCartMessagesVisibility(String webstoreId, String activeCartOrId, String effectiveAccountId, ConnectApi.CartMessagesVisibilityInput messageVisibility)

Parameters

webstoreId

Type: String

ID of the webstore.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

messageVisibility

Type: ConnectApi.CartMessagesVisibilityInput

A ConnectApi.CartMessagesVisibilityInput object specifying the visibility setting.

Return Value

Type: ConnectApi.CartMessagesVisibilityResult

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.CartItem updateCartItem(String webstoreId, String effectiveAccountId, String activeCartOrId, String cartItemId, ConnectApi.CartItemInput cartItem)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

activeCartOrId

Type: String

ID of the cart, active, or current. The current value is available in version 50.0 and later and indicates a cart with a status that isn’t Closed or PendingDelete.

cartItemId

Type: String

ID of the cart item.

cartItem

Type: ConnectApi.CartItemInput

A ConnectApi.CartItemInput object representing a cart item to update.

Return Value

Type: ConnectApi.CartItem

Usage

Buyers with read access to carts can add, update, and delete items in carts.

This method respects buyer View Product entitlements and only users entitled to view product data can access it.