v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Create Category

post/sites/multiscreen/{site_name}/ecommerce/categories

Path parameters

site_namestring required

The unique identifier for the target site. A max of 150 categories are allowed per catalog.

Request body

descriptionstring

The description of the category. Accepts HTML.

parent_idstring

The ID of a parent category. Send 'ROOT' to filter root categories. A max of 10 levels of subcategories is allowed per catalog.

titlestring

The name of the category.

Response

200

descriptionstring

idstring

parent_idstring

{"stackTrail":"paths:/sites/multiscreen/{site_name}/ecommerce/categories:post:responses:200:content:application/json:schema:properties:seo","oasType":"schema","type":"unknown"}

titlestring

Example response

{
  "description": "<p>This is your product category description. Use it to get store visitors excited about this category.</p>",
  "id": "R9mErxXW",
  "image": {
    "alt": "123",
    "url": "https://irp.cdn-website.com/md/dmtmpl/3aab5dd2-0715-4745-b747-f971788f6128/dms3rep/multi/dining-room-table-chairs-zoom.jpg"
  },
  "parent_id": "ROOT",
  "products": [
    {
      "id": "sQ0KvBRq",
      "name": "Plain Design Cutlery"
    }
  ],
  "title": "Dining room Example Create"
}