SalesChannelProductCategories
Retrieve a specific product category by ID.
Channel ID to operate on
Unique identifier of the resource
1Product category
Forbidden
The given resource or object was not found or does not exist.
Server Error
GET /api/v1/channel/{channel_id}/product_categories/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"pk": 1,
"product": 1,
"category": 1,
"modified_date": "2025-08-29T23:42:24.394Z",
"created_date": "2025-08-29T23:42:24.394Z"
}Update a product category with full replacement of fields.
Channel ID to operate on
Unique identifier of the resource
1ID of the product to categorize
ID of the category node
Product category updated successfully
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Invalid product or category
Server Error
PUT /api/v1/channel/{channel_id}/product_categories/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"product": 1,
"category": 1
}{
"pk": 1,
"product": 1,
"category": 1,
"modified_date": "2025-08-29T23:42:24.394Z",
"created_date": "2025-08-29T23:42:24.394Z"
}Delete a specific product category by ID. This will remove the association between the product and category.
Channel ID to operate on
Unique identifier of the resource
1Product category deleted successfully
No content
Forbidden
The given resource or object was not found or does not exist.
Server Error
DELETE /api/v1/channel/{channel_id}/product_categories/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Partially update a product category.
Channel ID to operate on
Unique identifier of the resource
1ID of the product to categorize
ID of the category node
Product category updated successfully
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Invalid product or category
Server Error
PATCH /api/v1/channel/{channel_id}/product_categories/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"product": 1,
"category": 1
}{
"pk": 1,
"product": 1,
"category": 1,
"modified_date": "2025-08-29T23:42:24.394Z",
"created_date": "2025-08-29T23:42:24.394Z"
}Retrieve detailed information for a specific product category, including full product and category details.
Channel ID to operate on
Unique identifier of the resource
1Detailed product category information
Forbidden
The given resource or object was not found or does not exist.
Server Error
GET /api/v1/channel/{channel_id}/product_categories/{id}/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"pk": 1,
"product": {
"id": 1,
"name": "text",
"base_code": "text",
"sku": "text",
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"description": "text",
"brand": 1,
"erp_categories": [
1
],
"tax_rate": 1,
"weight": 1,
"product_type": "pre_product",
"productization_date": "2025-08-29T23:42:24.394Z",
"data_source": 1,
"created_date": "2025-08-29T23:42:24.394Z",
"modified_date": "2025-08-29T23:42:24.394Z",
"is_active": true,
"attribute_set": 1,
"parent": 1,
"group_products": [
1
],
"attributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"listing_code": "text",
"is_seller_product": false,
"custom_attribute_set": 1
},
"category": {
"pk": 1,
"order": 1,
"name": "Root Category",
"remote_attributes": {},
"sort_option": 1,
"marketplace_attribute_set": 1,
"created_date": "2025-08-29T23:42:24.394Z",
"modified_date": "2025-08-29T23:42:24.394Z",
"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
}
}Get the current status of a bulk create operation. Returns progress information, errors, and overall status of the operation.
Channel ID to operate on
Bulk operation cache key
Bulk operation status
Invalid cache key
Server Error
GET /api/v1/channel/{channel_id}/product_categories/{pk}/bulk_create_status/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"progress": [
[
50,
100
],
[
25,
100
]
],
"errors": [
"text"
],
"chunk_count": 1,
"status": "waiting"
}Get the current status of a bulk delete operation. Returns progress information, errors, and overall status of the operation.
Channel ID to operate on
Bulk operation cache key
Bulk operation status
Invalid bulk operation cache key
Server Error
GET /api/v1/channel/{channel_id}/product_categories/{pk}/bulk_delete_status/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"progress": [
[
50,
100
],
[
25,
100
]
],
"errors": [
"text"
],
"chunk_count": 1,
"status": "waiting"
}Retrieve a list of all product categories for the specified channel. Results can be filtered by product or category.
Channel ID to operate on
Filter by product ID
Filter by category ID
List of product categories
Forbidden
The given resource or object was not found or does not exist.
Server Error
GET /api/v1/channel/{channel_id}/product_categories/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
[
{
"pk": 1,
"product": 1,
"category": 1,
"modified_date": "2025-08-29T23:42:24.394Z",
"created_date": "2025-08-29T23:42:24.394Z"
}
]Create a new product category. Associates a product with a category in the channel's category tree.
Channel ID to operate on
ID of the product to categorize
ID of the category node
Product category created successfully
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Invalid product or category
Server Error
POST /api/v1/channel/{channel_id}/product_categories/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"product": 1,
"category": 1
}{
"pk": 1,
"product": 1,
"category": 1,
"modified_date": "2025-08-29T23:42:24.394Z",
"created_date": "2025-08-29T23:42:24.394Z"
}Retrieve a detailed list of all product categories for the specified channel, including full product and category information.
Channel ID to operate on
Filter by product ID
Filter by category ID
Detailed list of product categories
Forbidden
The given resource or object was not found or does not exist.
Server Error
GET /api/v1/channel/{channel_id}/product_categories/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
[
{
"pk": 1,
"product": {
"id": 1,
"name": "text",
"base_code": "text",
"sku": "text",
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"description": "text",
"brand": 1,
"erp_categories": [
1
],
"tax_rate": 1,
"weight": 1,
"product_type": "pre_product",
"productization_date": "2025-08-29T23:42:24.394Z",
"data_source": 1,
"created_date": "2025-08-29T23:42:24.394Z",
"modified_date": "2025-08-29T23:42:24.394Z",
"is_active": true,
"attribute_set": 1,
"parent": 1,
"group_products": [
1
],
"attributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"listing_code": "text",
"is_seller_product": false,
"custom_attribute_set": 1
},
"category": {
"pk": 1,
"order": 1,
"name": "Root Category",
"remote_attributes": {},
"sort_option": 1,
"marketplace_attribute_set": 1,
"created_date": "2025-08-29T23:42:24.394Z",
"modified_date": "2025-08-29T23:42:24.394Z",
"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
}
}
]Was this helpful?