CommerceCart Class

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.

addItemToCart(webstoreId, effectiveAccountId, activeCartOrId, cartItemInput, currencyIsoCode, includeCartData)

Add an item to a cart of a specific currency.

API Version

64.0

Available to Guest Users

51.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
cartItemInput: Type: ConnectApi.CartItemInput; A ConnectApi.CartItemInput object representing an item to add to the cart.
currencyIsoCode: Type: String; The currency ISO code of the cart.
includeCartData: Type: Boolean; Specifies whether to return a collection of cart items in the response (true) or not (false). If unspecified, the default value is false. This parameter is supported for D2C stores with Faster Add-to-Cart disabled. The cart must also have fewer than 25 items.

Return Value

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.

addItemsToCart(webstoreId, effectiveAccountId, activeCartOrId, cartItems)

Add a batch of up to 100 items to a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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.

addItemsToCart(webstoreId, effectiveAccountId, activeCartOrId, cartItems, currencyIsoCode)

Add a batch of up to 100 items to a cart of a specific currency.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
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.
currencyIsoCode: Type: String; The currency ISO code of the cart.

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.

addItemToCart(webstoreId, effectiveAccountId, activeCartOrId, cartItemInput)

Add an item to a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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

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.

applyCartCoupon(webstoreId, effectiveAccountId, activeCartOrId, cartCouponInput)

Apply a coupon to a cart.

API Version

54.0

Available to Guest Users

57.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
cartCouponInput: Type: ConnectApi.cartCouponInput; Coupon code for the coupon.

Return Value

applyCartCoupon(webstoreId, effectiveAccountId, activeCartOrId, cartCouponInput, currencyIsoCode)

Apply a coupon to a cart.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
cartCouponInput: Type: ConnectApi.cartCouponInput; Coupon code for the coupon.
currencyIsoCode: Type: String; Currency ISO code of the cart.

Return Value

copyCartToWishlist(webstoreId, effectiveAccountId, activeCartOrId, cartToWishlistInput)

Copy the products from a cart to a wishlist.

API Version

50.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
cartToWishlistInput: Type: ConnectApi.CartToWishlistInput; A ConnectApi.CartToWishlistInput object indicating the wishlist to copy products to.

Return Value

Type: ConnectApi.CartToWishlistResult

calculateCart(webstoreId, activeCartOrId, effectiveAccountId)

Calculate a cart.

API Version

62.0

Available to Guest Users

62.0

Requires Chatter

No

Signature

public static ConnectApi.CalculateCartResult calculateCart(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 indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.

Return Value

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.

calculateCart(webstoreId, activeCartOrId, effectiveAccountId, calculateCartInput)

Calculate a cart.

API Version

63.0

Available to Guest Users

62.0

Requires Chatter

No

Signature

public static ConnectApi.CalculateCartResult calculateCart(String webstoreId, String activeCartOrId, String effectiveAccountId, ConnectApi.CalculateCartInput calculateCartInput)

Parameters

webstoreId: Type: String; ID of the webstore.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
calculateCartInput: Type: ConnectApi.CalculateCartInput; A ConnectApi.CalculateCartInput object representing any custom fields for the cart.

Return Value

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.

createCart(webstoreId, cart)

Create a cart.

API Version

49.0

Available to Guest Users

54.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

Usage

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

cloneCart(webstoreId, activeCartOrId, targetEffectiveAccountId, targetType)

Clones an existing cart to create a secondary, read-only cart to support Pay Now functionality. Sets the guest cart status to PendingDelete in a B2B store or Closed in a D2C store.

API Version

60.0

Available to Guest Users

60.0

Requires Chatter

No

Signature

public static ConnectApi.CartSummary cloneCart(String webstoreId, String activeCartOrId, String targetEffectiveAccountId, String targetType)

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. Use active only for B2B Aura stores; all other stores must use current.
targetEffectiveAccountId: Type: String; Effective Account ID associated with the cloned cart.
targetType: Type: String; Type of the cloned cart. Value is PayNowReadOnly.

Return Value

Usage

The cloneCart method is valid only for the Pay Now feature. See Salesforce Pay Now for Embedded Payment Solutions.

deleteCart(webstoreId, effectiveAccountId, activeCartOrId)

Delete a cart. Sets the guest cart status to PendingDelete in a B2B store or Closed in a D2C store.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.

Return Value

Type: Void

Usage

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

deleteCartCoupon(webstoreId, effectiveAccountId, activeCartOrId, cartCouponId)

Delete a coupon from a cart.

API Version

54.0

Available to Guest Users

57.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
cartCouponId: Type: String; ID of the cart coupon.

Return Value

Type: Void

deleteCartCoupon(webstoreId, effectiveAccountId, activeCartOrId, cartCouponId, currencyIsoCode)

Delete a coupon from a cart.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
cartCouponId: Type: String; ID of the cart coupon.
currencyIsoCode: Type: String; Currency ISO code of the cart.

Return Value

Type: Void

deleteCartItem(webstoreId, effectiveAccountId, activeCartOrId, cartItemId)

Delete an item from a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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.

deleteInventoryReservation(webstoreId, activeCartOrId, effectiveAccountId) (Pilot)

Delete an inventory reservation.

API Version

This feature is not generally available and is being piloted with certain Customers subject to additional terms and conditions. It is not part of your purchased Services. This feature is subject to change, may be discontinued with no notice at any time in Salesforce’s sole discretion, and Salesforce may never make this feature generally available. Make your purchase decisions only on the basis of generally available products and features. This feature is made available on an AS IS basis and use of this feature is at your sole risk.

Note

58.0

Available to Guest Users

58.0

Requires Chatter

No

Signature

public static Void deleteInventoryReservation(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 indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.

Return Value

Type: Void

evaluateShipping(webstoreId, activeCartOrId, effectiveAccountId, cartEvaluateShippingInput)

Evaluate shipping costs for a cart.

API Version

63.0

Available to Guest Users

63.0

Requires Chatter

No

Signature

public static ConnectApi.CalculateCartResult evaluateShipping(String webstoreId, String activeCartOrId, String effectiveAccountId, ConnectApi.CartEvaluateShippingInput cartEvaluateShippingInput)

Parameters

webstoreId: Type: String; ID of the webstore.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
cartEvaluateShippingInput: Type: ConnectApi.CartEvaluateShippingInput; A ConnectApi.CartEvaluateShippingInput object representing a shipping address and any custom fields.

Return Value

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.

evaluateTaxes(webstoreId, activeCartOrId, effectiveAccountId, cartEvaluateTaxInput)

Evaluate taxes for a cart.

API Version

63.0

Available to Guest Users

63.0

Requires Chatter

No

Signature

public static ConnectApi.CalculateCartResult evaluateTaxes(String webstoreId, String activeCartOrId, String effectiveAccountId, ConnectApi.CartEvaluateTaxInput cartEvaluateTaxInput)

Parameters

webstoreId: Type: String; ID of the webstore.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
cartEvaluateTaxInput: Type: ConnectApi.CartEvaluateTaxInput; A ConnectApi.CartEvaluateTaxInput object representing a shipping address and any custom fields.

Return Value

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.

getCartCoupons(webstoreId, effectiveAccountId, activeCartOrId)

Get coupons for a cart.

API Version

54.0

Available to Guest Users

57.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.

Return Value

getCartCoupons(webstoreId, effectiveAccountId, activeCartOrId, currencyIsoCode)

Get coupons for a cart.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.

Return Value

getCartItemPromotion(webstoreId, effectiveAccountId, activeCartOrId, cartItemPromotionCollectionInput)

Get promotions for a cart item.

API Version

52.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

public static ConnectApi.CartItemPromotionCollectionOutputRepresentation getCartItemPromotion(String webstoreId, String effectiveAccountId, String activeCartOrId, ConnectApi.CartItemPromotionCollectionInputRepresentation cartItemPromotionCollectionInput)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
cartItemPromotionCollectionInput: Type: ConnectApi.CartItemPromotionCollectionInputRepresentation; Promotions for a cart item.

Return Value

Type: ConnectApi.CartItemPromotionCollectionOutputRepresentation

getCartItemPromotion(webstoreId, effectiveAccountId, activeCartOrId, cartItemPromotionCollectionInput, currencyIsoCode)

Get a promotion for a cart item.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

public static ConnectApi.CartItemPromotionCollectionOutputRepresentation getCartItemPromotion(String webstoreId, String effectiveAccountId, String activeCartOrId, ConnectApi.CartItemPromotionCollectionInputRepresentation cartItemPromotionCollectionInput, String currencyIsoCode)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
cartItemPromotionCollectionInput: Type: ConnectApi.CartItemPromotionCollectionInputRepresentation; Promotions for a cart item.
currencyIsoCode: Type: String; Currency ISO code of the cart.

Return Value

Type: ConnectApi.CartItemPromotionCollectionOutputRepresentation

getCartItems(webstoreId, effectiveAccountId, activeCartOrId)

Get items in a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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

getCartItems(webstoreId, effectiveAccountId, activeCartOrId, pageParam)

Get a page of items in a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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

getCartItems(webstoreId, effectiveAccountId, activeCartOrId, pageParam, sortParam)

Get a sorted page of items in a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.

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

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

getCartItems(webstoreId, effectiveAccountId, activeCartOrId, pageParam, pageSize)

Get a specified size page of items in a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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

getCartItems(webstoreId, effectiveAccountId, activeCartOrId, pageParam, pageSize, sortParam)

Get a specified size, sorted page of items in a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.

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

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

getCartItems(webstoreId, effectiveAccountId, activeCartOrId, productFields, pageParam, pageSize, sortParam)

Get a specified size, sorted page of items filtered by product fields in a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.

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. Use active only for B2B Aura stores; all other stores must use current.

productFields

Type: String

Comma-separated list of up to 15 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

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

getCartItems(webstoreId, effectiveAccountId, activeCartOrId, productFields, pageParam, pageSize, sortParam, currencyIsoCode)

Get a specified size, sorted page of items filtered by product fields in a cart.

API Version

57.0

Available to Guest Users

57.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, String currencyIsoCode)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
productFields: Type: String; Comma-separated list of up to 15 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.
currencyIsoCode: Type: String; Currency ISO code of the cart.

Return Value

getCartItems(webstoreId, effectiveAccountId, activeCartOrId, productFields, pageParam, pageSize, sortParam, currencyIsoCode, includePromotions, includeCoupons)

Get a sorted page of items in a cart, including coupons and promotions.

API Version

59.0

Available to Guest Users

54.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, String currencyIsoCode, Boolean includePromotions, Boolean includeCoupons)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
productFields: Type: String; Comma-separated list of up to 15 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.

includePromotions: Type: Boolean; Indicates whether to include coupons (True) or not (False)
includeCoupons: Type: Boolean; Indicates whether to include promotions (True) or not (False).

Return Value

getCartItems(webstoreId, effectiveAccountId, activeCartOrId, productFields, pageParam, pageSize, sortParam, currencyIsoCode, includePromotions, includeCoupons, pageNumber)

Get a specific, sorted page of items in a cart, including coupons and promotions.

API Version

60.0

Available to Guest Users

54.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, String currencyIsoCode, Boolean includePromotions, Boolean includeCoupons, Integer pageNumber)

Parameters

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.

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. Use active only for B2B Aura stores; all other stores must use current.

productFields

Type: String

Comma-separated list of up to 15 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

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.

Description

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

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.

includePromotions

Type: Boolean

Indicates whether to include coupons (True) or not (False)

includeCoupons

Type: Boolean

Indicates whether to include promotions (True) or not (False).

pageNumber

Type: Integer

Specifies the requested page number.

Return Value

getCartPromotions(webstoreId, effectiveAccountId, activeCartOrId)

Get promotions for a cart.

API Version

53.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

public static ConnectApi.CartPromotionCollection getCartPromotions(String webstoreId, String effectiveAccountId, String activeCartOrId)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.

Return Value

Type: ConnectApi.CartPromotionCollection

getCartPromotions(webstoreId, effectiveAccountId, activeCartOrId, currencyIsoCode)

Get promotions for a cart in a specific currency.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

public static ConnectApi.CartPromotionCollection getCartPromotions(String webstoreId, String effectiveAccountId, String activeCartOrId, String currencyIsoCode)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
activeCartOrId: Type: String; ID of the cart, active, or current. The current value indicates a cart with a status that isn’t Closed or PendingDelete. Use active only for B2B Aura stores; all other stores must use current.
currencyIsoCode: Type: String; Currency ISO code of the cart.

Return Value

Type: ConnectApi.CartPromotionCollection

getCartSummary(webstoreId, effectiveAccountId, activeCartOrId)

Get a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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

getCartSummary(webstoreId, effectiveAccountId, activeCartOrId, currencyIsoCode)

Get a cart in a specific currency.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
currencyIsoCode: Type: String; Currency ISO code of the cart.

Return Value

getOrCreateActiveCartSummary(webstoreId, effectiveAccountId, activeCartOrId)

Get a cart or create an active cart if one doesn’t exist.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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

Usage

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

getOrCreateActiveCartSummary(webstoreId, effectiveAccountId, activeCartOrId, currencyIsoCode)

Get a cart in a specific currency, or create an active cart if one doesn’t exist.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
currencyIsoCode: Type: String; Currency ISO code of the cart.

Return Value

Usage

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

getProductCartItem(webstoreId, effectiveAccountId, activeCartOrId, productId, currencyIsoCode)

Get cart items of a specific product.

API Version

60.0

Available to Guest Users

60.0

Requires Chatter

No

Signature

public static ConnectApi.ProductCartItem getProductCartItem(String webstoreId, String effectiveAccountId, String activeCartOrId, String productId, String currencyIsoCode)

Parameters

webstoreId: Type: String; ID of the web store.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
currencyIsoCode: Type: String; Currency ISO code of the cart.
webstoreId: Type: String; ID of the product.

Return Value

Type: ConnectApi.ProductCartItem

getProductCartItems(webstoreId, effectiveAccountId, activeCartOrId, pageSize, pageNumber, currencyIsoCode)

Get the items in a cart, sorted by product ID.

API Version

60.0

Available to Guest Users

60.0

Requires Chatter

No

Signature

public static ConnectApi.ProductCartItemCollection getProductCartItems(String webstoreId, String effectiveAccountId, String activeCartOrId, Integer pageSize, Integer pageNumber, String currencyIsoCode)

Parameters

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. Use active only for B2B Aura stores; all other stores must use current.
currencyIsoCode: Type: String; Currency ISO code of the cart.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context.
pageNumber: Type: Integer; Specifies the requested page number.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.
webstoreId: Type: String; ID of the web store.

Return Value

Type: ConnectApi.ProductCartItemCollection

makeCartPrimary(webstoreId, activeCartOrId, effectiveAccountId)

Make a secondary cart a primary cart.

API Version

53.0

Available to Guest Users

56.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. Use active only for B2B Aura stores; all other stores must use current.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.

Return Value

Type: ConnectApi.CommerceActionResult

preserveGuestCart(webstoreId, effectiveAccountId, activeCartOrId, currencyIsoCode)

Preserve cart contents when a guest logs in as an authenticated customer. Sets the guest cart status to PendingDelete in a B2B store or Closed in a D2C store.

API Version

60.0

Requires Chatter

No

Signature

public static ConnectApi.PreserveCart preserveGuestCart(String webstoreId, String effectiveAccountId, String activeCartOrId, String currencyIsoCode)

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
currencyIsoCode: Type: String; The currency ISO code of the cart.

Return Value

Type: ConnectApi.PreserveCart

setCartMessagesVisibility(webstoreId, activeCartOrId, effectiveAccountId, messageVisibility)

Set the visibility for cart messages.

API Version

50.0

Available to Guest Users

54.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. Use active only for B2B Aura stores; all other stores must use current.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
messageVisibility: Type: ConnectApi.CartMessagesVisibilityInput; A ConnectApi.CartMessagesVisibilityInput object specifying the visibility setting.

Return Value

Type: ConnectApi.CartMessagesVisibilityResult

updateCartItem(webstoreId, effectiveAccountId, activeCartOrId, cartItemId, cartItem)

Update an item in a cart.

API Version

49.0

Available to Guest Users

54.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 buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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

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.

updateCartItem(webstoreId, effectiveAccountId, activeCartOrId, cartItemId, cartItem, currencyIsoCode)

Update an item in a cart of a specific currency.

API Version

57.0

Available to Guest Users

57.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
cartItemId: Type: String; ID of the cart item.
cartItem: Type: ConnectApi.CartItemInput; A ConnectApi.CartItemInput object representing a cart item to update.
currencyIsoCode: Type: String; The currency ISO code of the cart.

Return Value

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.

updateCartItem(webstoreId, effectiveAccountId, activeCartOrId, cartItemId, cartItem, currencyIsoCode, includeCartData)

Update an item in a cart of a specific currency.

API Version

64.0

Available to Guest Users

51.0

Requires Chatter

No

Signature

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

Parameters

webstoreId: Type: String; ID of the webstore.
effectiveAccountId: Type: String; ID of the buyer account or guest buyer profile for which the request is made. If null, the default value is determined from context.
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. Use active only for B2B Aura stores; all other stores must use current.
cartItemId: Type: String; ID of the cart item.
cartItem: Type: ConnectApi.CartItemInput; A ConnectApi.CartItemInput object representing a cart item to update.
currencyIsoCode: Type: String; The currency ISO code of the cart.
currencyIsoCode: Type: String; Description
includeCartData: Type: Boolean; Specifies whether to return a collection of cart items in the response (true) or not (false). If unspecified, the default value is false. This parameter is supported for D2C stores with Faster Add-to-Cart disabled. The cart must also have fewer than 25 items.

Return Value