SalesChannelProductCategories

Get product category

get

Retrieve a specific product category by ID.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Product category

application/json

403

Forbidden

404

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

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_categories/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "product": 1,
  "category": 1,
  "modified_date": "2025-05-22T10:38:07.678Z",
  "created_date": "2025-05-22T10:38:07.678Z"
}

Update product category (full update)

put

Update a product category with full replacement of fields.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

idintegerRequired

Unique identifier of the resource

Example: 1

Body

productinteger · int64Required

ID of the product to categorize

categoryinteger · int64Required

ID of the category node

Responses

200

Product category 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

422

Invalid product or category

application/json

500

Server Error

put

HTTPcURLJavaScriptPython

PUT /api/v1/channel/{channel_id}/product_categories/{id}/ HTTP/1.1
Host: 
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-05-22T10:38:07.678Z",
  "created_date": "2025-05-22T10:38:07.678Z"
}

Delete product category

delete

Delete a specific product category by ID. This will remove the association between the product and category.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Product category deleted successfully

403

Forbidden

404

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

application/json

500

Server Error

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/channel/{channel_id}/product_categories/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Update product category (partial update)

patch

Partially update a product category.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

idintegerRequired

Unique identifier of the resource

Example: 1

Body

productinteger · int64Optional

ID of the product to categorize

categoryinteger · int64Optional

ID of the category node

Responses

200

Product category 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

422

Invalid product or category

application/json

500

Server Error

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/channel/{channel_id}/product_categories/{id}/ HTTP/1.1
Host: 
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-05-22T10:38:07.678Z",
  "created_date": "2025-05-22T10:38:07.678Z"
}

Get detailed product category

get

Retrieve detailed information for a specific product category, including full product and category details.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Detailed product category information

application/json

403

Forbidden

404

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

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_categories/{id}/detailed/ HTTP/1.1
Host: 
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-05-22T10:38:07.678Z",
    "data_source": 1,
    "created_date": "2025-05-22T10:38:07.678Z",
    "modified_date": "2025-05-22T10:38:07.678Z",
    "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-05-22T10:38:07.678Z",
    "modified_date": "2025-05-22T10:38:07.678Z",
    "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 bulk create status

get

Get the current status of a bulk create operation. Returns progress information, errors, and overall status of the operation.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

pkstring · uuidRequired

Bulk operation cache key

Responses

200

Bulk operation status

application/json

404

Invalid cache key

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_categories/{pk}/bulk_create_status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "progress": [
    [
      50,
      100
    ],
    [
      25,
      100
    ]
  ],
  "errors": [
    "text"
  ],
  "chunk_count": 1,
  "status": "waiting"
}

Get bulk delete status

get

Get the current status of a bulk delete operation. Returns progress information, errors, and overall status of the operation.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

pkstring · uuidRequired

Bulk operation cache key

Responses

200

Bulk operation status

application/json

404

Invalid bulk operation cache key

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_categories/{pk}/bulk_delete_status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "progress": [
    [
      50,
      100
    ],
    [
      25,
      100
    ]
  ],
  "errors": [
    "text"
  ],
  "chunk_count": 1,
  "status": "waiting"
}

List product categories

get

Retrieve a list of all product categories for the specified channel. Results can be filtered by product or category.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

Query parameters

productinteger · int64Optional

Filter by product ID

categoryinteger · int64Optional

Filter by category ID

Responses

200

List of product categories

application/json

403

Forbidden

404

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

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_categories/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "pk": 1,
    "product": 1,
    "category": 1,
    "modified_date": "2025-05-22T10:38:07.678Z",
    "created_date": "2025-05-22T10:38:07.678Z"
  }
]

Create product category

post

Create a new product category. Associates a product with a category in the channel's category tree.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

Body

productinteger · int64Required

ID of the product to categorize

categoryinteger · int64Required

ID of the category node

Responses

201

Product category created 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

422

Invalid product or category

application/json

500

Server Error

post

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/product_categories/ HTTP/1.1
Host: 
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-05-22T10:38:07.678Z",
  "created_date": "2025-05-22T10:38:07.678Z"
}

List detailed product categories

get

Retrieve a detailed list of all product categories for the specified channel, including full product and category information.

Authorizations

Path parameters

channel_idinteger · int64Required

Channel ID to operate on

Query parameters

productinteger · int64Optional

Filter by product ID

categoryinteger · int64Optional

Filter by category ID

Responses

200

Detailed list of product categories

application/json

403

Forbidden

404

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

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_categories/detailed/ HTTP/1.1
Host: 
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-05-22T10:38:07.678Z",
      "data_source": 1,
      "created_date": "2025-05-22T10:38:07.678Z",
      "modified_date": "2025-05-22T10:38:07.678Z",
      "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-05-22T10:38:07.678Z",
      "modified_date": "2025-05-22T10:38:07.678Z",
      "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
    }
  }
]