CommerceWishlist クラス

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistItem addItemToWishlist(String webstoreId, String wishlistId, ConnectApi.WishlistItemInput wishlistItemInput)

パラメータ

webstoreId

型: String

WebStore の ID。

wishlistId

型: String

ウィッシュリストの ID。

wishlistItemInput

型: ConnectApi.WishlistItemInput

ウィッシュリストに追加する品目を含んだ ConnectApi.WishlistItemInput のボディ。

戻り値

型: ConnectApi.WishlistItem

使用方法

このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザのみがアクセスできます。

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistItem addItemToWishlist(String webstoreId, String effectiveAccountId, String wishlistId, ConnectApi.WishlistItemInput wishlistItemInput)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistId

型: String

ウィッシュリストの ID。

wishlistItemInput

型: ConnectApi.WishlistItemInput

ウィッシュリストに追加する品目を含んだ ConnectApi.WishlistItemInput のボディ。

戻り値

型: ConnectApi.WishlistItem

使用方法

このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザのみがアクセスできます。

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistToCartResult addWishlistToCart(String webstoreId, String wishlistId)

パラメータ

webstoreId

型: String

WebStore の ID。

wishlistId

型: String

ウィッシュリストの ID。

戻り値

型: ConnectApi.WishlistToCartResult

使用方法

このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザのみがアクセスできます。

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistToCartResult addWishlistToCart(String webstoreId, String wishlistId, String effectiveAccountId)

パラメータ

webstoreId

型: String

WebStore の ID。

wishlistId

型: String

ウィッシュリストの ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

戻り値

型: ConnectApi.WishlistToCartResult

使用方法

このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザのみがアクセスできます。

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistToCartResult addWishlistToCartWithCartId(String webstoreId, String wishlistId, String cartId)

パラメータ

webstoreId

型: String

WebStore の ID。

wishlistId

型: String

ウィッシュリストの ID。

cartId

型: String

カートの ID。null の場合、ウィッシュリスト品目は有効なカートに追加されます。

戻り値

型: ConnectApi.WishlistToCartResult

使用方法

このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザのみがアクセスできます。

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistToCartResult addWishlistToCartWithCartId(String webstoreId, String wishlistId, String cartId, String effectiveAccountId)

パラメータ

webstoreId

型: String

WebStore の ID。

wishlistId

型: String

ウィッシュリストの ID。

cartId

型: String

カートの ID。null の場合、ウィッシュリスト品目は有効なカートに追加されます。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

戻り値

型: ConnectApi.WishlistToCartResult

使用方法

このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザのみがアクセスできます。

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Wishlist createWishlist(String webstoreId, ConnectApi.WishlistInput wishlistInput)

パラメータ

webstoreId

型: String

WebStore の ID。

wishlistInput

型: ConnectApi.WishlistInput

ウィッシュリスト名と品目を含む ConnectApi.WishlistInput のボディ。

戻り値

型: ConnectApi.Wishlist

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Wishlist createWishlist(String webstoreId, String effectiveAccountId, ConnectApi.WishlistInput wishlistInput)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistInput

型: ConnectApi.WishlistInput

ウィッシュリスト名と品目を含む ConnectApi.WishlistInput のボディ。

戻り値

型: ConnectApi.Wishlist

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteWishlist(String webstoreId, String wishlistId)

パラメータ

webstoreId

型: String

WebStore の ID。

wishlistId

型: String

ウィッシュリストの ID。

戻り値

型: Void

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteWishlist(String webstoreId, String effectiveAccountId, String wishlistId)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistId

型: String

ウィッシュリストの ID。

戻り値

型: Void

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Wishlist getWishlist(String webstoreId, String effectiveAccountId, String wishlistId, String productFields, ConnectApi.WishlistItemSortOrder sortItemsBy)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistId

型: String

ウィッシュリストの ID。

productFields

型: String

カスタム商品項目のカンマ区切りリスト。項目では、大文字と小文字は区別されません。たとえば、ProductCode と productcode は同じ結果を返します。

sortItemsBy

型: ConnectApi.WishlistItemSortOrder

ウィッシュリスト品目の並び替え順。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並び替えます。
• CreatedDateDesc — 作成日の新しい順に並び替えます。

デフォルトの並び替え順は、CreatedDateDesc です。

戻り値

型: ConnectApi.Wishlist

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Wishlist getWishlist(String webstoreId, String effectiveAccountId, String wishlistId, String productFields, Integer pageSize, ConnectApi.WishlistItemSortOrder sortItemsBy)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistId

型: String

ウィッシュリストの ID。

productFields

型: String

カスタム商品項目のカンマ区切りリスト。項目では、大文字と小文字は区別されません。たとえば、ProductCode と productcode は同じ結果を返します。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortItemsBy

型: ConnectApi.WishlistItemSortOrder

ウィッシュリスト品目の並び替え順。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並び替えます。
• CreatedDateDesc — 作成日の新しい順に並び替えます。

デフォルトの並び替え順は、CreatedDateDesc です。

戻り値

型: ConnectApi.Wishlist

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistItemCollection getWishlistItems(String webstoreId, String effectiveAccountId, String wishlistId, String productFields, String pageParam, ConnectApi.WishlistItemSortOrder sortItemsBy)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistId

型: String

ウィッシュリストの ID。

productFields

型: String

カスタム商品項目のカンマ区切りリスト。項目では、大文字と小文字は区別されません。たとえば、ProductCode と productcode は同じ結果を返します。

pageParam

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

sortItemsBy

型: ConnectApi.WishlistItemSortOrder

ウィッシュリスト品目の並び替え順。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並び替えます。
• CreatedDateDesc — 作成日の新しい順に並び替えます。

デフォルトの並び替え順は、CreatedDateDesc です。

戻り値

型: ConnectApi.WishlistItemCollection

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistItemCollection getWishlistItems(String webstoreId, String effectiveAccountId, String wishlistId, String productFields, String pageParam, Integer pageSize, ConnectApi.WishlistItemSortOrder sortItemsBy)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistId

型: String

ウィッシュリストの ID。

productFields

型: String

カスタム商品項目のカンマ区切りリスト。項目では、大文字と小文字は区別されません。たとえば、ProductCode と productcode は同じ結果を返します。

pageParam

型: String

情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 200 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortItemsBy

型: ConnectApi.WishlistItemSortOrder

ウィッシュリスト品目の並び替え順。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並び替えます。
• CreatedDateDesc — 作成日の新しい順に並び替えます。

デフォルトの並び替え順は、CreatedDateDesc です。

戻り値

型: ConnectApi.WishlistItemCollection

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistsSummary getWishlistSummaries(String webstoreId, String effectiveAccountId, Boolean includeDisplayedList)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

includeDisplayedList

型: Boolean

表示済みリストを含めるか (true)、否か (false) を指定します。null の場合は、デフォルトの false になります。

戻り値

型: ConnectApi.WishlistsSummary

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistsSummary getWishlistSummaries(String webstoreId, String effectiveAccountId, Boolean includeDisplayedList, String productFields, ConnectApi.WishlistItemSortOrder sortItemsBy)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

includeDisplayedList

型: Boolean

表示済みリストを含めるか (true)、否か (false) を指定します。

productFields

型: String

カスタム商品項目のカンマ区切りリスト。項目では、大文字と小文字は区別されません。たとえば、ProductCode と productcode は同じ結果を返します。

includeDisplayedList が false の場合、productFields は無視されます。

sortItemsBy

型: ConnectApi.WishlistItemSortOrder

ウィッシュリスト品目の並び替え順。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並び替えます。
• CreatedDateDesc — 作成日の新しい順に並び替えます。

デフォルトの並び替え順は、CreatedDateDesc です。

includeDisplayedList が false の場合、sortItemsBy は無視されます。

戻り値

型: ConnectApi.WishlistsSummary

API バージョン

51.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistsSummary getWishlistSummaries(String webstoreId, String effectiveAccountId, Boolean includeDisplayedList, Integer pageSize, String productFields, pageSize, ConnectApi.WishlistItemSortOrder sortItemsBy)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

includeDisplayedList

型: Boolean

表示済みリストを含めるか (true)、否か (false) を指定します。

productFields

型: String

カスタム商品項目のカンマ区切りリスト。項目では、大文字と小文字は区別されません。たとえば、ProductCode と productcode は同じ結果を返します。

includeDisplayedList が false の場合、productFields は無視されます。

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

sortItemsBy

型: ConnectApi.WishlistItemSortOrder

ウィッシュリスト品目の並び替え順。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並び替えます。
• CreatedDateDesc — 作成日の新しい順に並び替えます。

デフォルトの並び替え順は、CreatedDateDesc です。

includeDisplayedList が false の場合、sortItemsBy は無視されます。

戻り値

型: ConnectApi.WishlistsSummary

API バージョン

49.0

Chatter が必要かどうか

いいえ

署名

public static Void removeWishlistItem(String webstoreId, String effectiveAccountId, String wishlistId, String wishlistItemId)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistId

型: String

ウィッシュリストの ID。

wishlistItemId

型: String

削除するウィッシュリスト品目の ID。

戻り値

型: Void

API バージョン

50.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistSummary updateWishlist(String webstoreId, String wishlistId, ConnectApi.WishlistUpdateInput wishlistUpdateInput)

パラメータ

webstoreId

型: String

WebStore の ID。

wishlistId

型: String

ウィッシュリストの ID。

wishlistUpdateInput

型: ConnectApi.WishlistUpdateInput

更新するウィッシュリスト名を含む ConnectApi.WishlistUpdateInput のボディ。

戻り値

型: ConnectApi.WishlistSummary

API バージョン

50.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.WishlistSummary updateWishlist(String webstoreId, String effectiveAccountId, String wishlistId, ConnectApi.WishlistUpdateInput wishlistUpdateInput)

パラメータ

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われた取引先の ID。 null の場合、デフォルトで、コンテキストユーザの accountID になります。

wishlistId

型: String

ウィッシュリストの ID。

wishlistUpdateInput

型: ConnectApi.WishlistUpdateInput

更新するウィッシュリスト名を含む ConnectApi.WishlistUpdateInput のボディ。

戻り値

型: ConnectApi.WishlistSummary