Newer Version Available

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

Commerce Webstore Product Children

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

This resource respects buyer View Product entitlements and only users entitled to view product data can access it. It works for bundle or set products. It isn’t supported for simple, variation, or variation parent products.

Resource
1/commerce/webstores/webstoreId/products/productId/children
Available version
57.0
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 57.0
excludeAttributeSet​Info Boolean Specifies whether the attribute set information for the product is returned (false) or not (true). If unspecified, defaults to false. Optional 57.0
excludeFields Boolean Specifies whether the fields are returned (false) or not (true). If unspecified, defaults to false. Optional 57.0
excludeMedia Boolean Specifies whether the media groups and default images of the product are returned (false) or not (true). If unspecified, defaults to false. Optional 57.0
excludeQuantityRule Boolean Specifies whether the quantity rule information for the product is returned (false) or not (true). If unspecified, defaults to false. Optional 57.0
fields StringList 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 57.0
mediaGroups StringList 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 57.0
pageSize 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. Optional 57.0
pageToken String Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned. Optional 57.0
Response body for GET
Product Child Collection