Create Terms

Create terms for a product.

post

Path parameters

productIdstringRequired

Body

application/jsontext/jsonapplication/*+json

namestringOptional

descriptionstring | nullableOptional

displayOrderinteger · int32 | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

post

HTTPcURLJavaScriptPython

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
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-02T00:29:34.862Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-06-02T00:29:34.862Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "published": {
      "at": "2025-06-02T00:29:34.862Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "pending": {
      "at": "2025-06-02T00:29:34.862Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "unpublished": {
      "at": "2025-06-02T00:29:34.862Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "displayOrder": 1,
  "status": "text",
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text"
    },
    "icon": "text",
    "status": "text"
  }
}