MICRO-BASE

category.create

This method is used to create a Category.

Version

v1

Arguments

This method has the path /catalog/<version>/category.create and follows the MicroBase API calling conventions.

Argument Required Type Example Description
title yes String Category with classifications 01 Category title to show in the store.
description no String This is the Category with classifications 01 Category description.
slug yes String categorywithclass01 String to be used in the url. Parent+slug must be unique.
parent yes String ROOT The parent Category id. 'ROOT' is the root category.
classifications no Classification List [{"id": "size", "description": "Size", "type": "NUMBER", "mandatory": yes}] List of classifications the product must have to belog to this Category.

Classifications

Argument Required Type Example Description
id yes String color The Classification id.
description yes String Color A Description for this Classification.
type yes String STRING The data type [STRING, BOOLEAN, NUMBER]
mandatory yes Boolean true The Product must have a value for this Classification to belog to this Category..

Response

Returns a Category object:

{
    "ok": true,
    "category": {
        "id": "SJlkcsaQ",
        "level": 2,
        "title": "Category with classifications 01",
        "description": "This is the Category with classifications 01",
        "slug": "categorywithclass01",
        "parent": "ROOT",
        "classifications": [
            {"id": "size", "description": "Size", "type": "NUMBER", "mandatory": true},
            {"id": "tech", "description": "Technology", "type": "STRING", "mandatory": true}
        ]
    }
}

Errors

Expected errors that this method could return. Some errors return additional data.

Error Data Description
parent_category_not_found The id not found Parent Category not found
duplicate_key Index name and data causing the error Some unique key violation
validation_error The data causing the error Some validation error

Example

curl --request POST \
  --url http://localhost:3000/services/catalog/v1/category.create \
  --header 'authorization: Bearer xxxxx...' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"title": "Category 02", "description": "This is the Category 02",
           "slug": "category02", "parent": "S1_B6X97"}'

© MicroBase