Newer Version Available

This content describes an older version of this product. View Latest

Commerce Webstore Product

Get a product.

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

Resource
1/commerce/webstores/webstoreId/products/productId
Available version
49.0
Requires Chatter
No
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
effective​AccountId Boolean ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. Optional 49.0
exclude​Entitlement​Details Boolean Specifies whether the entitlement details of the products are returned (false) or not (true). If unspecified, defaults to false. Optional 49.0
excludeFields Boolean Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false. Optional 49.0
excludeMedia Boolean Specifies whether the media groups and default images of the products are returned (false) or not (true). If unspecified, defaults to false. Optional 49.0
excludePrimary​ProductCategory Boolean Specifies whether the primary category path of the products is returned (false) or not (true). If unspecified, defaults to false. Optional 49.0
fields 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.

Optional 49.0
mediaGroups 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.

Optional 49.0
Response body for GET
Product Detail