CommerceCart クラス

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

cartItems

型: List<ConnectApi.BatchInput>

リストには最大 100 個の ConnectApi.BatchInput オブジェクトを含めることができます。ConnectApi.BatchInput コンストラクターでは、入力オブジェクトが ConnectApi.CartItemInput である必要があります。

戻り値

型: ConnectApi.BatchResult[]

ConnectApi.BatchResult.getResult() メソッドは ConnectApi.CartItem オブジェクトを返します。

返されるオブジェクトは、各入力オブジェクトに対応し、入力オブジェクトと同じ順序で返されます。

メソッドコールは、操作全体に影響を与えるエラー (解析エラーなど) が発生した場合にのみ失敗します。個々のオブジェクトでエラーが発生した場合、エラーは ConnectApi.BatchResult リスト内に埋め込まれます。

使用方法

カートへの参照アクセス権を持つバイヤーは、カートで品目を追加、更新、および削除できます。

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

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

cartItemInput

型: ConnectApi.CartItemInput

カートに追加する品目を表す ConnectApi.CartItemInput オブジェクト。

戻り値

型: ConnectApi.CartItem

使用方法

カートへの参照アクセス権を持つバイヤーは、カートで品目を追加、更新、および削除できます。

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

API バージョン

50.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

cartToWishlistInput

型: ConnectApi.CartToWishlistInput

商品をコピーするウィッシュリストを示す ConnectApi.CartToWishlistInput オブジェクト。

戻り値

型: ConnectApi.CartToWishlistResult

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

cart

型: ConnectApi.CartInput

カートを表す ConnectApi.CartInput オブジェクト。

戻り値

型: ConnectApi.CartSummary

使用方法

カートへの参照アクセス権を持つバイヤーは、カートで作成および削除できます。

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

戻り値

型: Void

使用方法

カートへの参照アクセス権を持つバイヤーは、カートで作成および削除できます。

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

cartItemId

型: String

カート項目の ID。

戻り値

型: Void

使用方法

カートへの参照アクセス権を持つバイヤーは、カートで品目を追加、更新、および削除できます。

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

戻り値

型: ConnectApi.CartItemCollection

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

pageParam

型: String

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

戻り値

型: ConnectApi.CartItemCollection

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

pageParam

型: String

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

sortParam

型: ConnectApi.CartItemSortOrder

カート内の品目の順序を並べ替えます。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• NameAsc — 名前がアルファベットの昇順 (A ～ Z) で並べ替えられます。
• NameDesc — 名前がアルファベットの降順 (Z ～ A) で並べ替えられます。
• SalesPriceAsc — 交渉済み価格が低い順に並べ替えられます。
• SalesPriceDesc — 交渉済み価格が高い順に並べ替えられます。

null の場合、デフォルトは CreatedDateDesc です。

戻り値

型: ConnectApi.CartItemCollection

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

pageParam

型: String

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

pageSize

型: Integer

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

戻り値

型: ConnectApi.CartItemCollection

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

pageParam

型: String

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

pageSize

型: Integer

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

sortParam

型: ConnectApi.CartItemSortOrder

カート内の品目の順序を並べ替えます。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• NameAsc — 名前がアルファベットの昇順 (A ～ Z) で並べ替えられます。
• NameDesc — 名前がアルファベットの降順 (Z ～ A) で並べ替えられます。
• SalesPriceAsc — 交渉済み価格が低い順に並べ替えられます。
• SalesPriceDesc — 交渉済み価格が高い順に並べ替えられます。

null の場合、デフォルトは CreatedDateDesc です。

戻り値

型: ConnectApi.CartItemCollection

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

productFields

型: String

商品項目が 5 個のカンマ区切りリスト。結果に含まれるのは、アクセス権のある項目のみです。いくつかの商品項目 (productName や sku など) は、productFields パラメーターに含まれていなくても返されます。

pageParam

型: String

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

pageSize

型: Integer

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

sortParam

型: ConnectApi.CartItemSortOrder

カート内の品目の順序を並べ替えます。値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• NameAsc — 名前がアルファベットの昇順 (A ～ Z) で並べ替えられます。
• NameDesc — 名前がアルファベットの降順 (Z ～ A) で並べ替えられます。
• SalesPriceAsc — 交渉済み価格が低い順に並べ替えられます。
• SalesPriceDesc — 交渉済み価格が高い順に並べ替えられます。

null の場合、デフォルトは CreatedDateDesc です。

戻り値

型: ConnectApi.CartItemCollection

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。active を指定したときに、有効なカートがない場合は、エラーが返されます。

戻り値

型: ConnectApi.CartSummary

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。active を指定したときに、有効なカートがない場合は、有効なカートが作成されます。

戻り値

型: ConnectApi.CartSummary

使用方法

カートへの参照アクセス権を持つバイヤーは、カートで作成および削除できます。

API バージョン

50.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

messageVisibility

型: ConnectApi.CartMessagesVisibilityInput

表示設定を指定する ConnectApi.CartMessagesVisibilityInput オブジェクト。

戻り値

型: ConnectApi.CartMessagesVisibilityResult

API バージョン

49.0

ゲストユーザーが使用可能

54.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。

activeCartOrId

型: String

カート、active、または current の ID。current 値はバージョン 50.0 以降で使用でき、Closed または PendingDelete でない状況のカートを示します。

cartItemId

型: String

カート項目の ID。

cartItem

型: ConnectApi.CartItemInput

カート品目の更新を表す ConnectApi.CartItemInput オブジェクト。

戻り値

型: ConnectApi.CartItem

使用方法

カートへの参照アクセス権を持つバイヤーは、カートで品目を追加、更新、および削除できます。

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