Path parameters

• categoryId integer Required

Query parameters

• storeId integer

Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  Category data interface.

  • id integer

    Category id.

  • parent_id integer

    Parent category ID

  • name string

    Category name

  • is_active boolean

    Whether category is active

  • position integer

    Category position

  • level integer

    Category level

  • children string

    Children ids comma separated.

  • created_at string

    Category creation date and time.

  • updated_at string

    Category last update date and time.

  • path string

    Category full path.

  • available_sort_by array[string]

    Available sort by for category.

  • include_in_menu boolean

    Category is included in menu.

  • extension_attributes object

    ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryInterface

  • custom_attributes array[object]

    Interface for custom attribute value.

    Hide custom_attributes attributes Show custom_attributes attributes object

    Interface for custom attribute value.

    • attribute_code string Required

      Attribute code

    • value string Required

      Attribute value

• 400

  400 Bad Request

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    Error details

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    Error parameters item

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace