Create Category

Create category

curl --request POST \
  --url https://api.komerza.com/stores/{storeId}/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "visibility": 0,
  "productIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "slug": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "visibility": 0,
    "order": 123,
    "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "products": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "description": "<string>",
        "imageNames": [
          "<string>"
        ],
        "rating": 123,
        "order": 123,
        "visibility": 0,
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variants": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "cost": 123,
            "minimumQuantity": 123,
            "maximumQuantity": 123,
            "order": 123,
            "requireDiscordAuthorization": true,
            "type": 0,
            "deliveryTypes": [
              "<string>"
            ],
            "imageNames": [
              "<string>"
            ],
            "stock": 123,
            "stockMode": 0,
            "customFields": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "label": "<string>",
                "identifier": "<string>",
                "type": "<string>",
                "isRequired": true,
                "options": [
                  {
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "label": "<string>",
                    "value": "<string>",
                    "order": 123
                  }
                ],
                "placeholder": "<string>",
                "hint": "<string>"
              }
            ],
            "subscriptionPeriod": "<string>",
            "subscriptionId": "<string>"
          }
        ],
        "isBestSeller": true,
        "slug": "<string>",
        "metadata": "<string>"
      }
    ],
    "slug": "<string>"
  }
}

POST

stores

{storeId}

categories

Create category

curl --request POST \
  --url https://api.komerza.com/stores/{storeId}/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "visibility": 0,
  "productIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "slug": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "visibility": 0,
    "order": 123,
    "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "products": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "description": "<string>",
        "imageNames": [
          "<string>"
        ],
        "rating": 123,
        "order": 123,
        "visibility": 0,
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variants": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "cost": 123,
            "minimumQuantity": 123,
            "maximumQuantity": 123,
            "order": 123,
            "requireDiscordAuthorization": true,
            "type": 0,
            "deliveryTypes": [
              "<string>"
            ],
            "imageNames": [
              "<string>"
            ],
            "stock": 123,
            "stockMode": 0,
            "customFields": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "label": "<string>",
                "identifier": "<string>",
                "type": "<string>",
                "isRequired": true,
                "options": [
                  {
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "label": "<string>",
                    "value": "<string>",
                    "order": 123
                  }
                ],
                "placeholder": "<string>",
                "hint": "<string>"
              }
            ],
            "subscriptionPeriod": "<string>",
            "subscriptionId": "<string>"
          }
        ],
        "isBestSeller": true,
        "slug": "<string>",
        "metadata": "<string>"
      }
    ],
    "slug": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your API key goes here

Path Parameters

storeId

string<uuid>

required

The ID of the store to create the category in

Body

application/json

The form containing the details of the new category

Form for creating or updating a category in a store

name

string

required

The name of the category

Required string length: 3 - 128

visibility

enum<integer>

required

List of product visibility (or privacy) levels

Available options:

0,

1,

2

productIds

string<uuid>[]

required

The list of product IDs in this category. This replaces the existing product list.

slug

string | null

The slug of the category, if null then the ID is used

Required string length: 1 - 72

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success

boolean

required

Indicates whether the operation or response was successful.

message

string | null

A descriptive message providing additional context or information about the response.

code

string | null

The error code (if there was an error) to use when referencing the error

data

object

Represents a category within a store for organizing products

Show child attributes

data.id

string<uuid>

required

The unique identifier of the entity

data.dateCreated

string<date-time>

required

The date the entity was created

data.name

string

required

The name of the category

data.visibility

enum<integer>

required

List of product visibility (or privacy) levels

Available options:

0,

1,

2

data.order

integer<int32>

required

The ordering index of the category

data.storeId

string<uuid>

required

The unique identifier of the store associated with the category

data.products

object[]

required

The collection of product references in this category

Show child attributes

data.products.id

string<uuid>

required

The unique identifier of the entity

data.products.dateCreated

string<date-time>

required

The date the entity was created

data.products.name

string

required

The display name of the product reference.

data.products.description

string

required

A textual description of the product

data.products.imageNames

string[]

required

The names of the images associated with the product

data.products.rating

number<double>

required

The average rating of the product.

data.products.order

integer<int32>

required

The order in which a product is displayed or sorted

data.products.visibility

enum<integer>

required

List of product visibility (or privacy) levels

Available options:

0,

1,

2

data.products.storeId

string<uuid>

required

The unique identifier of the store associated with the product.

data.products.variants

object[]

required

The collection of product variants associated with the product.

Show child attributes

data.products.variants.id

string<uuid>

required

The unique identifier of the entity

data.products.variants.dateCreated

string<date-time>

required

The date the entity was created

data.products.variants.name

string

required

The name of the variant

Required string length: 3 - 128

data.products.variants.productId

string<uuid>

required

The ID of the product the variant belongs to

data.products.variants.storeId

string<uuid>

required

The ID of the store the variant belongs to

data.products.variants.cost

number<double>

required

The amount of money the product costs

data.products.variants.minimumQuantity

integer<int32>

required

The minimum amount of items allowed to be purchased for the product

data.products.variants.maximumQuantity

integer<int32>

required

The maximum amount of items allowed to be purchased for the product, -1 equals infinity

data.products.variants.order

integer<int32>

required

The ordering number of the product variant, used by the frontends. Defaults to 1

data.products.variants.requireDiscordAuthorization

boolean

required

Whether the product requires the user to authorize to Discord to purchase it

data.products.variants.type

enum<integer>

required

The type of product that is being sold

Available options:

0,

1

data.products.variants.deliveryTypes

string[]

required

The list of enabled delivery types for the variants Can be: license_keys, dynamic, instructions, files

data.products.variants.imageNames

string[]

required

The list of image names that will be displayed for the product, if not set inherits from the product it belongs to

data.products.variants.stock

integer<int32>

required

The amount of stock the product has. This number is influenced by the Komerza.Common.Models.Products.PublicVariant.StockMode

data.products.variants.stockMode

enum<integer>

required

The stock calculation modes that are used

Available options:

0,

1,

2

data.products.variants.customFields

object[]

required

The list of custom fields that will be displayed for this variant

Show child attributes

data.products.variants.customFields.id

string<uuid>

required

The unique ID of this custom field.

data.products.variants.customFields.variantId

string<uuid>

required

The ID of the variant to which this field belongs.

data.products.variants.customFields.label

string

required

The display label for this custom field.

data.products.variants.customFields.identifier

string

required

A machine‐friendly identifier.

data.products.variants.customFields.type

string

required

The type of the field (text, textarea, select, etc.).

data.products.variants.customFields.isRequired

boolean

required

Whether filling out this field is mandatory.

data.products.variants.customFields.options

object[]

required

The list of allowed options (for select or radio types).

Show child attributes

data.products.variants.customFields.options.id

string<uuid>

required

The unique ID of this option.

data.products.variants.customFields.options.customFieldId

string<uuid>

required

The ID of the custom field to which this option belongs.

data.products.variants.customFields.options.label

string

required

The user-facing label for this option.

data.products.variants.customFields.options.value

string

required

The stored value for this option.

data.products.variants.customFields.options.order

integer<int32>

required

Sort order among sibling options.

data.products.variants.customFields.placeholder

string | null

Placeholder text shown when the field is empty.

data.products.variants.customFields.hint

string | null

Help text displayed under the field.

data.products.variants.subscriptionPeriod

string<date-span> | null

The timespan of the subscription

data.products.variants.subscriptionId

string | null

The ID of the Stripe subscription used if the product is a subscription product AND they have Stripe enabled

Maximum string length: 256

data.products.isBestSeller

boolean

required

Indicates whether the product is marked as a bestseller.

data.products.slug

string | null

The URL-friendly identifier for the product

data.products.metadata

string | null

Custom metadata set by either the user or the system to store additional information about the product

data.slug

string | null

The URL-friendly identifier for the category

Get All Categories

Update Category

⌘I

API Documentation

Reference

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

Authorizations

Path Parameters

Body

Response