For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create Product Category

Create a product category.

Use this to create a reusable product category in your account. Inspect the returned record before continuing the synchronization.

Behaviour

Only the localized name and unique code are required; you may also set a parent (must be one of your categories) and pass the general fields (status) and connected products to build the whole category in one call.

Extras are applied by a follow-up update after the category exists; if that step fails the category is still created and the response shows it without them.

New categories default to INACTIVE.

Returns 409 if the code is taken.

Requires the productCategories:write scope.

post
Authorizations
AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Body

Data schema used by Create Product Category (POST /v1/product-categories). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.

codestring · min: 1 · max: 255Required

Unique category code within the account.

Example: CHAIRS
parentProductCategoryIdstring · nullableOptional

Product category identifier (PC-).

Example: PC-123e4567-e89b-12d3-a456-426614174000Pattern: ^PC-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
statusstring · enumOptionalPossible values:
productIdsstring[]Optional

Product identifier (PROD-).

Example: PROD-123e4567-e89b-12d3-a456-426614174000
Responses
201

Created.

application/json
post/v1/product-categories
POST /v1/product-categories HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "name": {
    "en": "Seating",
    "de": "Sitzmöbel"
  },
  "code": "CHAIRS",
  "parentProductCategoryId": "PC-123e4567-e89b-12d3-a456-426614174000",
  "status": "ACTIVE",
  "productIds": [
    "PROD-123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "data": {
    "productCategoryId": "PC-123e4567-e89b-12d3-a456-426614174000",
    "name": "Chair",
    "code": "text",
    "status": "ACTIVE",
    "parentProductCategoryId": "text",
    "numberOfProducts": 1,
    "products": [
      "text"
    ]
  }
}

Last updated

Was this helpful?