Apex リファレンスガイド
jCommerceCatalog クラス
名前空間
CommerceCatalog のメソッド
getProduct(webstoreId, productId, effectiveAccountId, fields, excludeFields, mediaGroups, excludeMedia, excludeEntitlementDetails, excludePrimaryProductCategory)
API バージョン
49.0
ゲストユーザーが使用可能
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductDetail getProduct(String webstoreId, String productId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia, Boolean excludeEntitlementDetails, Boolean excludePrimaryProductCategory)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- productId
- 型: String
- 商品の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeEntitlementDetails
- 型: Boolean
- 商品のエンタイトルメントの詳細を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludePrimaryProductCategory
- 型: Boolean
- 商品のプライマリカテゴリパスを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
戻り値
使用方法
このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがアクセスできます。
getProduct(webstoreId, productId, effectiveAccountId, fields, excludeFields, mediaGroups, excludeMedia, excludeEntitlementDetails, excludePrimaryProductCategory, excludeVariationInfo, excludeAttributeSetInfo)
API バージョン
50.0
ゲストユーザーが使用可能
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductDetail getProduct(String webstoreId, String productId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia, Boolean excludeEntitlementDetails, Boolean excludePrimaryProductCategory, Boolean excludeVariationInfo, Boolean excludeAttributeSetInfo)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- productId
- 型: String
- 商品の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指���する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeEntitlementDetails
- 型: Boolean
- 商品のエンタイトルメントの詳細を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludePrimaryProductCategory
- 型: Boolean
- 商品のプライマリカテゴリパスを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeVariationInfo
- 型: Boolean
- 商品のバリエーション情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeAttributeSetInfo
- 型: Boolean
- 商品の属性セット情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
戻り値
使用方法
このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがアクセスできます。
getProduct(webstoreId, productId, effectiveAccountId, fields, excludeFields, mediaGroups, excludeMedia, excludeEntitlementDetails, excludePrimaryProductCategory, excludeVariationInfo, excludeAttributeSetInfo, excludeQuantityRule)
API バージョン
52.0
ゲストユーザーが使用可能
52.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductDetail getProduct(String webstoreId, String productId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia, Boolean excludeEntitlementDetails, Boolean excludePrimaryProductCategory, Boolean excludeVariationInfo, Boolean excludeAttributeSetInfo, Boolean excludeQuantityRule)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- productId
- 型: String
- 商品の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeEntitlementDetails
- 型: Boolean
- 商品のエンタイトルメントの詳細を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludePrimaryProductCategory
- 型: Boolean
- 商品のプライマリカテゴリパスを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeVariationInfo
- 型: Boolean
- 商品のバリエーション情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeAttributeSetInfo
- 型: Boolean
- 商品の属性セット情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeQuantityRule
- 型: Boolean
- 商品の数量ルール情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
戻り値
使用方法
このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがアクセスできます。
getProduct(webstoreId, productId, effectiveAccountId, fields, excludeFields, mediaGroups, excludeMedia, excludeEntitlementDetails, excludePrimaryProductCategory, excludeVariationInfo, excludeAttributeSetInfo, excludeQuantityRule, excludeProductSellingModels)
API バージョン
56.0
ゲストユーザーが使用可能
56.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductDetail getProduct(String webstoreId, String productId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia, Boolean excludeEntitlementDetails, Boolean excludePrimaryProductCategory, Boolean excludeVariationInfo, Boolean excludeAttributeSetInfo, Boolean excludeQuantityRule, Boolean excludeProductSellingModels)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- productId
- 型: String
- 商品の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeEntitlementDetails
- 型: Boolean
- 商品のエンタイトルメントの詳細を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludePrimaryProductCategory
- 型: Boolean
- 商品のプライマリカテゴリパスを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeVariationInfo
- 型: Boolean
- 商品のバリエーション情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeAttributeSetInfo
- 型: Boolean
- 商品の属性セット情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeQuantityRule
- 型: Boolean
- 商品の数量ルール情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeProductSellingModels
- 型: Boolean
- 商品販売モデルが返されるかどうかを指定します。このパラメーターの動作は、CommerceSubscription 権限をオンにするかどうかによって異なります。この権限をオンにし、このパラメーターを false に設定した場合 (または省略した場合) は、商品販売モデルが返されます。この権限をオンにし、このパラメーターを true に設定した場合は、商品販売モデルが返されません。この権限をオフにした場合は、このパラメーターを省略するかや値を指定するかにかかわらず、商品販売モデルは返されません。
戻り値
使用方法
このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがアクセスできます。
getProduct(webstoreId, productId, effectiveAccountId, fields, mediaGroups, excludeFields, excludeMedia, excludePrimaryProductCategory, excludeVariationInfo, excludeAttributeSetInfo, excludeQuantityRule, excludeProductSellingModels)
API バージョン
57.0
ゲストユーザーが使用可能
57.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductDetail getProduct(String webstoreId, String productId, String effectiveAccountId, List<String> fields, List<String> mediaGroups, Boolean excludeFields, Boolean excludeMedia, Boolean excludePrimaryProductCategory, Boolean excludeVariationInfo, Boolean excludeAttributeSetInfo, Boolean excludeQuantityRule, Boolean excludeProductSellingModels)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- productId
- 型: String
- 商品の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludePrimaryProductCategory
- 型: Boolean
- 商品のプライマリカテゴリパスを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeVariationInfo
- 型: Boolean
- 商品のバリエーション情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeAttributeSetInfo
- 型: Boolean
- 商品の属性セット情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeQuantityRule
- 型: Boolean
- 商品の数量ルール情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeProductSellingModels
- 型: Boolean
- 商品販売モデルが返されるかどうかを指定します。このパラメーターの動作は、CommerceSubscription 権限をオンにするかどうかによって異なります。この権限をオンにし、このパラメーターを false に設定した場合 (または省略した場合) は、商品販売モデルが返されます。この権限をオンにし、このパラメーターを true に設定した場合は、商品販売モデルが返されません。この権限をオフにした場合は、このパラメーターを省略するかや値を指定するかにかかわらず、商品販売モデルは返されません。
戻り値
使用方法
このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがアクセスできます。
getProductCategory(webstoreId, productCategoryId, effectiveAccountId, fields, excludeFields, mediaGroups, excludeMedia)
API バージョン
49.0
ゲストユーザーが使用可能
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductCategoryDetail getProductCategory(String webstoreId, String productCategoryId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- productCategoryId
- 型: String
- 商品カテゴリの ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
getProductCategoryChildren(webstoreId, effectiveAccountId, parentProductCategoryId, fields, excludeFields, mediaGroups, excludeMedia)
API バージョン
52.0
ゲストユーザーが使用可能
52.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductCategoryDetailCollection getProductCategoryChildren(String webstoreId, String effectiveAccountId, String parentProductCategoryId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- parentProductCategoryId
- 型: String
- すべての子の商品カテゴリを取得する商品カテゴリの ID。null の場合、その店舗の最上位レベルの商品カテゴリがすべて返されます。
- fields
- 型: List<String>
- 項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- mediaGroups
- 型: List<String>
- メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
getProductCategoryPath(webstoreId, productCategoryId)
API バージョン
49.0
ゲストユーザーが使用可能
51.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductCategoryPath getProductCategoryPath(String webstoreId, String productCategoryId)
使用方法
このメソッドではバイヤーの「商品を表示」エンタイトルメントが適用され、商品データを表示する資格があるユーザーのみがアクセスできます。
getProductChildCollection(webstoreId, productId, effectiveAccountId, fields, mediaGroups, excludeFields, excludeMedia, excludeAttributeSetInfo, excludeQuantityRule, pageToken, pageSize)
API バージョン
57.0
ゲストユーザーが使用可能
57.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductChildCollection getProductChildCollection(String webstoreId, String productId, String effectiveAccountId, List<String> fields, List<String> mediaGroups, Boolean excludeFields, Boolean excludeMedia, Boolean excludeAttributeSetInfo, Boolean excludeQuantityRule, String pageToken, Integer pageSize)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- productId
- 型: String
- 商品の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。指定されていない場合、デフォルト値はコンテキストから決定されます。
- fields
- 型: List<String>
-
項目名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべての項目が返されます。指定できる項目の数に制限はありません。ただし、項目の数や項目名の文字数が、URL のサイズ制限に影響する場合があります。excludeFields と fields を指定する場合、excludeFields が優先されます。
- mediaGroups
- 型: List<String>
-
メディアグループレコードの API 参照名のカンマ区切りのリスト。
このリストを空にするか指定しない場合、すべてのメディアグループが返されます。excludeMedia と mediaGroups を指定する場合、excludeMedia が優先されます。
- excludeFields
- 型: Boolean
- 項目を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeMedia
- 型: Boolean
- メディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeAttributeSetInfo
- 型: Boolean
- 商品の属性セット情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- excludeQuantityRule
- 型: Boolean
- 商品の数量ルール情報を返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。
- pageToken
- 型: String
- base64 でエンコードされたページトークンを示します。ページトークンは応答の一部として返されます。指定しない場合は、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。値を指定しない場合、デフォルトサイズは 20 です。
getProducts(webstoreId, effectiveAccountId, ids, skus, fields, excludeMedia, excludePrices)
API バージョン
54.0
ゲストユーザーが使用可能
54.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductOverviewCollection getProducts(String webstoreId, String effectiveAccountId, List<String> ids, List<String> skus, List<String> fields, Boolean excludeMedia, Boolean excludePrices)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。指定されていない場合、デフォルト値はコンテキストから決定されます。
- ids
- 型: List<String>
- 商品 ID のリスト。最大 20 個の商品 ID または SKU のいずれかのリストを指定しますが、両��は指定できません。
- skus
- 型: List<String>
- SKU のリスト。最大 20 個の SKU または商品 ID のいずれかのリストを指定しますが、両方は指定できません。
- fields
- 型: List<String>
- 商品ごとに返される項目名のカンマ区切りのリスト。リストを空にするか指定しない場合、すべての項目が返されます。項目はいくつでも指定できます。
- excludeMedia
- 型: Boolean
- 商品のデフォルト画像を返すか (false)、否か (true) を指定します。デフォルトは false です。
- excludePrices
- 型: Boolean
- 商品の価格を返すか (false)、否か (true) を指定します。デフォルトは false です。
getProducts(webstoreId, effectiveAccountId, ids, skus, fields, excludeMedia)
API バージョン
58.0
ゲストユーザーが使用可能
58.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ProductOverviewCollection getProducts(String webstoreId, String effectiveAccountId, List<String> ids, List<String> skus, List<String> fields, Boolean excludeMedia)
パラメーター
- webstoreId
- 型: String
- WebStore の ID。
- effectiveAccountId
- 型: String
- 要求が行われたバイヤー取引先またはゲストバイヤープロファイルの ID。null の場合、デフォルト値はコンテキストから決定されます。
- ids
- 型: List<String>
- 商品 ID のリスト。最大 20 個の商品 ID または SKU のいずれかのリストを指定しますが、両方は指定できません。
- skus
- 型: List<String>
- SKU のリスト。最大 20 個の SKU または商品 ID のいずれかのリストを指定しますが、両方は指定できません。
- fields
- 型: List<String>
- 商品ごとに返される項目名のカンマ区切りのリスト。リストを空にするか指定しない場合、すべての項目が返されます。項目はいくつでも指定できます。
- excludeMedia
- 型: Boolean
- デフォルトイメージを返すかどうかを示しますメディアグループと商品のデフォルトイメージを返すか (false)、否か (true) を示します。指定しない場合は、デフォルトの false になります。