CommerceCart クラス

API バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

cartItemInput

型: ConnectApi.CartItemInput

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

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.CartItem

使用方法

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

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

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 バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

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 である必要があります。

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: 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 バージョン

54.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

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

cartCouponInput

型: ConnectApi.cartCouponInput

クーポンのクーポンコード。

戻り値

型: ConnectApi.CartCouponCollection

API バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

cartCouponInput

型: ConnectApi.cartCouponInput

クーポンのクーポンコード。

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.CartCouponCollection

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 バージョン

60.0

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

60.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

activeCartOrId

型: String

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

targetEffectiveAccountId

型: String

コピーされたカートに関連付けられた有効な取引先 ID。

targetType

型: String

コピーされたカートの型。値は PayNowReadOnly です。

戻り値

型: ConnectApi.CartSummary

使用方法

cloneCart メソッドは Pay Now 機能にのみ有効です。「Salesforce Pay Now による組み込み決済ソリューション」を参照してください。

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 バージョン

54.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

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

cartCouponId

型: String

カートクーポンの ID。

戻り値

型: Void

API バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

cartCouponId

型: String

カートクーポンの ID。

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: 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 バージョン

58.0

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

58.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

effectiveAccountId

型: String

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

戻り値

型: Void

API バージョン

54.0

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

57.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CartCouponCollection getCartCoupons(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.CartCouponCollection

API バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

戻り値

型: ConnectApi.CartCouponCollection

API バージョン

52.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

cartItemPromotionCollectionInput

型: ConnectApi.CartItemPromotionCollectionInputRepresentation

カート品目のプロモーション。

戻り値

型: ConnectApi.CartItemPromotionCollectionOutputRepresentation

API バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

cartItemPromotionCollectionInput

型: ConnectApi.CartItemPromotionCollectionInputRepresentation

カート品目のプロモーション。

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.CartItemPromotionCollectionOutputRepresentation

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 バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

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 に設定されます。

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.CartItemCollection

API バージョン

59.0

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

54.0

Chatter が必要かどうか

いいえ

署名

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)

パラメーター

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 に設定されます。

includePromotions

型: Boolean

クーポンを含めるか (True)、否か (False) を示します

includeCoupons

型: Boolean

プロモーションを含めるか (True)、否か (False) を示します。

戻り値

型: ConnectApi.CartItemCollection

API バージョン

60.0

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

54.0

Chatter が必要かどうか

いいえ

署名

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)

パラメーター

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

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

説明

pageSize

型: Integer

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

sortParam

型: ConnectApi.CartItemSortOrder

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

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

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

includePromotions

型: Boolean

クーポンを含めるか (True)、否か (False) を示します

includeCoupons

型: Boolean

プロモーションを含めるか (True)、否か (False) を示します。

pageNumber

型: Integer

要求されたページ番号を指定します。

戻り値

型: ConnectApi.CartItemCollection

API バージョン

53.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

戻り値

型: ConnectApi.CartPromotionCollection

API バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.CartPromotionCollection

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 バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

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

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: 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 バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

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

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.CartSummary

使用方法

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

API バージョン

60.0

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

60.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

effectiveAccountId

型: String

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

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.ProductCartItem

API バージョン

60.0

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

60.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

effectiveAccountId

型: String

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

pageSize

型: Integer

ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。値を指定しない場合、���フォルトサイズは 25 です。

pageNumber

型: Integer

要求されたページ番号を指定します。

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.ProductCartItemCollection

API バージョン

53.0

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

56.0

Chatter が必要かどうか

はい

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

activeCartOrId

型: String

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

effectiveAccountId

型: String

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

戻り値

型: ConnectApi.CommerceActionResult

API バージョン

60.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

webstoreId

型: String

WebStore の ID。

effectiveAccountId

型: String

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

activeCartOrId

型: String

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

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.PreserveCart

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

使用方法

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

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

API バージョン

57.0

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

57.0

Chatter が必要かどうか

いいえ

署名

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

パラメーター

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 オブジェクト。

currencyIsoCode

型: String

カートの通貨 ISO コード。

戻り値

型: ConnectApi.CartItem

使用方法

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

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

API バージョン

58.0

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

58.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.CartInventoryReservationOutputRepresentation upsertInventoryReservation(String webstoreId, String activeCartOrId, String effectiveAccountId, ConnectApi.CartInventoryReservationInputRepresentation cartInventoryReservationInput)

パラメーター

webstoreId

型: String

WebStore の ID。

activeCartOrId

型: String

カート、active、または current の ID。current 値は、Closed または PendingDelete でない状況のカートを示します。

effectiveAccountId

型: String

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

cartInventoryReservationInput

型: ConnectApi.CartInventoryReservationInputRepresentation

予約期間を示す ConnectApi.CartInventoryReservationInputRepresentation 入力クラス。

戻り値

型: ConnectApi.CartInventoryReservationOutputRepresentation