Get Product Models

Filter product models, for more details see the [Filters](https://api.akeneo.com/documentation/filter.html).

Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes. It is useful for retrieving product information specific to a particular sales channel, which is essential for channel-specific applications. For more details see the [Filter product values via channel](https://api.akeneo.com/documentation/filter.html#via-channel) section.

Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes. It is useful for retrieving product information in specific languages, which is essential for multi-locale applications. For more details see the [Filter product values via locale](https://api.akeneo.com/documentation/filter.html#via-locale) section.

Filter product values to only return those concerning the given attributes. It is useful for limiting the response to specific attributes, reducing payload size and improving performance. For more details see the [Filter product values via attributes](https://api.akeneo.com/documentation/filter.html#via-attributes) section.

Specify which pagination method to use for navigating through large datasets. It is useful for choosing between different pagination strategies based on your specific use case and performance requirements. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

One ofpagesearch_afterDefault "page"

Specify which page of results to retrieve when using pagination. It is useful for navigating through large datasets by breaking them into smaller, manageable pages. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 1

Cursor when using the `search_after` pagination method type. It is essential for navigating through pages in cursor-based pagination, providing more efficient pagination for large datasets. Should never be set manually, see [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default "cursor to the first page"

Specify the maximum number of results to return per page. It is useful for controlling the amount of data returned in a single request, especially when dealing with large datasets. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 10

Filter scopes based on specific criteria. If you need to filter on several attributes on the same scope, you can use this parameter, to avoid repeating yourself for each attribute. For more details see the [Filters](https://api.akeneo.com/documentation/filter.html#search_scope-query-parameter) section.

Filter locales based on specific criteria. If you need to filter on several attributes on the same locale, you can use this parameter, to avoid repeating yourself for each attribute. For more details see the [Filters](https://api.akeneo.com/documentation/filter.html#search_locale-query-parameter) section.

Convert measurement attribute values to the appropriate unit for the channel provided by the `scope` parameter. When set to `true`, the `scope` parameter is required.

Default false

Return the count of items in the response. Be careful with that, on a big catalog, it can decrease performance in a significant way. It is useful for understanding the size of the dataset being returned, especially when dealing with large collections. Use it judiciously to avoid performance issues.

Default false

Return an array of workflow_execution_statuses directly associated with the requested entity (product or product model) in the response. Statuses are level-specific and are not inherited from parent models. For a complete overview of a variant product, you must query the variant itself and its parent model(s) in separate requests. Each workflow object contains: - The overall execution status (e.g., in_progress, completed). - A list of all associated tasks.

Default false

Return labels of attribute options in the response. See [the `linked_data` format](https://api.akeneo.com/concepts/products.html#the-linked_data-format) section for more details.

Default false

Return asset collection share link URLs in the response. When set to `true`, the response will include direct URLs to asset collections for sharing purposes. This is useful for accessing direct links to asset collections, which can be used for sharing or external integrations. If set to `false`, the response will not include share links, which can improve performance. See [the `linked_data` format](https://api.akeneo.com/concepts/products.html#the-linked_data-format) for more details.

Default false

When set to `true`, disabled assets are excluded from asset collection values in the response. Only assets with `status: "enabled"` are returned. When set to `false` (default), all assets are returned regardless of their status.

Default false

Return product model quality scores in the response.

Return readiness information in the response. - `scores_only`: include readiness percentage scores only. - `detailed`: include readiness percentage scores together with the list of unmet requirements. When omitted, no readiness information is returned. Readiness is currently in beta and is available by request only. If you would like to participate, please reach out to your Customer Success Manager.

One ofscores_onlydetailed