AKakeneo
Product [identifier]

Get list of products

Changed on

This endpoint allows you to get a list of products. Products are paginated and they can be filtered. 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/products

Request

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

Query parameters

searchstring

Filter products, 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

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_attribute_optionsboolean

Return labels of attribute options in the response. See <a href='/concepts/products.html#the-linked_data-format'>the linked_data format</a> section for more details. (Only available since the 5.0 version)

with_quality_scoresboolean

Return product quality scores in the response. (Only available since the 5.0 version)

with_completenessesboolean

Return product completenesses in the response. (Only available since the 6.0 version)

Response

Return products paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "identifier": "top",
        "enabled": true,
        "family": "tshirt",
        "categories": [
          "summer_collection"
        ],
        "groups": [],
        "parent": null,
        "values": {
          "name": [
            {
              "data": "Top",
              "locale": "en_US",
              "scope": null,
              "attribute_type": "pim_catalog_text"
            },
            {
              "data": "Débardeur",
              "locale": "fr_FR",
              "scope": null,
              "attribute_type": "pim_catalog_text"
            }
          ],
          "description": [
            {
              "data": "Summer top",
              "locale": "en_US",
              "scope": "ecommerce",
              "attribute_type": "pim_catalog_textarea"
            },
            {
              "data": "Top",
              "locale": "en_US",
              "scope": "tablet",
              "attribute_type": "pim_catalog_textarea"
            },
            {
              "data": "Débardeur pour l'été",
              "locale": "fr_FR",
              "scope": "ecommerce",
              "attribute_type": "pim_catalog_textarea"
            },
            {
              "data": "Débardeur",
              "locale": "fr_FR",
              "scope": "tablet",
              "attribute_type": "pim_catalog_textarea"
            }
          ],
          "price": [
            {
              "locale": null,
              "scope": null,
              "data": [
                {
                  "amount": "15.5",
                  "currency": "EUR"
                },
                {
                  "amount": "15",
                  "currency": "USD"
                }
              ],
              "attribute_type": "pim_catalog_price_collection"
            }
          ],
          "color": [
            {
              "locale": null,
              "scope": null,
              "data": "black",
              "linked_data": {
                "attribute": "color",
                "code": "black",
                "labels": {
                  "en_US": "Black",
                  "fr_FR": "Noir"
                }
              },
              "attribute_type": "pim_catalog_simpleselect"
            }
          ],
          "size": [
            {
              "locale": null,
              "scope": null,
              "data": "m",
              "linked_data": {
                "attribute": "size",
                "code": "m",
                "labels": {
                  "en_US": "M",
                  "fr_FR": "M"
                }
              },
              "attribute_type": "pim_catalog_simpleselect"
            }
          ],
          "collection": [
            {
              "locale": null,
              "scope": null,
              "data": [
                "winter_2016"
              ],
              "linked_data": {
                "winter_2016": {
                  "attribute": "collection",
                  "code": "winter_2016",
                  "labels": {
                    "en_US": "Winter 2016",
                    "fr_FR": "Hiver 2016"
                  }
                }
              },
              "attribute_type": "pim_catalog_multiselect"
            }
          ]
        },
        "created": "2016-06-23T18:24:44+02:00",
        "updated": "2016-06-25T17:56:12+02:00",
        "associations": {
          "PACK": {
            "products": [
              "sunglass"
            ],
            "product_models": [],
            "groups": []
          }
        },
        "quantified_associations": {
          "PRODUCT_SET": {
            "products": [
              {
                "identifier": "cap",
                "quantity": 2
              },
              {
                "identifier": "shoes",
                "quantity": 1
              }
            ],
            "product_models": [
              {
                "identifier": "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"
          }
        ],
        "completenesses": [
          {
            "scope": "ecommerce",
            "locale": "en_US",
            "data": 10
          },
          {
            "scope": "ecommerce",
            "locale": "fr_FR",
            "data": 20
          },
          {
            "scope": "tablet",
            "locale": "en_US",
            "data": 30
          },
          {
            "scope": "tablet",
            "locale": "fr_FR",
            "data": 40
          }
        ]
      }
    ]
  }
}

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_workflow_execution_statuses

  • c9b867a3a9c3Revision changes
    • info

      added the new optional query request parameter with_workflow_execution_statuses