SalesChannelCategoryNodes

PreviousSalesChannelDistricts NextSalesChannelProductStock

Was this helpful?

Delete a category node

delete

Deletes a specific category node for the specified sales channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Category node deleted successfully

403

Forbidden

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_nodes/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Retrieve detailed information about a category node

get

Retrieves detailed information about a specific category node for the specified sales channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Detailed category node information retrieved successfully

application/json

403

Forbidden

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_nodes/{id}/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "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-05-22T10:12:35.187Z",
        "modified_date": "2025-05-22T10:12:35.187Z"
      }
    ],
    "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-05-22T10:12:35.187Z",
      "modified_date": "2025-05-22T10:12:35.187Z"
    },
    "created_date": "2025-05-22T10:12:35.187Z",
    "modified_date": "2025-05-22T10:12:35.187Z"
  },
  "marketplace_attribute_set": 1,
  "children": [
    {
      "created_date": "2025-05-22T10:12:35.187Z",
      "modified_date": "2025-05-22T10:12:35.187Z",
      "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-05-22T10:12:35.187Z",
  "modified_date": "2025-05-22T10:12:35.187Z",
  "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 all category nodes

get

Retrieves a list of all category nodes for the specified sales channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

namestringOptional

Filters by name

is_activebooleanOptional

Filter by active status (True or False)

parentintegerOptional

Filter by parent category node ID

Responses

200

List of category nodes retrieved successfully

application/json

400

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

application/json

403

Forbidden

500

Server Error

get

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

[
  {
    "created_date": "2025-05-22T10:12:35.187Z",
    "modified_date": "2025-05-22T10:12:35.187Z",
    "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 all category nodes with detailed information

get

Retrieves a list of all category nodes for the specified sales channel with detailed information.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

namestringOptional

Filters by name

is_activebooleanOptional

Filter by active status (True or False)

parentintegerOptional

Filter by parent category node ID

Responses

200

List of category nodes with detailed information retrieved successfully

application/json

400

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

application/json

403

Forbidden

500

Server Error

get

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

[
  {
    "created_date": "2025-05-22T10:12:35.187Z",
    "modified_date": "2025-05-22T10:12:35.187Z",
    "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
  }
]

Retrieve a category node

get

Retrieves details of a specific category node for the specified sales channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Category node retrieved successfully

application/json

403

Forbidden

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_nodes/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "order": 1,
  "name": "Root Category",
  "remote_attributes": {},
  "sort_option": 1,
  "marketplace_attribute_set": 1,
  "created_date": "2025-05-22T10:12:35.187Z",
  "modified_date": "2025-05-22T10:12:35.187Z",
  "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
}

Move a category node in the tree structure

post

Moves a category node to a new position in the tree structure for the specified sales channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

nodeintegerRequired

ID of the node to move (must have depth greater than 1)

targetintegerRequired

ID of the target node to move to (must have depth greater than 1)

posstring · enumRequired

Position relative to the target node

Possible values:

Responses

200

Category node moved successfully

application/json

400

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

application/json

403

Forbidden

404

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

application/json

500

Server Error

post

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

{
  "node": 1,
  "target": 1,
  "pos": "left"
}

{
  "pk": 1,
  "order": 1,
  "name": "Root Category",
  "remote_attributes": {},
  "sort_option": 1,
  "marketplace_attribute_set": 1,
  "created_date": "2025-05-22T10:12:35.187Z",
  "modified_date": "2025-05-22T10:12:35.187Z",
  "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
}

Update a category node

put

Updates a specific category node for the specified sales channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

namestring · max: 64Optional

Name of the category node

orderintegerOptional

Order of the category node

sort_optioninteger | nullableOptional

ID of the sort option for the category node

attributesobjectOptional

Dynamic attributes for the category node

Responses

200

Category node updated successfully

application/json

400

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

application/json

403

Forbidden

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_nodes/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "name": "text",
  "order": 1,
  "sort_option": 1,
  "attributes": {}
}

{
  "pk": 1,
  "order": 1,
  "name": "Root Category",
  "remote_attributes": {},
  "sort_option": 1,
  "marketplace_attribute_set": 1,
  "created_date": "2025-05-22T10:12:35.187Z",
  "modified_date": "2025-05-22T10:12:35.187Z",
  "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
}

Partially update a category node

patch

Partially updates a specific category node for the specified sales channel.

Authorizations

Path parameters

channel_idintegerRequired

ID of the sales channel

idintegerRequired

ID of the category node

Body

namestring · max: 64Optional

Name of the category node

orderintegerOptional

Order of the category node

sort_optioninteger | nullableOptional

ID of the sort option for the category node

attributesobjectOptional

Dynamic attributes for the category node

Responses

200

Category node partially updated successfully

application/json

400

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

application/json

403

Forbidden

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_nodes/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "name": "text",
  "order": 1,
  "sort_option": 1,
  "attributes": {}
}

{
  "pk": 1,
  "order": 1,
  "name": "Root Category",
  "remote_attributes": {},
  "sort_option": 1,
  "marketplace_attribute_set": 1,
  "created_date": "2025-05-22T10:12:35.187Z",
  "modified_date": "2025-05-22T10:12:35.187Z",
  "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
}

Create a category node

post

Creates a new category node for the specified sales channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

namestring · max: 64Required

Name of the category node

orderintegerOptional

Order of the category node within its level

nodestringRequired

Parent node information for creating child category node

sort_optioninteger | nullableOptional

ID of the sort option for the category node

attributesobject | nullableOptional

Dynamic attributes for the category node

Responses

201

Category node created successfully

application/json

400

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

application/json

403

Forbidden

500

Server Error

post

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

{
  "name": "text",
  "order": 1,
  "node": "text",
  "sort_option": 1,
  "attributes": {}
}

{
  "pk": 1,
  "order": 1,
  "name": "Root Category",
  "remote_attributes": {},
  "sort_option": 1,
  "marketplace_attribute_set": 1,
  "created_date": "2025-05-22T10:12:35.187Z",
  "modified_date": "2025-05-22T10:12:35.187Z",
  "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
}