v1

latestSwagger 2.02026-07-13137761.0 MB

Get list of categories

This endpoint allows you to get a list of categories. Categories are paginated and sorted by root/left.

get/api/rest/v1/categories

Query parameters

searchstring

Filter categories, for more details see the <a href="/documentation/filter.html#filter-categories">Filters</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

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_positionboolean

Return information about category position into its category tree (only available since the 7.0 version)

Response

Return categories paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "code": "winter_collection",
        "parent": null,
        "updated": "2021-05-22T12:48:00+02:00",
        "position": 1,
        "labels": {
          "en_US": "Winter collection",
          "fr_FR": "Collection hiver"
        },
        "values": {
          "description|96b88bf4-c2b7-4b64-a1f9-5d4876c02c26|ecommerce|en_US": {
            "data": "<p>Winter collection description</p>\n",
            "type": "textarea",
            "channel": "ecommerce",
            "locale": "en_US",
            "attribute_code": "description|96b88bf4-c2b7-4b64-a1f9-5d4876c02c26"
          },
          "image_1|871b8686-79b5-415c-9c6f-a38f8732dfb7|ecommerce|en_US": {
            "data": {
              "size": 1401359,
              "extension": "jpg",
              "file_path": "2/d/c/7/2dc791671d726e7438219d5dc7fd51a53d6bf2bb_IMG_7860.jpg",
              "mime_type": "image/jpeg",
              "original_filename": "IMG_7860.jpg"
            },
            "type": "image",
            "channel": "ecommerce",
            "locale": "en_US",
            "attribute_code": "image_1|871b8686-79b5-415c-9c6f-a38f8732dfb7"
          }
        },
        "channel_requirements": [
          "ecommerce",
          "mobile"
        ]
      }
    ]
  }
}