SalesChannelCategoryTree

Retrieve a category tree object

get

Returns category tree object with given ID related with the sales channel with given channel_id

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

namestringOptional

Filters by name

category_rootintegerOptional

Root category node ID

Responses

200

Category tree object retrieved successfully.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/category_trees/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "text",
  "category_root": {
    "pk": 1,
    "order": 1,
    "name": "Root Category",
    "remote_attributes": {},
    "sort_option": 1,
    "marketplace_attribute_set": 1,
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  },
  "created_date": "2025-06-27T08:53:29.392Z",
  "modified_date": "2025-06-27T08:53:29.392Z"
}

Update a Category Tree

put

Updates a category tree with ID for given sales channel_id with full data

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

pkinteger · int64Read-onlyOptional

Category Tree ID

Example: 1

namestring · max: 255Optional

Responses

200

Category tree updated successfully

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put

PUT /api/v1/channel/{channel_id}/category_trees/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 495

{
  "name": "text",
  "category_root": {
    "order": 1,
    "name": "Root Category",
    "remote_attributes": {},
    "sort_option": 1,
    "marketplace_attribute_set": 1,
    "modified_date": "2025-06-27T08:53:29.392Z",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  },
  "modified_date": "2025-06-27T08:53:29.392Z"
}

{
  "pk": 1,
  "name": "text",
  "category_root": {
    "pk": 1,
    "order": 1,
    "name": "Root Category",
    "remote_attributes": {},
    "sort_option": 1,
    "marketplace_attribute_set": 1,
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  },
  "created_date": "2025-06-27T08:53:29.392Z",
  "modified_date": "2025-06-27T08:53:29.392Z"
}

Delete a category tree

delete

Delete a Category Tree with ID related with the sales channel with channel_id

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

No content

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

delete

DELETE /api/v1/channel/{channel_id}/category_trees/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Partially update a Category Tree

patch

Updates a category tree with ID for given sales channel_id with partial data

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

pkinteger · int64Read-onlyOptional

Category Tree ID

Example: 1

namestring · max: 255Optional

Responses

200

Success

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

PATCH /api/v1/channel/{channel_id}/category_trees/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 495

{
  "name": "text",
  "category_root": {
    "order": 1,
    "name": "Root Category",
    "remote_attributes": {},
    "sort_option": 1,
    "marketplace_attribute_set": 1,
    "modified_date": "2025-06-27T08:53:29.392Z",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  },
  "modified_date": "2025-06-27T08:53:29.392Z"
}

{
  "pk": 1,
  "name": "text",
  "category_root": {
    "pk": 1,
    "order": 1,
    "name": "Root Category",
    "remote_attributes": {},
    "sort_option": 1,
    "marketplace_attribute_set": 1,
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  },
  "created_date": "2025-06-27T08:53:29.392Z",
  "modified_date": "2025-06-27T08:53:29.392Z"
}

Retrieve a category tree object with detailed information

get

Returns category tree object with given ID related with the sales channel with given channel_id with detailed information

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

namestringOptional

Filters by name

category_rootintegerOptional

Root category node ID

Responses

200

Category tree object retrieved successfully.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/category_trees/{id}/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "name": "text",
  "category_root": {
    "pk": 1,
    "order": 1,
    "name": "Root Category",
    "remote_attributes": {},
    "sort_option": {
      "pk": 1,
      "channel": 1,
      "catalog": 1,
      "value": "price_asc",
      "uid": "sort_12345",
      "disable_score": false,
      "label": "Price Ascending",
      "order": 1,
      "is_default": false,
      "is_visible": true,
      "sorting_algorithms": [
        {
          "created_date": "2025-06-27T08:53:29.392Z",
          "modified_date": "2025-06-27T08:53:29.392Z"
        }
      ],
      "static_sorting_algorithm": {
        "pk": 1,
        "catalog": 1,
        "code": "price_asc",
        "name": "Price Ascending",
        "sorting_type": "static",
        "ruleset": [
          {
            "exp": [
              {
                "field": "stock"
              },
              {
                "attribute": "stock"
              }
            ],
            "mode": "sum",
            "path": "r0001",
            "order": "desc",
            "rule_type": "sorter"
          }
        ],
        "config": {
          "mode": "max",
          "order": "asc",
          "client": "stream",
          "base_url": "http://cdn_url/stream_files/test.csv",
          "delimeter": ";",
          "file_format": "csv"
        },
        "is_visible": true,
        "created_date": "2025-06-27T08:53:29.392Z",
        "modified_date": "2025-06-27T08:53:29.392Z"
      },
      "created_date": "2025-06-27T08:53:29.392Z",
      "modified_date": "2025-06-27T08:53:29.392Z"
    },
    "marketplace_attribute_set": 1,
    "children": [
      {
        "created_date": "2025-06-27T08:53:29.392Z",
        "modified_date": "2025-06-27T08:53:29.392Z",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "attributes": {
          "key1": "value1",
          "key2": "value2"
        },
        "attributes_kwargs": {
          "key1": "value1",
          "key2": "value2"
        },
        "localized_attributes": {
          "name": {
            "en": "English",
            "es": "Spanish"
          }
        },
        "localized_attributes_kwargs": {
          "key": {
            "key1": "value1",
            "key2": "value2"
          }
        },
        "path": "0001",
        "depth": 1,
        "numchild": 2
      }
    ],
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  },
  "created_date": "2025-06-27T08:53:29.392Z",
  "modified_date": "2025-06-27T08:53:29.392Z"
}

List Category Trees for the channel

get

Returns a list of all category trees for the sales channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

namestringOptional

Filters by name

category_rootintegerOptional

Root category node ID

Responses

200

List of category trees for the channel

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/category_trees/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z"
  }
]

Create a sales channel category tree

post

Create a new sales channel category tree for the channel with channel_id.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

all ofOptional

Responses

201

Sales channel category tree created successfully.

application/json

Responseall of

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

406

A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.

application/json

500

Server Error

post

POST /api/v1/channel/{channel_id}/category_trees/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 495

{
  "name": "text",
  "category_root": {
    "order": 1,
    "name": "Root Category",
    "remote_attributes": {},
    "sort_option": 1,
    "marketplace_attribute_set": 1,
    "modified_date": "2025-06-27T08:53:29.392Z",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  },
  "modified_date": "2025-06-27T08:53:29.392Z"
}

{
  "pk": 1,
  "name": "text",
  "category_root": {
    "pk": 1,
    "order": 1,
    "name": "Root Category",
    "remote_attributes": {},
    "sort_option": 1,
    "marketplace_attribute_set": 1,
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  },
  "created_date": "2025-06-27T08:53:29.392Z",
  "modified_date": "2025-06-27T08:53:29.392Z"
}

List Category Trees for the channel with detailed information

get

Returns a list of all category trees for the sales channel with detailed information

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

namestringOptional

Filters by name

category_rootintegerOptional

Root category node ID

Responses

200

List of category trees for the channel with detailed information

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/category_trees/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z"
  }
]

List category tree children objects for a specific channel.

get

List category tree children objects of category tree with ID for sales channel with channel_id.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

idintegerOptional

Filters by id

pkintegerOptional

Filters by primary key

namestringOptional

Filters by name

name__exactstringOptional

Filters by exact name

pathstringOptional

Filter by path

path__exactstringOptional

Filter by exact path

path__startswithstringOptional

Filter by path start with the given string

Responses

200

A list of category tree children node objects for given channel.

application/json

401

Unauthorized Access

application/json

403

Forbidden

500

Server Error

get

GET /api/v1/channel/{channel_id}/category_trees/{id}/children/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  }
]

List children nodes of root node of category tree.

get

List all children node of root node for category tree with given ID related with sales channel with channel_id.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

idintegerOptional

Filters by id

pkintegerOptional

Filters by primary key

namestringOptional

Filters by name

name__exactstringOptional

Filters by exact name

pathstringOptional

Filter by path

path__exactstringOptional

Filter by exact path

path__startswithstringOptional

Filter by path start with the given string

Responses

200

A list of category tree children node objects for given channel.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/category_trees/{id}/tree/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  }
]

List children nodes of root node of category tree with detailed information.

get

List all children node of root node for category tree with given ID related with sales channel with channel_id with detailed information.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

idintegerOptional

Filters by id

pkintegerOptional

Filters by primary key

namestringOptional

Filters by name

name__exactstringOptional

Filters by exact name

pathstringOptional

Filter by path

path__exactstringOptional

Filter by exact path

path__startswithstringOptional

Filter by path start with the given string

Responses

200

A list of category tree children node objects for given channel.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

406

A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/category_trees/{id}/tree_detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "created_date": "2025-06-27T08:53:29.392Z",
    "modified_date": "2025-06-27T08:53:29.392Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "key1": "value1",
      "key2": "value2"
    },
    "attributes_kwargs": {
      "key1": "value1",
      "key2": "value2"
    },
    "localized_attributes": {
      "name": {
        "en": "English",
        "es": "Spanish"
      }
    },
    "localized_attributes_kwargs": {
      "key": {
        "key1": "value1",
        "key2": "value2"
      }
    },
    "path": "0001",
    "depth": 1,
    "numchild": 2
  }
]