CommerceCatalog Class

API Version

49.0

Requires Chatter

No

Signature

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)

Parameters

webstoreId

Type: String

ID of the webstore.

productId

Type: String

ID of the product.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

Comma-separated list of field names.

If this list is empty or 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 products are returned (false) or not (true). If unspecified, defaults to false.

excludeEntitlementDetails

Type: Boolean

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

excludePrimaryProductCategory

Type: Boolean

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

Return Value

Type: ConnectApi.ProductDetail

Usage

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

API Version

49.0

Requires Chatter

No

Signature

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

Parameters

webstoreId

Type: String

ID of the webstore.

productCategoryId

Type: String

ID of the product category.

effectiveAccountId

Type: String

ID of the account for which the request is made. If null, defaults to the account ID for the context user.

fields

Type: List<String>

Comma-separated list of field names.

If this list is empty or 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 products are returned (false) or not (true). If unspecified, defaults to false.

Return Value

Type: ConnectApi.ProductCategoryDetail

API Version

49.0

Requires Chatter

No

Signature

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

Parameters

webstoreId

Type: String

ID of the webstore.

productCategoryId

Type: String

ID of the product category.

Return Value

Type: ConnectApi.ProductCategoryPath

Usage

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