CatalogCategoryCreateQueryResourceObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogCategoryCreateQueryResourceObject",
  "title": "CatalogCategoryCreateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/CatalogCategoryEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "external_id": {
          "description": "The ID of the catalog category in an external system.",
          "type": "string",
          "example": "SAMPLE-DATA-CATEGORY-APPAREL"
        },
        "name": {
          "description": "The name of the catalog category.",
          "type": "string",
          "example": "Sample Data Category Apparel"
        },
        "integration_type": {
          "description": "The integration type. Currently only \"$custom\" is supported.",
          "type": "string",
          "example": "$custom",
          "default": "$custom",
          "enum": [
            "$custom"
          ],
          "nullable": true
        },
        "catalog_type": {
          "description": "The type of catalog. Currently only \"$default\" is supported.",
          "type": "string",
          "example": "$default",
          "default": "$default",
          "nullable": true
        }
      },
      "required": [
        "external_id",
        "name"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "items": {
          "type": "object",
          "properties": {
            "data": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "type",
                  "id"
                ],
                "properties": {
                  "type": {
                    "$ref": "#/components/schemas/CatalogItemEnum"
                  },
                  "id": {
                    "description": "A list of catalog item IDs that are in the given category.",
                    "type": "string",
                    "example": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "type",
    "attributes"
  ]
}