Including Resources
Using the include parameter, you can retrieve top-level resources, such as:
- Files or main image.
- Component product data.
- Key attribute data, such as SKU or slug.
The include query parameter you choose depends on the API endpoint you are using.
The following endpoints support the include parameter:
- Get all products
- Get a product
- Get a Price Book by ID
- Get a product in the latest catalog release
- Get all products in the latest release
- Get a bundle's component products in the latest release
- Get a parent product's child products in the latest release
- Get a node's products in the latest release
- Get all products in a shopper catalog
- Get a product in a shopper catalog
- Get a hierarchy's products in a shopper catalog
- Get a parent product's child products in a shopper catalog
- Get a bundle's component products in a shopper catalog
- Get a node's products in a shopper catalog
- Configure a shopper bundle
- List Subscriptions
- Get a Subscription
- List Offerings
- Get an Offering
- Get all Promotions
- Get a Promotion
- Get a Promotion History
- Get all Account Memberships
- Get a List of Account Memberships of Account Member
- Get an Account Membership
Characteristics of Include Parameter
The include parameter has the following characteristics:
- You can use multiple values with the
includequery parameter. Use a comma to separate the values. For example,include=files,main_image. - If you request a resource to be included, but no related entities of that resource type exist, the response does not have an
includedsection. - Similarly, if you request to include a resource that is not supported as an include by the endpoint, there is no
includedsection in the response. - There is a soft limit of five included resources per request, where one included resource can be
main_image, another can becategories, and so on. - We recommend you do not include a resource if the response for the resource may contain more than 100 entities.