Create Terms

Create terms for a product.

post
Path parameters
productIdstringRequired
Body
namestringOptional
descriptionstring | nullableOptional
displayOrderinteger · int32 | nullableOptional
Responses
201
Created
application/json
post
POST /public/v1/catalog/products/{productId}/terms HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "text",
  "description": "text",
  "displayOrder": 1
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-22T13:39:07.007Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-06-22T13:39:07.007Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "published": {
      "at": "2025-06-22T13:39:07.007Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "pending": {
      "at": "2025-06-22T13:39:07.007Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "unpublished": {
      "at": "2025-06-22T13:39:07.007Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "displayOrder": 1,
  "status": "text",
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "icon": "text",
    "status": "text"
  }
}

Last updated

Was this helpful?