Create Category

Creates a new category with optional parent, translations, and sort order

POST/api/v1/{team_slug}/{app_slug}/categories
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/categories

Creates a new category with optional parent, translations, and sort order

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/categories
  • Summary: Create Category
  • Description: Creates a new category with optional parent, translations, and sort order
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: Category data
  • Content: application/json (object)

Input Category

PropertyTypeRequiredDetails
childlessbooleanNo-
cover_idstringNo-
google_product_category_idstringNorelated google product category in https://www.google.com/basepages/producttype/taxonomy-with-ids.en-US.txt
namestringYes-
parent_idstringNo-
slugstringYes-
sort_orderintegerNomin: 0
statusenum("active", "draft", "inactive")No-
translationsobjectNo-

Category Translations

PropertyTypeRequiredDetails
nameobject[]No-
slugobject[]No-

Translation

PropertyTypeRequiredDetails
idstringNo-
localestringNo-
valuestringNo-

Generated example (synthetic):

{
  "childless": false,
  "cover_id": "string",
  "google_product_category_id": "string",
  "name": "string",
  "parent_id": "string",
  "slug": "string",
  "sort_order": 0,
  "status": "active",
  "translations": {
    "name": [
      {
        "id": "string",
        "locale": "string",
        "value": "string"
      }
    ],
    "slug": [
      {
        "id": "string",
        "locale": "string",
        "value": "string"
      }
    ]
  }
}
Responses4 statuses
StatusDescriptionContent
200The categoryapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Category Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Category
PropertyTypeRequiredDetails
attributesobject[]No-
childrenobject[]No-
cover_urlstringNo-
created_atstringNo-
google_product_category_idstringNo-
idstringNo-
namestringNo-
parent_idstringNo-
redirectsobject[]No-
slugstringNo-
sort_orderintegerNoUsed for ordering categories themselves
statusstringNo-
translationsobjectNo-
updated_atstringNo-
uristringNo-
Attribute
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
template_keystringNo-
template_namestringNo-
translatablebooleanNo-
translationsobjectNo-
updated_atstringNo-
valuesobjectNo-
Redirects
PropertyTypeRequiredDetails
idstringNo-
item_idstringNo-
localestringNo-
new_slugstringNo-
old_slugstringNo-
typeenum("product", "page", "collection", "category", "product_bundle")No-
Category Translations
PropertyTypeRequiredDetails
nameobject[]No-
slugobject[]No-
{
  "data": {
    "attributes": [
      {
        "created_at": "string",
        "description": "string",
        "filterable": false,
        "id": "string",
        "key": "string",
        "name": "string",
        "template_key": "string",
        "template_name": "string",
        "translatable": false,
        "translations": {
          "description": null,
          "name": null
        },
        "updated_at": "string",
        "values": {}
      }
    ],
    "children": [
      {
        "attributes": [],
        "children": [],
        "cover_url": "string",
        "created_at": "string",
        "google_product_category_id": "string",
        "id": "string",
        "name": "string",
        "parent_id": "string",
        "redirects": [],
        "slug": "string",
        "sort_order": 0,
        "status": "string",
        "translations": {
          "name": null,
          "slug": null
        },
        "updated_at": "string",
        "uri": "string"
      }
    ],
    "cover_url": "string",
    "created_at": "string",
    "google_product_category_id": "string",
    "id": "string",
    "name": "string",
    "parent_id": "string",
    "redirects": [
      {
        "id": "string",
        "item_id": "string",
        "locale": "string",
        "new_slug": "string",
        "old_slug": "string",
        "type": "product"
      }
    ],
    "slug": "string",
    "sort_order": 0,
    "status": "string",
    "translations": {
      "name": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ],
      "slug": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ]
    },
    "updated_at": "string",
    "uri": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/categories
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Categories
  • OpenAPI summary: Create Category

Create Category

# Create Category Creates a new category with optional parent, translations, and sort order
POST /api/v1/{team_slug}/{app_slug}/categories
Purpose

Creates a new category with optional parent, translations, and sort order

Required inputs

app_slug path team_slug path

Primary response

200 ยท The category

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/categories

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/categories` - Summary: Create Category - Description: Creates a new category with optional parent, translations, and sort order - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/categories` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: Category data - Content: application/json (object) ### Input Category | Property | Type | Required | Details | | --- | --- | --- | --- | | `childless` | boolean | No | - | | `cover_id` | string | No | - | | `google_product_category_id` | string | No | related google product category in https://www.google.com/basepages/producttype/taxonomy-with-ids.en-US.txt | | `name` | string | Yes | - | | `parent_id` | string | No | - | | `slug` | string | Yes | - | | `sort_order` | integer | No | min: 0 | | `status` | enum("active", "draft", "inactive") | No | - | | `translations` | object | No | - | #### Category Translations | Property | Type | Required | Details | | --- | --- | --- | --- | | `name` | object[] | No | - | | `slug` | object[] | No | - | #### Translation | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `locale` | string | No | - | | `value` | string | No | - | **Generated example (synthetic):** ```json { "childless": false, "cover_id": "string", "google_product_category_id": "string", "name": "string", "parent_id": "string", "slug": "string", "sort_order": 0, "status": "active", "translations": { "name": [ { "id": "string", "locale": "string", "value": "string" } ], "slug": [ { "id": "string", "locale": "string", "value": "string" } ] } } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | The category | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Category Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Category | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `children` | object[] | No | - | | `cover_url` | string | No | - | | `created_at` | string | No | - | | `google_product_category_id` | string | No | - | | `id` | string | No | - | | `name` | string | No | - | | `parent_id` | string | No | - | | `redirects` | object[] | No | - | | `slug` | string | No | - | | `sort_order` | integer | No | Used for ordering categories themselves | | `status` | string | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `uri` | string | No | - | ##### Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `translatable` | boolean | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `values` | object | No | - | ##### Redirects | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `item_id` | string | No | - | | `locale` | string | No | - | | `new_slug` | string | No | - | | `old_slug` | string | No | - | | `type` | enum("product", "page", "collection", "category", "product_bundle") | No | - | ##### Category Translations | Property | Type | Required | Details | | --- | --- | --- | --- | | `name` | object[] | No | - | | `slug` | object[] | No | - |
Generated example (synthetic) ```json { "data": { "attributes": [ { "created_at": "string", "description": "string", "filterable": false, "id": "string", "key": "string", "name": "string", "template_key": "string", "template_name": "string", "translatable": false, "translations": { "description": null, "name": null }, "updated_at": "string", "values": {} } ], "children": [ { "attributes": [], "children": [], "cover_url": "string", "created_at": "string", "google_product_category_id": "string", "id": "string", "name": "string", "parent_id": "string", "redirects": [], "slug": "string", "sort_order": 0, "status": "string", "translations": { "name": null, "slug": null }, "updated_at": "string", "uri": "string" } ], "cover_url": "string", "created_at": "string", "google_product_category_id": "string", "id": "string", "name": "string", "parent_id": "string", "redirects": [ { "id": "string", "item_id": "string", "locale": "string", "new_slug": "string", "old_slug": "string", "type": "product" } ], "slug": "string", "sort_order": 0, "status": "string", "translations": { "name": [ { "id": null, "locale": null, "value": null } ], "slug": [ { "id": null, "locale": null, "value": null } ] }, "updated_at": "string", "uri": "string" }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/categories` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/categories` - OpenAPI tag: Categories - OpenAPI summary: Create Category