Skip to main content
POST
Create category

📌 Endpoint

POST /stores/{storeId}/categories Creates a new category for the informed store.

🔐 Authentication

  • Private route.
  • Send Authorization with your API Key.

🧾 Route parameters


🧾 Body


✅ Request example


📦 Success response (201)


⚠️ Possible errors

  • 400 INVALID_DATA → invalid payload or storeId
  • 400 INVALID_DATA_NAME_MIN → name missing or shorter than 4 characters
  • 400 INVALID_DATA_NAME_MAX → name longer than 32 characters
  • 400 INVALID_DATA_DESCRIPTION_MIN → description shorter than 12 characters
  • 400 INVALID_DATA_DESCRIPTION_MAX → description longer than 256 characters
  • 400 INVALID_DATA_IMAGE → image outside 12 to 512 characters
  • 400 NAME_ALREADY_EXISTS → category with the same name
  • 401 API_KEY_NOT_PROVIDED → Authorization header not sent (or TOKEN_NOT_PROVIDED via Bearer)
  • 401 INVALID_API_KEY → invalid API Key (or INVALID_TOKEN / TOKEN_EXPIRED / SESSION_NOT_FOUND / SESSION_EXPIRED / UNAUTHENTICATED via Bearer)
  • 403 USER_DISABLED → user disabled or deleted
  • 403 NO_ACTIVE_SUBSCRIPTION → inactive or expired plan (or PENDING_2FA via Bearer)
  • 403 CATEGORY_LIMIT_REACHED → plan category limit reached
  • 404 STORE_NOT_FOUND → store not found
  • 429 RATE_LIMIT_EXCEEDED → rate limit per minute exceeded
  • 500 INTERNAL_SERVER_ERROR → internal server error
  • 503 SERVICE_UNAVAILABLE → service or database unavailable

Authorizations

Authorization
string
header
default:YOUR_API_KEY_HERE
required

Path Parameters

storeId
string
required
Required string length: 1 - 50

Body

application/json

Category details (name, description, image, metadata).

name
string
required
Required string length: 4 - 32
description
string | null
Required string length: 12 - 256
image
string | null
Required string length: 12 - 512
metadata
object | null

Response

Create category.

code
string
required
Example:

"CATEGORY_CREATED"

category
object
required

Store product category.