AKakeneo
Product model

Get list of product models

Changed on

This endpoint allows you to get a list of product models. Product models are paginated. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the set of products you request.

get/api/rest/v1/product-models

Request

  • Base URL
    http://demo.akeneo.com
  • Auth
    none declared

Query parameters

searchstring

Filter product models, for more details see the <a href="/documentation/filter.html">Filters</a> section

scopestring

Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the <a href="/documentation/filter.html#via-channel">Filter product values via channel</a> section

localesstring

Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the <a href="/documentation/filter.html#via-locale">Filter product values via locale</a> section

attributesstring

Filter product values to only return those concerning the given attributes, for more details see the <a href="/documentation/filter.html#filter-product-values">Filter on product values</a> section and the <a href="/documentation/filter.html#filter-on-product-model-properties">Filter on product model properties</a> section

pagination_type'page' | 'search_after'

Pagination method type, see <a href="/documentation/pagination.html">Pagination</a> section

pageinteger

Number of the page to retrieve when using the page pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html#pagination">Pagination</a> section

search_afterstring

Cursor when using the search_after pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html">Pagination</a> section

limitinteger

Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section

with_countboolean

Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

with_quality_scoresboolean

Return product model quality scores in the response. <strong>(Only available since the 6.0 version)</strong>

Response

Return product models paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "code": "model-biker-jacket-leather",
        "family": "clothing",
        "family_variant": "clothing_material_size",
        "parent": "model-biker-jacket",
        "categories": [
          "summer_collection"
        ],
        "values": {
          "color": [
            {
              "locale": null,
              "scope": null,
              "data": "antique_white"
            }
          ],
          "material": [
            {
              "locale": null,
              "scope": null,
              "data": "leather"
            }
          ],
          "variation_name": [
            {
              "locale": "en_US",
              "scope": null,
              "data": "Biker jacket leather"
            }
          ],
          "name": [
            {
              "locale": "en_US",
              "scope": null,
              "data": "Biker jacket"
            }
          ],
          "collection": [
            {
              "locale": null,
              "scope": null,
              "data": [
                "summer_2017"
              ]
            }
          ],
          "description": [
            {
              "locale": "en_US",
              "scope": "ecommerce",
              "data": "Biker jacket"
            }
          ]
        },
        "associations": {
          "PACK": {
            "products": [
              "sunglass"
            ],
            "product_models": [],
            "groups": []
          }
        },
        "quantified_associations": {
          "PRODUCT_SET": {
            "products": [
              {
                "identifier": "top",
                "quantity": 2
              },
              {
                "identifier": "cap",
                "quantity": 1
              }
            ],
            "product_models": [
              {
                "code": "model-biker-jacket-leather",
                "quantity": 2
              }
            ]
          }
        },
        "quality_scores": [
          {
            "scope": "ecommerce",
            "locale": "en_US",
            "data": "A"
          },
          {
            "scope": "ecommerce",
            "locale": "fr_FR",
            "data": "B"
          },
          {
            "scope": "tablet",
            "locale": "en_US",
            "data": "D"
          },
          {
            "scope": "tablet",
            "locale": "fr_FR",
            "data": "E"
          }
        ],
        "created": "2017-10-02T15:03:55+02:00",
        "updated": "2017-10-02T15:03:55+02:00"
      }
    ]
  }
}

Changes

  • 8d3381e59e6dRevision changes
    • warning

      deleted the query request parameter convert_measurements

    • warning

      deleted the query request parameter with_asset_share_links

    • warning

      deleted the query request parameter with_attribute_options

    • warning

      deleted the query request parameter with_workflow_execution_statuses

  • c9b867a3a9c3Revision changes
    • info

      added the new optional query request parameter with_workflow_execution_statuses