ReDoc documentation

categories

categories

post/V1/categories

Create category service

Request
Request Body schema:
required
object (catalog-data-category-interface)

Category data interface.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "category": {
    }
}
Response samples
{
  • "id": 0,
  • "parent_id": 0,
  • "name": "string",
  • "is_active": true,
  • "position": 0,
  • "level": 0,
  • "children": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "path": "string",
  • "available_sort_by": [
    ],
  • "include_in_menu": true,
  • "extension_attributes": { },
  • "custom_attributes": [
    ]
}

categories

get/V1/categories

Retrieve list of categories

Request
query Parameters
depth
integer
rootCategoryId
integer
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "id": 0,
  • "parent_id": 0,
  • "name": "string",
  • "is_active": true,
  • "position": 0,
  • "level": 0,
  • "product_count": 0,
  • "children_data": [
    ]
}
➔ Next to categories/attributes