Skip to main content

createCategory

Create a new category with description.

Import​

import { createCategory } from "@evershop/evershop/catalog/services";

Syntax​

createCategory(data: CategoryData, context?: Record<string, any>): Promise<Category>

Parameters​

data

Type: CategoryData

{
  name: string;         // Required
  url_key: string;      // Required
  status?: number;
  parent_id?: number;
  position?: number;
  description?: string;
  [key: string]: any;
}

context

Type: Record<string, any> (optional)

Context object for hooks.

Return Value​

Returns Promise<Category> with created category data.

Examples​

Basic Category​

import { createCategory } from "@evershop/evershop/catalog/services";

const category = await createCategory({
  name: "Electronics",
  url_key: "electronics"
});

With Parent Category​

import { createCategory } from "@evershop/evershop/catalog/services";

const subcategory = await createCategory({
  name: "Laptops",
  url_key: "laptops",
  parent_id: 5,
  status: 1
});

See Also​