Newer Version Available

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

Commerce Webstore Products

Get fields, prices, and default images for a list of products.
Resource
1/commerce/webstores/webstoreId/products
Available version
54.0
Requires Chatter
No
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
effectiveAccountId 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. Optional 54.0
excludeMedia Boolean Specifies whether default images are returned for the products (false) or not (true). The default is false. Optional 54.0
excludePrices Boolean Specifies whether prices are returned for the products (false) or not (true). The default is false.

In version 58 and later, prices aren’t returned for products regardless of this request parameter. To get pricing information for products in version 58.0 and later, use Commerce Webstore Pricing Products.

Optional 54.0–57.0
fields StringList 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. Optional 54.0
ids String List of product IDs. Specify either a list of product IDs or SKUs, but not both. Either ids or skus is required, but not both. 54.0
skus StringList List of SKUs. Specify either a list of SKUs or product IDs, but not both. Either skus or ids is required, but not both. 54.0
Response body for GET
Product Overview Collection