Docs
Catalog API
Category trees
Categories

Categories

Get All Categories

GET /catalog/trees/categories

Request

Returns a list of categories.

To get a specific category in a tree, provide a category ID.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

List of categories.

Body

object | application/json

  • data    array[object]

  • meta    object

Get Category 12

Create Categories

POST /catalog/trees/categories

Request

Creates new categories.

Creating a category requires:

  • name
  • tree_id or parent_id

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

array | application/json

example

Response

Created

Body

object | application/json

  • data    array[object]

  • meta    object

Create Category 36

Update Categories

PUT /catalog/trees/categories

Request

Updates existing categories.

To update a specific category in a tree, provide a category id.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

array | application/json

example

Response

OK

Body

object | application/json

  • meta    object

example

Delete categories

DELETE /catalog/trees/categories

Request

Deletes categories.

To delete a specific category in a tree, provide a category ID.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Categories are deleted

Body

object | application/json

  • meta    object

example

Did you find what you were looking for?
Get a category treeGet All Categories