Skip to main content

Create a category

Create a single product category in Propeller with localized names and a parent category reference.

Endpoint​

POST /v2/categories/

Request​

{
  "names": [
    { "language": "EN", "value": "Power Tools" },
    { "language": "NL", "value": "Elektrisch gereedschap" }
  ],
  "descriptions": [
    { "language": "EN", "value": "Professional and consumer power tools" },
    { "language": "NL", "value": "Professioneel en consument elektrisch gereedschap" }
  ],
  "shortDescriptions": [
    { "language": "EN", "value": "Power tools" },
    { "language": "NL", "value": "Elektrisch gereedschap" }
  ],
  "source": "pim-akeneo",
  "sourceId": "CAT-TOOLS-001",
  "parent": {
    "id": 1736
  }
}

Response​

{
  "data": {
    "id": 38614,
    "names": [
      { "language": "EN", "value": "Power Tools" },
      { "language": "NL", "value": "Elektrisch gereedschap" }
    ],
    "descriptions": [
      { "language": "EN", "value": "Professional and consumer power tools" },
      { "language": "NL", "value": "Professioneel en consument elektrisch gereedschap" }
    ],
    "shortDescriptions": [
      { "language": "EN", "value": "Power tools" },
      { "language": "NL", "value": "Elektrisch gereedschap" }
    ],
    "language": "EN",
    "source": "pim-akeneo",
    "sourceId": "CAT-TOOLS-001",
    "parent": {
      "id": 1736
    },
    "parentUuid": "019e9214-38f8-79a0-abb9-7b9b8d416309"
  },
  "messages": ["Category created successfully"],
  "total": 1
}

How it works​

The parent reference is optional. Include it to nest the category under another category, using parent.id to reference the parent by Propeller ID or parent.sourceId (with a source field on the parent object) to reference it by external identifier. Omit parent to create the category as a root category. The source and sourceId fields on the category itself let you tag it with your external system's identifier for future updates. Localized fields like names, descriptions and shortDescriptions accept an array of language objects. For bulk imports with tree structures, use POST /v2/categories/bulk/sourceId instead.

See also​