CommerceCatalog Class

Get products, product categories, and product category paths.

ConnectApi

These methods are for CommerceCatalog. All methods are static.

Retrieve product category menu items for the given parent item and store.

64.0

64.0

No

public static ConnectApi.NavigationMenuItemCollection getCategoryMenuItems(String webstoreId, Boolean includeImageUrl, Boolean addHomeMenuItem, String publishStatus, String effectiveAccountId, Integer maxLevels, Integer maxItems)

webstoreId

Type: String

ID of the webstore.

addHomeMenuItem

Type: Boolean

Indicates if a home menu item should be included. The default value is false.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context.

includeImageUrl

Type: Boolean

Indicates if the image URL should be included for root items.

maxItems

Type: Integer

Maximum number of category items to be retrieved.

maxLevels

Type: Integer

Maximum number of hierarchical levels to be retrieved.

publishStatus

Type: String

Publish status of the storefront.

Type: ConnectApi.NavigationMenuItemCollection

Get a product.

49.0

Supported in API versions 49.0 to 63.0.

51.0

No

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

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludeEntitlementDetails

Type: Boolean

Specifies whether the entitlement details of the product are returned (false) or not (true). If unspecified, defaults to false.

excludePrimaryProductCategory

Type: Boolean

Specifies whether the primary category path of the product is returned (false) or not (true). If unspecified, defaults to false.

Type: ConnectApi.ProductDetail

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

Get a product with variation and attribute information.

50.0

Supported in API versions 50.0 to 63.0.

51.0

No

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

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludeEntitlementDetails

Type: Boolean

Specifies whether the entitlement details of the product are returned (false) or not (true). If unspecified, defaults to false.

excludePrimaryProductCategory

Type: Boolean

Specifies whether the primary category path of the product is returned (false) or not (true). If unspecified, defaults to false.

excludeVariationInfo

Type: Boolean

Specifies whether the variation information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false.

Type: ConnectApi.ProductDetail

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

Get a product with quantity rule information.

52.0

Supported in API versions 52.0 to 63.0.

52.0

No

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

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludeEntitlementDetails

Type: Boolean

Specifies whether the entitlement details of the product are returned (false) or not (true). If unspecified, defaults to false.

excludePrimaryProductCategory

Type: Boolean

Specifies whether the primary category path of the product is returned (false) or not (true). If unspecified, defaults to false.

excludeVariationInfo

Type: Boolean

Specifies whether the variation information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

Type: ConnectApi.ProductDetail

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

Get detailed information for a product, optionally including information about its product selling models.

56.0

Supported in API versions 56.0 to 63.0.

56.0

No

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

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludeEntitlementDetails

Type: Boolean

Specifies whether the entitlement details of the product are returned (false) or not (true). If unspecified, defaults to false.

excludePrimaryProductCategory

Type: Boolean

Specifies whether the primary category path of the product is returned (false) or not (true). If unspecified, defaults to false.

excludeVariationInfo

Type: Boolean

Specifies whether the variation information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeProductSellingModels

Type: Boolean

Specifies whether product selling models are returned or not. The behavior of this parameter depends on whether you turn on the CommerceSubscription permission. If the permission is on, and if you set the parameter to false (or if you omit the parameter), product selling models are returned. If the permission is on, and if you set the parameter to true, product selling models are not returned. If the permission is off, product selling models are not returned, regardless of whether you omit the parameter or provide a value.

Type: ConnectApi.ProductDetail

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

Get detailed information for a product without its entitlement information.

57.0

Supported in API versions 57.0 to 64.0.

57.0

No

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

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludePrimaryProductCategory

Type: Boolean

Specifies whether the primary category path of the product is returned (false) or not (true). If unspecified, defaults to false.

excludeVariationInfo

Type: Boolean

Specifies whether the variation information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeProductSellingModels

Type: Boolean

Specifies whether product selling models are returned or not. The behavior of this parameter depends on whether you turn on the CommerceSubscription permission. If the permission is on, and if you set the parameter to false (or if you omit the parameter), product selling models are returned. If the permission is on, and if you set the parameter to true, product selling models are not returned. If the permission is off, product selling models are not returned, regardless of whether you omit the parameter or provide a value.

Type: ConnectApi.ProductDetail

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

Get detailed information for a product without its entitlement information.

64.0

Supported in API versions 64.0 to 65.0.

64.0

No

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, String noCache)

webstoreId

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludePrimaryProductCategory

Type: Boolean

Specifies whether the primary category path of the product is returned (false) or not (true). If unspecified, defaults to false.

excludeVariationInfo

Type: Boolean

Specifies whether the variation information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeProductSellingModels

Type: Boolean

Specifies whether product selling models are returned or not. The behavior of this parameter depends on whether you turn on the CommerceSubscription permission. If the permission is on, and if you set the parameter to false (or if you omit the parameter), product selling models are returned. If the permission is on, and if you set the parameter to true, product selling models are not returned. If the permission is off, product selling models are not returned, regardless of whether you omit the parameter or provide a value.

noCache

Type: String

Specifies whether to ignore cached data and return the latest response (true) or not (false).

Type: ConnectApi.ProductDetail

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

Get detailed information for a product without its entitlement information.

65.0

65.0

No

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, Boolean excludeDynamicAttributeInfo, String noCache)

webstoreId

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludePrimaryProductCategory

Type: Boolean

Specifies whether the primary category path of the product is returned (false) or not (true). If unspecified, defaults to false.

excludeVariationInfo

Type: Boolean

Specifies whether the variation information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeProductSellingModels

Type: Boolean

Specifies whether product selling models are returned or not. The behavior of this parameter depends on whether you turn on the CommerceSubscription permission. If the permission is on, and if you set the parameter to false (or if you omit the parameter), product selling models are returned. If the permission is on, and if you set the parameter to true, product selling models are not returned. If the permission is off, product selling models are not returned, regardless of whether you omit the parameter or provide a value.

excludeDynamicAttributeInfo

Type: Boolean

Specifies whether the dynamic attribute information for the product is returned (false) or not (true). If unspecified, defaults to true. This behavior of this parameter depends on whether you turn on the Commerce Dynamic Bundles permission. If dynamic bundles are supported, and if you set the parameter to false (or if you omit the parameter), count is returned. If dynamic bundles are supported, and if you set the parameter to true, count is not returned. If dynamic bundles aren't supported, count isn't returned, regardless of whether you omit the parameter or provide a value.

noCache

Type: String

Specifies whether to ignore cached data and return the latest response (true) or not (false).

Type: ConnectApi.ProductDetail

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

Get a product category.

49.0

51.0

No

public static ConnectApi.ProductCategoryDetail getProductCategory(String webstoreId, String productCategoryId, String effectiveAccountId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia)

webstoreId

Type: String

ID of the webstore.

productCategoryId

Type: String

ID of the product category.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

Type: ConnectApi.ProductCategoryDetail

Get product categories.

52.0

52.0

No

public static ConnectApi.ProductCategoryDetailCollection getProductCategoryChildren(String webstoreId, String effectiveAccountId, String parentProductCategoryId, List<String> fields, Boolean excludeFields, List<String> mediaGroups, Boolean excludeMedia)

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

parentProductCategoryId

Type: String

ID of the product category for which you want to get all the children product categories. If null, returns all the top-level product categories for the store.

fields

Type: List<String>

Comma-separated list of field names.

If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records.

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

Type: ConnectApi.ProductCategoryDetailCollection

Get the product category path from the root category to the current category.

49.0

51.0

No

public static ConnectApi.ProductCategoryPath getProductCategoryPath(String webstoreId, String productCategoryId)

webstoreId

Type: String

ID of the webstore.

productCategoryId

Type: String

ID of the product category.

effectiveAccountId

Type: String

If null, the default value is determined from context.ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. This field is available in API version 65.0 and later.

Type: ConnectApi.ProductCategoryPath

This method respects buyer View Product entitlements and only users entitled to view product data can access it.

Get a collection of child products related to a parent product.

57.0

57.0

No

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

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context.

fields

Type: List<String>

Comma-separated list of field names.

If this list is empty or unspecified, all fields are returned. There’s no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records. Possible values:

  • Attachment
  • productDetailImage
  • productListImage

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

For product bundles, only the producListImage is returned.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 20.

Type: ConnectApi.ProductChildCollection

Get a collection of child products related to a parent product.

66.0

57.0

No

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, Boolean includeProductSellingModels, Boolean includeRequiredChildrenOnly, Boolean excludeDynamicAttributeInfo, String pageToken, Integer pageSize, String noCache)

webstoreId

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context.

fields

Type: List<String>

Comma-separated list of field names.

If this list is empty or unspecified, all fields are returned. There’s no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If excludeFields and fields are specified, the excludeFields parameter takes precedence.

mediaGroups

Type: List<String>

Comma-separated list of developer names of media group records. Possible values:

  • Attachment
  • productDetailImage
  • productListImage

If this list is empty or unspecified, all media groups are returned. If excludeMedia and mediaGroups are specified, the excludeMedia parameter takes precedence.

For product bundles, only the producListImage is returned.

excludeFields

Type: Boolean

Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

excludeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false.

excludeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

includeProductSellingModels

Type: Boolean

Specifies whether product selling models are returned or not. The behavior of this parameter depends on whether you turn on the CommerceSubscription permission. If the permission is on, and if you set the parameter to false (or if you omit the parameter), product selling models are returned. If the permission is on, and if you set the parameter to true, product selling models are not returned. If the permission is off, product selling models are not returned, regardless of whether you omit the parameter or provide a value.

includeRequiredChildrenOnly

Type: Boolean

Specifies whether to include only the required children for the product (true) or not (false). If unspecified, defaults to true.

excludeDynamicAttributeInfo

Type: Boolean

Specifies whether to exclue the dynamic attribute information for the product (true) or not (false). If unspecified, defaults to true.

pageToken

Type: String

Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 20.

noCache

Type: String

Specifies whether to ignore cached data and return the latest response (true) or not (false).

Type: ConnectApi.ProductChildCollection

Get fields, prices, and default images for a list of products.

54.0

Supported in API versions 54.0 to 63.0.

54.0

No

public static ConnectApi.ProductOverviewCollection getProducts(String webstoreId, String effectiveAccountId, List<String> ids, List<String> skus, List<String> fields, Boolean excludeMedia, Boolean excludePrices)

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context.

ids

Type: List<String>

List of product IDs. Specify either a list of up to 20 product IDs or SKUs, but not both.

skus

Type: List<String>

List of SKUs. Specify either a list of up to 20 SKUs or product IDs, but not both.

fields

Type: List<String>

Comma-separated list of field names to return for each product. If the list is empty or not specified, all fields are returned. You can specify any number of fields.

excludeMedia

Type: Boolean

Specifies whether default images are returned for the products (false) or not (true). The default is false.

excludePrices

Type: Boolean

Specifies whether prices are returned for the products (false) or not (true). The default is false.

In version 58.0 and later, prices aren’t returned for products regardless of this parameter. To get pricing information for products in version 58.0 and later, use the CommerceStorePricing Class.

Type: ConnectApi.ProductOverviewCollection

Get fields and default images for a list of products.

58.0

Supported in API versions 58.0 to 62.0.

58.0

No

public static ConnectApi.ProductOverviewCollection getProducts(String webstoreId, String effectiveAccountId, List<String> ids, List<String> skus, List<String> fields, Boolean excludeMedia)

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

ids

Type: List<String>

List of product IDs. Specify either a list of up to 20 product IDs or SKUs, but not both.

skus

Type: List<String>

List of SKUs. Specify either a list of up to 20 SKUs or product IDs, but not both.

fields

Type: List<String>

Comma-separated list of field names to return for each product. If the list is empty or not specified, all fields are returned. You can specify any number of fields.

excludeMedia

Type: Boolean

Specifies whether default images are returnedSpecifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

Type: ConnectApi.ProductOverviewCollection

Get fields and default images for a list of products.

63.0

Supported in API versions 63.0 to 64.0.

54.0

No

public static ConnectApi.ProductOverviewCollection getProducts(String webstoreId, String effectiveAccountId, List<String> ids, List<String> skus, List<String> fields, Boolean excludeMedia, Boolean includeQuantityRule, Boolean includeProductSellingModels, Boolean includeAttributeSetInfo, Boolean includeGroupByAttributeVariationInfo)

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.If null, the default value is determined from context.

ids

Type: List<String>

List of product IDs. Specify either a list of up to 20 product IDs or SKUs, but not both.

skus

Type: List<String>

List of skus. Specify either a list of up to 20 SKUs or product IDs, but not both.

fields

Type: List<String>

Comma-separated list of field names to return for each product. If the list is empty or not specified, all fields are returned. You can specify any number of fields.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

includeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

includeProductSellingModels

Type: Boolean

Specifies whether product selling models are returned (true) or not (false). The behavior of this parameter depends on whether you turn on the CommerceSubscription permission. If the permission is on, and if you set the parameter to false (or if you omit the parameter), product selling models are returned. If the permission is on, and if you set the parameter to true, product selling models are not returned. If the permission is off, product selling models are not returned, regardless of whether you omit the parameter or provide a value.

includeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (true) or not (false). If unspecified, defaults to false.

includeGroupByAttributeVariationInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (true) or not (false). If unspecified, defaults to false.

Type: ConnectApi.ProductOverviewCollection

Get fields and default images for a list of products.

64.0

64.0

No

public static ConnectApi.ProductOverviewCollection getProducts(String webstoreId, String effectiveAccountId, List<String> ids, List<String> skus, List<String> fields, Boolean excludeMedia, Boolean includeQuantityRule, Boolean includeProductSellingModels, Boolean includeAttributeSetInfo, Boolean includeGroupByAttributeVariationInfo, String noCache)

webstoreId

Type: String

ID of the webstore.

effectiveAccountId

Type: String

ID of the buyer account or guest buyer profile for which the request is made.

ids

Type: List<String>

List of product IDs. Specify either a list of up to 20 product IDs or SKUs, but not both.

skus

Type: List<String>

List of skus. Specify either a list of up to 20 SKUs or product IDs, but not both.

fields

Type: List<String>

Comma-separated list of field names to return for each product. If the list is empty or not specified, all fields are returned. You can specify any number of fields.

excludeMedia

Type: Boolean

Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false.

includeQuantityRule

Type: Boolean

Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false.

includeProductSellingModels

Type: Boolean

Specifies whether product selling models are returned (true) or not (false). The behavior of this parameter depends on whether you turn on the CommerceSubscription permission. If the permission is on, and if you set the parameter to false (or if you omit the parameter), product selling models are returned. If the permission is on, and if you set the parameter to true, product selling models are not returned. If the permission is off, product selling models are not returned, regardless of whether you omit the parameter or provide a value.

includeAttributeSetInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (true) or not (false). If unspecified, defaults to false.

includeGroupByAttributeVariationInfo

Type: Boolean

Specifies whether the attribute set information for the product is returned (true) or not (false). If unspecified, defaults to false.

noCache

Type: String

Specifies whether to ignore cached data and return the latest response (true) or not (false).

Type: ConnectApi.ProductOverviewCollection