Categories

PreviousPrice NextAttributes

catalog Category Repository V1Get Get

Get info about category by category id

get

/V1/categories/{categoryId}

Path parameters

categoryIdstringrequired

(Required)

Example: <integer>

Query parameters

storeIdstring

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/categories/{categoryId}'

200

400

401

500

{
  "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": "eiusmod ",
      "value": "ad Duis"
    },
    {
      "attribute_code": "ea culpa non",
      "value": "velit amet cupidatat voluptat"
    }
  ]
}

catalog Category Repository V1Delete By Identifier Delete

Delete category by identifier

delete

/V1/categories/{categoryId}

Path parameters

categoryIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/categories/{categoryId}'

200

400

401

500

true

catalog Category Management V1Get Tree Get

Retrieve list of categories

get

/V1/categories

Query parameters

rootCategoryIdstring

Example: <integer>

depthstring

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/categories'

200

400

401

500

{
  "parent_id": 26754765,
  "name": "dolor aute dolor",
  "is_active": true,
  "position": -53767669,
  "level": -53523165,
  "product_count": -94612641,
  "children_data": [
    {
      "parent_id": 93169546,
      "name": "veniam",
      "is_active": true,
      "position": 61733533,
      "level": -72806713,
      "product_count": -13820376,
      "children_data": [
        {
          "value": "<Circular reference to #/components/schemas/catalog-data-category-tree-interface detected>"
        },
        {
          "value": "<Circular reference to #/components/schemas/catalog-data-category-tree-interface detected>"
        }
      ],
      "id": 18636963
    },
    {
      "parent_id": 7266434,
      "name": "dolor cupidatat",
      "is_active": false,
      "position": -26625054,
      "level": 32289413,
      "product_count": 99970108,
      "children_data": [
        {
          "value": "<Circular reference to #/components/schemas/catalog-data-category-tree-interface detected>"
        },
        {
          "value": "<Circular reference to #/components/schemas/catalog-data-category-tree-interface detected>"
        }
      ],
      "id": -10762474
    }
  ],
  "id": 58964669
}

catalog Category Repository V1Save Post

Create category service

post

/V1/categories

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"category":{"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":"incididunt quis in","value":"culpa deserunt"},{"attribute_code":"dolore in dolore","value":"fugiat in sed Lorem"}]}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/categories' \
  --header 'Content-Type: application/json' \
  --data '{
    "category": {
      "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": "incididunt quis in",
          "value": "culpa deserunt"
        },
        {
          "attribute_code": "dolore in dolore",
          "value": "fugiat in sed Lorem"
        }
      ]
    }
  }'

200

400

401

500

{
  "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": "eiusmod ",
      "value": "ad Duis"
    },
    {
      "attribute_code": "ea culpa non",
      "value": "velit amet cupidatat voluptat"
    }
  ]
}

catalog Category Repository V1Save Put

Create category service

put

/V1/categories/{id}

Path parameters

idstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"category":{"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":"incididunt quis in","value":"culpa deserunt"},{"attribute_code":"dolore in dolore","value":"fugiat in sed Lorem"}]}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/categories/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "category": {
      "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": "incididunt quis in",
          "value": "culpa deserunt"
        },
        {
          "attribute_code": "dolore in dolore",
          "value": "fugiat in sed Lorem"
        }
      ]
    }
  }'

200

400

401

500

{
  "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": "eiusmod ",
      "value": "ad Duis"
    },
    {
      "attribute_code": "ea culpa non",
      "value": "velit amet cupidatat voluptat"
    }
  ]
}