CategoryDraft

Request body for creating a new category.

CommerceComposable CommerceE-CommerceGraphQLRESTSDK

Properties

Name	Type	Description
key	string	User-defined unique identifier.
name	object
slug	object
description	object
parent	object
orderHint	string	Decimal string between 0 and 1 for ordering within siblings.
metaTitle	object
metaDescription	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CategoryDraft",
  "title": "CategoryDraft",
  "type": "object",
  "description": "Request body for creating a new category.",
  "required": [
    "name",
    "slug"
  ],
  "properties": {
    "key": {
      "type": "string",
      "description": "User-defined unique identifier."
    },
    "name": {
      "$ref": "#/components/schemas/LocalizedString"
    },
    "slug": {
      "$ref": "#/components/schemas/LocalizedString"
    },
    "description": {
      "$ref": "#/components/schemas/LocalizedString"
    },
    "parent": {
      "$ref": "#/components/schemas/Reference"
    },
    "orderHint": {
      "type": "string",
      "description": "Decimal string between 0 and 1 for ordering within siblings."
    },
    "metaTitle": {
      "$ref": "#/components/schemas/LocalizedString"
    },
    "metaDescription": {
      "$ref": "#/components/schemas/LocalizedString"
    }
  }
}