Create Category

POST

api

{team_slug}

{app_slug}

categories

Error

A valid request URL is required to generate request examples

{
  "data": {
    "attributes": [
      {
        "created_at": "<string>",
        "description": "<string>",
        "filterable": true,
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "template_key": "<string>",
        "template_name": "<string>",
        "translatable": true,
        "translations": {
          "description": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "children": "<array>",
    "cover_url": "<string>",
    "created_at": "<string>",
    "description": "<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"
      }
    ],
    "seo": {
      "meta_description": "<string>",
      "meta_title": "<string>"
    },
    "slug": "<string>",
    "sort_order": 123,
    "status": "<string>",
    "translations": {
      "description": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "meta_description": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "meta_title": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "name": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "slug": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ]
    },
    "updated_at": "<string>",
    "uri": "<string>"
  },
  "success": true,
  "details": [
    "<string>"
  ]
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Management API token, sent as Authorization: Bearer <token>.

Path Parameters

app_slug

string

required

App slug

team_slug

string

required

Team slug

Body

application/json

Category data

name

string

required

slug

string

required

childless

boolean

cover_id

string

description

string

google_product_category_id

string

related google product category in https://www.google.com/basepages/producttype/taxonomy-with-ids.en-US.txt

parent_id

string

seo

object

Show child attributes

sort_order

integer

Required range: x >= 0

status

enum<string>

Available options:

active,

draft,

inactive

translations

object

Show child attributes

Response

The category

data

object

required

Show child attributes

success

boolean

required

details

string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

Error

A valid request URL is required to generate request examples

{
  "data": {
    "attributes": [
      {
        "created_at": "<string>",
        "description": "<string>",
        "filterable": true,
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "template_key": "<string>",
        "template_name": "<string>",
        "translatable": true,
        "translations": {
          "description": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "children": "<array>",
    "cover_url": "<string>",
    "created_at": "<string>",
    "description": "<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"
      }
    ],
    "seo": {
      "meta_description": "<string>",
      "meta_title": "<string>"
    },
    "slug": "<string>",
    "sort_order": 123,
    "status": "<string>",
    "translations": {
      "description": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "meta_description": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "meta_title": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "name": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ],
      "slug": [
        {
          "id": "<string>",
          "locale": "<string>",
          "value": "<string>"
        }
      ]
    },
    "updated_at": "<string>",
    "uri": "<string>"
  },
  "success": true,
  "details": [
    "<string>"
  ]
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

{
  "success": true,
  "details": [
    "<string>"
  ],
  "message": "<string>"
}

Management API

Shopper API

Customers API

Digital Assets Management API

Authorizations

Path Parameters

Body

Response