Apex Developer Guide
jNewer Version Available
CommerceWishlist Class
Namespace
CommerceWishlist Methods
addItemToWishlist(webstoreId, wishlistId, wishlistItemInput)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistItem addItemToWishlist(String webstoreId, String wishlistId, ConnectApi.WishlistItemInput wishlistItemInput)
Parameters
- webstoreId
- Type: String
- ID of the webstore.
- wishlistId
- Type: String
- ID of the wishlist.
- wishlistItemInput
- Type: ConnectApi.WishlistItemInput
- A ConnectApi.WishlistItemInput body with the item to add to the wishlist.
Return Value
Type: ConnectApi.WishlistItem
Usage
This method respects buyer View Product entitlements and only users entitled to view product data can access it.
addItemToWishlist(webstoreId, effectiveAccountId, wishlistId, wishlistItemInput)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistItem addItemToWishlist(String webstoreId, String effectiveAccountId, String wishlistId, ConnectApi.WishlistItemInput wishlistItemInput)
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.
- wishlistId
- Type: String
- ID of the wishlist.
- wishlistItemInput
- Type: ConnectApi.WishlistItemInput
- A ConnectApi.WishlistItemInput body with the item to add to the wishlist.
Return Value
Type: ConnectApi.WishlistItem
Usage
This method respects buyer View Product entitlements and only users entitled to view product data can access it.
addWishlistToCart(webstoreId, wishlistId)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistToCartResult addWishlistToCart(String webstoreId, String wishlistId)
Return Value
Usage
This method respects buyer View Product entitlements and only users entitled to view product data can access it.
addWishlistToCart(webstoreId, wishlistId, effectiveAccountId)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistToCartResult addWishlistToCart(String webstoreId, String wishlistId, String effectiveAccountId)
Parameters
Return Value
Usage
This method respects buyer View Product entitlements and only users entitled to view product data can access it.
addWishlistToCartWithCartId(webstoreId, wishlistId, cartId)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistToCartResult addWishlistToCartWithCartId(String webstoreId, String wishlistId, String cartId)
Parameters
Return Value
Usage
This method respects buyer View Product entitlements and only users entitled to view product data can access it.
addWishlistToCartWithCartId(webstoreId, wishlistId, cartId, effectiveAccountId)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistToCartResult addWishlistToCartWithCartId(String webstoreId, String wishlistId, String cartId, String effectiveAccountId)
Parameters
- webstoreId
- Type: String
- ID of the webstore.
- wishlistId
- Type: String
- ID of the wishlist.
- cartId
- Type: String
- ID of the cart. If null, wishlist items are added to the active cart.
- 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
Usage
This method respects buyer View Product entitlements and only users entitled to view product data can access it.
createWishlist(webstoreId, wishlistInput)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.Wishlist createWishlist(String webstoreId, ConnectApi.WishlistInput wishlistInput)
Parameters
- webstoreId
- Type: String
- ID of the webstore.
- wishlistInput
- Type: ConnectApi.WishlistInput
- A ConnectApi.WishlistInput body that includes the wishlist name and items.
Return Value
Type: ConnectApi.Wishlist
createWishlist(webstoreId, effectiveAccountId, wishlistInput)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.Wishlist createWishlist(String webstoreId, String effectiveAccountId, ConnectApi.WishlistInput wishlistInput)
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.
- wishlistInput
- Type: ConnectApi.WishlistInput
- A ConnectApi.WishlistInput body that includes the wishlist name and items.
Return Value
Type: ConnectApi.Wishlist
getWishlist(webstoreId, wishlistId)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.Wishlist getWishlist(String webstoreId, String wishlistId)
Return Value
Type: ConnectApi.Wishlist
getWishlist(webstoreId, effectiveAccountId, wishlistId)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.Wishlist getWishlist(String webstoreId, String effectiveAccountId, String wishlistId)
Parameters
Return Value
Type: ConnectApi.Wishlist
getWishlistItems(webstoreId, effectiveAccountId, wishlistId)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistItemCollection getWishlistItems(String webstoreId, String effectiveAccountId, String wishlistId)
Parameters
Return Value
getWishlistItems(webstoreId, effectiveAccountId, wishlistId, pageParam)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistItemCollection getWishlistItems(String webstoreId, String effectiveAccountId, String wishlistId, 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.
- wishlistId
- Type: String
- ID of the wishlist.
- pageParam
- Type: String
- Specifies the page token to be used 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
getWishlistItems(webstoreId, effectiveAccountId, wishlistId, pageParam, pageSize)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistItemCollection getWishlistItems(String webstoreId, String effectiveAccountId, String wishlistId, 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.
- wishlistId
- Type: String
- ID of the wishlist.
- pageParam
- Type: String
- Specifies the page token to be used 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 200. If you pass in null, the default size is 25.
Return Value
getWishlistSummaries(webstoreId)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistsSummary getWishlistSummaries(String webstoreId)
Parameters
- webstoreId
- Type: String
- ID of the webstore.
Return Value
getWishlistSummaries(webstoreId, effectiveAccountId, wishlistId, includeDisplayedList)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistsSummary getWishlistSummaries(String webstoreId, String effectiveAccountId, String wishlistId, Boolean includeDisplayedList)
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.
- wishlistId
- Type: String
- ID of the wishlist. If null, all the wishlist summaries are returned.
- includeDisplayedList
- Type: Boolean
- Specifies whether to include the displayed list (true) or not (false). If null, defaults to false.
Return Value
getWishlistSummaries(webstoreId, effectiveAccountId, includeDisplayedList)
API Version
49.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistsSummary getWishlistSummaries(String webstoreId, String effectiveAccountId, Boolean includeDisplayedList)
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.
- includeDisplayedList
- Type: Boolean
- Specifies whether to include the displayed list (true) or not (false). If null, defaults to false.
Return Value
removeWishlistItem(webstoreId, effectiveAccountId, wishlistId, wishlistItemId)
API Version
49.0
Requires Chatter
No
Signature
public static Void removeWishlistItem(String webstoreId, String effectiveAccountId, String wishlistId, String wishlistItemId)
Parameters
Return Value
Type: Void
updateWishlist(webstoreId, wishlistId, wishlistUpdateInput)
API Version
50.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistSummary updateWishlist(String webstoreId, String wishlistId, ConnectApi.WishlistUpdateInput wishlistUpdateInput)
Parameters
- webstoreId
- Type: String
- ID of the webstore.
- wishlistId
- Type: String
- ID of the wishlist.
- wishlistUpdateInput
- Type: ConnectApi.WishlistUpdateInput
- A ConnectApi.WishlistUpdateInput body with the wishlist name to update.
Return Value
updateWishlist(webstoreId, effectiveAccountId, wishlistId, wishlistUpdateInput)
API Version
50.0
Requires Chatter
No
Signature
public static ConnectApi.WishlistSummary updateWishlist(String webstoreId, String effectiveAccountId, String wishlistId, ConnectApi.WishlistUpdateInput wishlistUpdateInput)
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.
- wishlistId
- Type: String
- ID of the wishlist.
- wishlistUpdateInput
- Type: ConnectApi.WishlistUpdateInput
- A ConnectApi.WishlistUpdateInput body with the wishlist name to update.