product.child_item.list
Get a list of a product's child items, such as variants or bundle components. The total_count field in the response indicates the total number of items in the context of the current filter.
Request
- Base URL: https://api.api2cart.com/v1.1
- URL: https://api.api2cart.com/v1.1/product.child_item.list.json
- Auth: API key in header x-api-key and API key in header x-store-key
Query parameters
This parameter sets the number from which you want to get entities
This parameter sets the entity amount that has to be retrieved. Max allowed count=250
Used to retrieve products child items via cursor-based pagination (it can't be used with any other filtering parameter)
Filter by parent product id
Filter by parent product ids
Filter by products variant's sku
Store Id
Language id
Currency Id
Specifies the set of available/not available products for sale
Entity search that is specified by some value
Child products search that is specified by field
Retrieve entities from their creation date
Retrieve entities to their creation date
Retrieve entities from their modification date
Retrieve entities to their modification date
Determines the type of products to be returned. If set to 'true', only global products will be returned; if set to 'false', only local products will be returned.
Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.
Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve
Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all
Report request id
Disable report cache for current request
Use the latest platform API version
Response
successful operation
Changes
No recorded changes to this operation across all 1 revision of this API.