List

catalog Category List V1Get List Get

get

Get category list

Query parameters

searchCriteria[filterGroups][0][filters][0][field]stringOptional

Field

Example: <string>

searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>

searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>

searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>

searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>

searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>

searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /V1/categories/list HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "items": [
    {
      "id": "<integer>",
      "parent_id": "<integer>",
      "name": "<string>",
      "is_active": "<boolean>",
      "position": "<integer>",
      "level": "<integer>",
      "children": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "path": "<string>",
      "available_sort_by": [
        "<string>",
        "<string>"
      ],
      "include_in_menu": "<boolean>",
      "extension_attributes": "<object>",
      "custom_attributes": [
        {
          "attribute_code": "et incididunt laborum",
          "value": "aliquip reprehenderit"
        },
        {
          "attribute_code": "aliquip in in tempor incidi",
          "value": "amet culpa qui aliqua"
        }
      ]
    },
    {
      "id": "<integer>",
      "parent_id": "<integer>",
      "name": "<string>",
      "is_active": "<boolean>",
      "position": "<integer>",
      "level": "<integer>",
      "children": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "path": "<string>",
      "available_sort_by": [
        "<string>",
        "<string>"
      ],
      "include_in_menu": "<boolean>",
      "extension_attributes": "<object>",
      "custom_attributes": [
        {
          "attribute_code": "proident voluptate esse",
          "value": "irure do"
        },
        {
          "attribute_code": "velit Lorem in voluptate anim",
          "value": "aliq"
        }
      ]
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "non esse",
            "value": "sed non mollit incididunt aute",
            "condition_type": "ullamco irure"
          },
          {
            "field": "",
            "value": "eu commodo enim",
            "condition_type": "et culpa ut Lor"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "non minim Ut quis",
            "value": "enim eu",
            "condition_type": "in ut nulla enim"
          },
          {
            "field": "proident Lorem eu dolor dolor",
            "value": "officia enim cillum non",
            "condition_type": "velit deserunt Lorem dolore "
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "et anim mollit",
        "direction": "occaecat qui E"
      },
      {
        "field": "veniam nisi voluptate",
        "direction": "sed occaecat"
      }
    ],
    "page_size": 58380737,
    "current_page": -47638978
  },
  "total_count": -52259992
}