Category

Category information and navigation

Retrieve category detail page

get

Returns category information along with subcategory hierarchy for navigation.

Response Behavior:

1. Landing Page Mode (shallow categories) When the category depth is at or below the configured maximum (Source: Dynamic/Real-time Configuration):

• Returns category information with subcategories

• Includes up to 2 levels of nested subcategories

• Suitable for category landing pages

2. Listing Mode (deep categories) When the category depth exceeds the maximum:

• Returns product listing (faceted search results)

• Includes category metadata alongside product results

• Uses category-specific sort options when configured

Subcategory Structure:

• First level: Direct children of the requested category

• Second level: Children of direct children

• Each subcategory includes navigation URLs

Path parameters

category_idintegerRequired

Unique identifier of the category to retrieve.

Example: 150

Responses

200

Category detail retrieved successfully

application/json

Category detail response with subcategory navigation.

pkintegerRequired

Category identifier

Example: 150

namestringRequired

Display name of the category.

May be translated based on active language settings.

Example: Running Shoes

menuitemmodelstring · nullableOptional

UUID of the associated menu item for navigation.

Null if the category has no menu configuration.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

absolute_urlstring · uriOptional

Canonical URL for this category.

Use this for SEO-friendly category links.

Example: /categories/running-shoes/

uuidstring · uuidOptional

Universally unique identifier for the category.

Example: 550e8400-e29b-41d4-a716-446655440000

depthintegerOptional

Hierarchical depth level of the category.

Root categories have depth 1, their children have depth 2, etc.

Example: 3

pathstringOptional

Materialized path representing the category's position in the hierarchy.

Used internally for efficient hierarchical queries.

Example: 0001000200030004

sort_optioninteger · nullableOptional

ID of the default sort option for product listings in this category.

When set, product listings automatically use this sort order.

Example: 5

404

Category not found.

Occurs when:

• No category exists with the specified ID
• Category depth is 1 or less (root categories are not accessible)

get/category/{category_id}/

HTTPcURLJavaScriptPython

GET /category/{category_id}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "pk": 150,
  "name": "Running Shoes",
  "menuitemmodel": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "absolute_url": "/categories/running-shoes/",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "depth": 3,
  "path": "0001000200030004",
  "sort_option": 5,
  "sub_categories": [
    {
      "pk": 150,
      "name": "Running Shoes",
      "menuitemmodel": null,
      "absolute_url": "/categories/running-shoes/",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "depth": 3,
      "path": "text",
      "children": [
        {
          "pk": 150,
          "name": "Running Shoes",
          "menuitemmodel": null,
          "absolute_url": "/categories/running-shoes/",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "depth": 3,
          "path": "text"
        }
      ]
    }
  ]
}

Retrieve categories for a product

get

Returns all category nodes associated with a specific product.

Response Order: Categories are returned ordered by their path, ensuring hierarchical consistency for breadcrumb display.

Path parameters

product_idintegerRequired

Unique identifier of the product.

Example: 12345

Responses

200

Product categories retrieved successfully

application/json

Basic category node information.

pkintegerRequired

Category identifier

Example: 150

namestringRequired

Display name of the category

Example: Running Shoes

menuitemmodelstring · nullableOptional

UUID of associated menu item

absolute_urlstring · uriOptional

Canonical URL for this category

Example: /categories/running-shoes/

uuidstring · uuidOptional

depthintegerOptional

Hierarchical depth level

Example: 3

pathstringOptional

Materialized path

get/products/{product_id}/category_nodes/

HTTPcURLJavaScriptPython

GET /products/{product_id}/category_nodes/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

200

Product categories retrieved successfully

[
  {
    "pk": 150,
    "name": "Running Shoes",
    "menuitemmodel": null,
    "absolute_url": "/categories/running-shoes/",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "depth": 3,
    "path": "text"
  }
]