Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. Category
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.Category

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    Categories allow you to organize products into hierarchical structures.

    Also see the Categories HTTP API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as commercetools from "@pulumi/commercetools";

const my_category = new commercetools.Category("my-category", {
    key: "my-category-key",
    name: {
        en: "My category",
    },
    description: {
        en: "Standard description",
    },
    slug: {
        en: "my_category",
    },
    metaTitle: {
        en: "Meta title",
    },
});
const my_second_category = new commercetools.Category("my-second-category", {
    key: "my-category-key",
    name: {
        en: "Second category",
    },
    description: {
        en: "Standard description",
    },
    parent: my_category.categoryId,
    slug: {
        en: "my_second_category",
    },
    metaTitle: {
        en: "Meta title",
    },
    assets: [{
        key: "some_key",
        name: {
            en: "Image name",
        },
        description: {
            en: "Image description",
        },
        sources: [{
            uri: "https://example.com/test.jpg",
            key: "image",
        }],
    }],
});

    import pulumi
import pulumi_commercetools as commercetools

my_category = commercetools.Category("my-category",
    key="my-category-key",
    name={
        "en": "My category",
    },
    description={
        "en": "Standard description",
    },
    slug={
        "en": "my_category",
    },
    meta_title={
        "en": "Meta title",
    })
my_second_category = commercetools.Category("my-second-category",
    key="my-category-key",
    name={
        "en": "Second category",
    },
    description={
        "en": "Standard description",
    },
    parent=my_category.category_id,
    slug={
        "en": "my_second_category",
    },
    meta_title={
        "en": "Meta title",
    },
    assets=[{
        "key": "some_key",
        "name": {
            "en": "Image name",
        },
        "description": {
            "en": "Image description",
        },
        "sources": [{
            "uri": "https://example.com/test.jpg",
            "key": "image",
        }],
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/commercetools/commercetools"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := commercetools.NewCategory(ctx, "my-category", &commercetools.CategoryArgs{
			Key: pulumi.String("my-category-key"),
			Name: pulumi.StringMap{
				"en": pulumi.String("My category"),
			},
			Description: pulumi.StringMap{
				"en": pulumi.String("Standard description"),
			},
			Slug: pulumi.StringMap{
				"en": pulumi.String("my_category"),
			},
			MetaTitle: pulumi.StringMap{
				"en": pulumi.String("Meta title"),
			},
		})
		if err != nil {
			return err
		}
		_, err = commercetools.NewCategory(ctx, "my-second-category", &commercetools.CategoryArgs{
			Key: pulumi.String("my-category-key"),
			Name: pulumi.StringMap{
				"en": pulumi.String("Second category"),
			},
			Description: pulumi.StringMap{
				"en": pulumi.String("Standard description"),
			},
			Parent: my_category.CategoryId,
			Slug: pulumi.StringMap{
				"en": pulumi.String("my_second_category"),
			},
			MetaTitle: pulumi.StringMap{
				"en": pulumi.String("Meta title"),
			},
			Assets: commercetools.CategoryAssetArray{
				&commercetools.CategoryAssetArgs{
					Key: pulumi.String("some_key"),
					Name: pulumi.StringMap{
						"en": pulumi.String("Image name"),
					},
					Description: pulumi.StringMap{
						"en": pulumi.String("Image description"),
					},
					Sources: commercetools.CategoryAssetSourceArray{
						&commercetools.CategoryAssetSourceArgs{
							Uri: pulumi.String("https://example.com/test.jpg"),
							Key: pulumi.String("image"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Commercetools = Pulumi.Commercetools;

return await Deployment.RunAsync(() => 
{
    var my_category = new Commercetools.Category("my-category", new()
    {
        Key = "my-category-key",
        Name = 
        {
            { "en", "My category" },
        },
        Description = 
        {
            { "en", "Standard description" },
        },
        Slug = 
        {
            { "en", "my_category" },
        },
        MetaTitle = 
        {
            { "en", "Meta title" },
        },
    });

    var my_second_category = new Commercetools.Category("my-second-category", new()
    {
        Key = "my-category-key",
        Name = 
        {
            { "en", "Second category" },
        },
        Description = 
        {
            { "en", "Standard description" },
        },
        Parent = my_category.CategoryId,
        Slug = 
        {
            { "en", "my_second_category" },
        },
        MetaTitle = 
        {
            { "en", "Meta title" },
        },
        Assets = new[]
        {
            new Commercetools.Inputs.CategoryAssetArgs
            {
                Key = "some_key",
                Name = 
                {
                    { "en", "Image name" },
                },
                Description = 
                {
                    { "en", "Image description" },
                },
                Sources = new[]
                {
                    new Commercetools.Inputs.CategoryAssetSourceArgs
                    {
                        Uri = "https://example.com/test.jpg",
                        Key = "image",
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.commercetools.Category;
import com.pulumi.commercetools.CategoryArgs;
import com.pulumi.commercetools.inputs.CategoryAssetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var my_category = new Category("my-category", CategoryArgs.builder()
            .key("my-category-key")
            .name(Map.of("en", "My category"))
            .description(Map.of("en", "Standard description"))
            .slug(Map.of("en", "my_category"))
            .metaTitle(Map.of("en", "Meta title"))
            .build());

        var my_second_category = new Category("my-second-category", CategoryArgs.builder()
            .key("my-category-key")
            .name(Map.of("en", "Second category"))
            .description(Map.of("en", "Standard description"))
            .parent(my_category.categoryId())
            .slug(Map.of("en", "my_second_category"))
            .metaTitle(Map.of("en", "Meta title"))
            .assets(CategoryAssetArgs.builder()
                .key("some_key")
                .name(Map.of("en", "Image name"))
                .description(Map.of("en", "Image description"))
                .sources(CategoryAssetSourceArgs.builder()
                    .uri("https://example.com/test.jpg")
                    .key("image")
                    .build())
                .build())
            .build());

    }
}

    resources:
  my-category:
    type: commercetools:Category
    properties:
      key: my-category-key
      name:
        en: My category
      description:
        en: Standard description
      slug:
        en: my_category
      metaTitle:
        en: Meta title
  my-second-category:
    type: commercetools:Category
    properties:
      key: my-category-key
      name:
        en: Second category
      description:
        en: Standard description
      parent: ${["my-category"].categoryId}
      slug:
        en: my_second_category
      metaTitle:
        en: Meta title
      assets:
        - key: some_key
          name:
            en: Image name
          description:
            en: Image description
          sources:
            - uri: https://example.com/test.jpg
              key: image

    Create Category Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Category(name: string, args: CategoryArgs, opts?: CustomResourceOptions);
    @overload
def Category(resource_name: str,
             args: CategoryArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Category(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             name: Optional[Mapping[str, str]] = None,
             slug: Optional[Mapping[str, str]] = None,
             description: Optional[Mapping[str, str]] = None,
             assets: Optional[Sequence[CategoryAssetArgs]] = None,
             external_id: Optional[str] = None,
             key: Optional[str] = None,
             meta_description: Optional[Mapping[str, str]] = None,
             meta_keywords: Optional[Mapping[str, str]] = None,
             meta_title: Optional[Mapping[str, str]] = None,
             custom: Optional[CategoryCustomArgs] = None,
             order_hint: Optional[str] = None,
             parent: Optional[str] = None,
             category_id: Optional[str] = None)
    func NewCategory(ctx *Context, name string, args CategoryArgs, opts ...ResourceOption) (*Category, error)
    public Category(string name, CategoryArgs args, CustomResourceOptions? opts = null)
    public Category(String name, CategoryArgs args)
public Category(String name, CategoryArgs args, CustomResourceOptions options)

    type: commercetools:Category
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CategoryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CategoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CategoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CategoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var categoryResource = new Commercetools.Category("categoryResource", new()
{
    Name = 
    {
        { "string", "string" },
    },
    Slug = 
    {
        { "string", "string" },
    },
    Description = 
    {
        { "string", "string" },
    },
    Assets = new[]
    {
        new Commercetools.Inputs.CategoryAssetArgs
        {
            Name = 
            {
                { "string", "string" },
            },
            Description = 
            {
                { "string", "string" },
            },
            Id = "string",
            Key = "string",
            Sources = new[]
            {
                new Commercetools.Inputs.CategoryAssetSourceArgs
                {
                    Uri = "string",
                    ContentType = "string",
                    Dimensions = new Commercetools.Inputs.CategoryAssetSourceDimensionsArgs
                    {
                        H = 0,
                        W = 0,
                    },
                    Key = "string",
                },
            },
            Tags = new[]
            {
                "string",
            },
        },
    },
    ExternalId = "string",
    Key = "string",
    MetaDescription = 
    {
        { "string", "string" },
    },
    MetaKeywords = 
    {
        { "string", "string" },
    },
    MetaTitle = 
    {
        { "string", "string" },
    },
    Custom = new Commercetools.Inputs.CategoryCustomArgs
    {
        TypeId = "string",
        Fields = 
        {
            { "string", "string" },
        },
    },
    OrderHint = "string",
    Parent = "string",
    CategoryId = "string",
});

    example, err := commercetools.NewCategory(ctx, "categoryResource", &commercetools.CategoryArgs{
Name: pulumi.StringMap{
"string": pulumi.String("string"),
},
Slug: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.StringMap{
"string": pulumi.String("string"),
},
Assets: .CategoryAssetArray{
&.CategoryAssetArgs{
Name: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.StringMap{
"string": pulumi.String("string"),
},
Id: pulumi.String("string"),
Key: pulumi.String("string"),
Sources: .CategoryAssetSourceArray{
&.CategoryAssetSourceArgs{
Uri: pulumi.String("string"),
ContentType: pulumi.String("string"),
Dimensions: &.CategoryAssetSourceDimensionsArgs{
H: pulumi.Float64(0),
W: pulumi.Float64(0),
},
Key: pulumi.String("string"),
},
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
},
},
ExternalId: pulumi.String("string"),
Key: pulumi.String("string"),
MetaDescription: pulumi.StringMap{
"string": pulumi.String("string"),
},
MetaKeywords: pulumi.StringMap{
"string": pulumi.String("string"),
},
MetaTitle: pulumi.StringMap{
"string": pulumi.String("string"),
},
Custom: &.CategoryCustomArgs{
TypeId: pulumi.String("string"),
Fields: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
OrderHint: pulumi.String("string"),
Parent: pulumi.String("string"),
CategoryId: pulumi.String("string"),
})

    var categoryResource = new Category("categoryResource", CategoryArgs.builder()
    .name(Map.of("string", "string"))
    .slug(Map.of("string", "string"))
    .description(Map.of("string", "string"))
    .assets(CategoryAssetArgs.builder()
        .name(Map.of("string", "string"))
        .description(Map.of("string", "string"))
        .id("string")
        .key("string")
        .sources(CategoryAssetSourceArgs.builder()
            .uri("string")
            .contentType("string")
            .dimensions(CategoryAssetSourceDimensionsArgs.builder()
                .h(0)
                .w(0)
                .build())
            .key("string")
            .build())
        .tags("string")
        .build())
    .externalId("string")
    .key("string")
    .metaDescription(Map.of("string", "string"))
    .metaKeywords(Map.of("string", "string"))
    .metaTitle(Map.of("string", "string"))
    .custom(CategoryCustomArgs.builder()
        .typeId("string")
        .fields(Map.of("string", "string"))
        .build())
    .orderHint("string")
    .parent("string")
    .categoryId("string")
    .build());

    category_resource = commercetools.Category("categoryResource",
    name={
        "string": "string",
    },
    slug={
        "string": "string",
    },
    description={
        "string": "string",
    },
    assets=[{
        "name": {
            "string": "string",
        },
        "description": {
            "string": "string",
        },
        "id": "string",
        "key": "string",
        "sources": [{
            "uri": "string",
            "content_type": "string",
            "dimensions": {
                "h": 0,
                "w": 0,
            },
            "key": "string",
        }],
        "tags": ["string"],
    }],
    external_id="string",
    key="string",
    meta_description={
        "string": "string",
    },
    meta_keywords={
        "string": "string",
    },
    meta_title={
        "string": "string",
    },
    custom={
        "type_id": "string",
        "fields": {
            "string": "string",
        },
    },
    order_hint="string",
    parent="string",
    category_id="string")

    const categoryResource = new commercetools.Category("categoryResource", {
    name: {
        string: "string",
    },
    slug: {
        string: "string",
    },
    description: {
        string: "string",
    },
    assets: [{
        name: {
            string: "string",
        },
        description: {
            string: "string",
        },
        id: "string",
        key: "string",
        sources: [{
            uri: "string",
            contentType: "string",
            dimensions: {
                h: 0,
                w: 0,
            },
            key: "string",
        }],
        tags: ["string"],
    }],
    externalId: "string",
    key: "string",
    metaDescription: {
        string: "string",
    },
    metaKeywords: {
        string: "string",
    },
    metaTitle: {
        string: "string",
    },
    custom: {
        typeId: "string",
        fields: {
            string: "string",
        },
    },
    orderHint: "string",
    parent: "string",
    categoryId: "string",
});

    type: commercetools:Category
properties:
    assets:
        - description:
            string: string
          id: string
          key: string
          name:
            string: string
          sources:
            - contentType: string
              dimensions:
                h: 0
                w: 0
              key: string
              uri: string
          tags:
            - string
    categoryId: string
    custom:
        fields:
            string: string
        typeId: string
    description:
        string: string
    externalId: string
    key: string
    metaDescription:
        string: string
    metaKeywords:
        string: string
    metaTitle:
        string: string
    name:
        string: string
    orderHint: string
    parent: string
    slug:
        string: string

    Category Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Category resource accepts the following input properties:

    Name Dictionary<string, string>
    Slug Dictionary<string, string>
    Human readable identifiers, needs to be unique
    Assets List<CategoryAsset>
    Can be used to store images, icons or movies related to this category
    CategoryId string
    The ID of this resource.
    Custom CategoryCustom
    Description Dictionary<string, string>
    ExternalId string
    Key string
    Category-specific unique identifier. Must be unique across a project
    MetaDescription Dictionary<string, string>
    MetaKeywords Dictionary<string, string>
    MetaTitle Dictionary<string, string>
    OrderHint string
    An attribute as base for a custom category order in one level, filled with random value when left empty
    Parent string
    A category that is the parent of this category in the category tree
    Name map[string]string
    Slug map[string]string
    Human readable identifiers, needs to be unique
    Assets []CategoryAssetArgs
    Can be used to store images, icons or movies related to this category
    CategoryId string
    The ID of this resource.
    Custom CategoryCustomArgs
    Description map[string]string
    ExternalId string
    Key string
    Category-specific unique identifier. Must be unique across a project
    MetaDescription map[string]string
    MetaKeywords map[string]string
    MetaTitle map[string]string
    OrderHint string
    An attribute as base for a custom category order in one level, filled with random value when left empty
    Parent string
    A category that is the parent of this category in the category tree
    name Map<String,String>
    slug Map<String,String>
    Human readable identifiers, needs to be unique
    assets List<CategoryAsset>
    Can be used to store images, icons or movies related to this category
    categoryId String
    The ID of this resource.
    custom CategoryCustom
    description Map<String,String>
    externalId String
    key String
    Category-specific unique identifier. Must be unique across a project
    metaDescription Map<String,String>
    metaKeywords Map<String,String>
    metaTitle Map<String,String>
    orderHint String
    An attribute as base for a custom category order in one level, filled with random value when left empty
    parent String
    A category that is the parent of this category in the category tree
    name {[key: string]: string}
    slug {[key: string]: string}
    Human readable identifiers, needs to be unique
    assets CategoryAsset[]
    Can be used to store images, icons or movies related to this category
    categoryId string
    The ID of this resource.
    custom CategoryCustom
    description {[key: string]: string}
    externalId string
    key string
    Category-specific unique identifier. Must be unique across a project
    metaDescription {[key: string]: string}
    metaKeywords {[key: string]: string}
    metaTitle {[key: string]: string}
    orderHint string
    An attribute as base for a custom category order in one level, filled with random value when left empty
    parent string
    A category that is the parent of this category in the category tree
    name Mapping[str, str]
    slug Mapping[str, str]
    Human readable identifiers, needs to be unique
    assets Sequence[CategoryAssetArgs]
    Can be used to store images, icons or movies related to this category
    category_id str
    The ID of this resource.
    custom CategoryCustomArgs
    description Mapping[str, str]
    external_id str
    key str
    Category-specific unique identifier. Must be unique across a project
    meta_description Mapping[str, str]
    meta_keywords Mapping[str, str]
    meta_title Mapping[str, str]
    order_hint str
    An attribute as base for a custom category order in one level, filled with random value when left empty
    parent str
    A category that is the parent of this category in the category tree
    name Map<String>
    slug Map<String>
    Human readable identifiers, needs to be unique
    assets List<Property Map>
    Can be used to store images, icons or movies related to this category
    categoryId String
    The ID of this resource.
    custom Property Map
    description Map<String>
    externalId String
    key String
    Category-specific unique identifier. Must be unique across a project
    metaDescription Map<String>
    metaKeywords Map<String>
    metaTitle Map<String>
    orderHint String
    An attribute as base for a custom category order in one level, filled with random value when left empty
    parent String
    A category that is the parent of this category in the category tree

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Category resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    id String
    The provider-assigned unique ID for this managed resource.
    version Number

    Look up Existing Category Resource

    Get an existing Category resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CategoryState, opts?: CustomResourceOptions): Category
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assets: Optional[Sequence[CategoryAssetArgs]] = None,
        category_id: Optional[str] = None,
        custom: Optional[CategoryCustomArgs] = None,
        description: Optional[Mapping[str, str]] = None,
        external_id: Optional[str] = None,
        key: Optional[str] = None,
        meta_description: Optional[Mapping[str, str]] = None,
        meta_keywords: Optional[Mapping[str, str]] = None,
        meta_title: Optional[Mapping[str, str]] = None,
        name: Optional[Mapping[str, str]] = None,
        order_hint: Optional[str] = None,
        parent: Optional[str] = None,
        slug: Optional[Mapping[str, str]] = None,
        version: Optional[float] = None) -> Category
    func GetCategory(ctx *Context, name string, id IDInput, state *CategoryState, opts ...ResourceOption) (*Category, error)
    public static Category Get(string name, Input<string> id, CategoryState? state, CustomResourceOptions? opts = null)
    public static Category get(String name, Output<String> id, CategoryState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:Category    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Assets List<CategoryAsset>
    Can be used to store images, icons or movies related to this category
    CategoryId string
    The ID of this resource.
    Custom CategoryCustom
    Description Dictionary<string, string>
    ExternalId string
    Key string
    Category-specific unique identifier. Must be unique across a project
    MetaDescription Dictionary<string, string>
    MetaKeywords Dictionary<string, string>
    MetaTitle Dictionary<string, string>
    Name Dictionary<string, string>
    OrderHint string
    An attribute as base for a custom category order in one level, filled with random value when left empty
    Parent string
    A category that is the parent of this category in the category tree
    Slug Dictionary<string, string>
    Human readable identifiers, needs to be unique
    Version double
    Assets []CategoryAssetArgs
    Can be used to store images, icons or movies related to this category
    CategoryId string
    The ID of this resource.
    Custom CategoryCustomArgs
    Description map[string]string
    ExternalId string
    Key string
    Category-specific unique identifier. Must be unique across a project
    MetaDescription map[string]string
    MetaKeywords map[string]string
    MetaTitle map[string]string
    Name map[string]string
    OrderHint string
    An attribute as base for a custom category order in one level, filled with random value when left empty
    Parent string
    A category that is the parent of this category in the category tree
    Slug map[string]string
    Human readable identifiers, needs to be unique
    Version float64
    assets List<CategoryAsset>
    Can be used to store images, icons or movies related to this category
    categoryId String
    The ID of this resource.
    custom CategoryCustom
    description Map<String,String>
    externalId String
    key String
    Category-specific unique identifier. Must be unique across a project
    metaDescription Map<String,String>
    metaKeywords Map<String,String>
    metaTitle Map<String,String>
    name Map<String,String>
    orderHint String
    An attribute as base for a custom category order in one level, filled with random value when left empty
    parent String
    A category that is the parent of this category in the category tree
    slug Map<String,String>
    Human readable identifiers, needs to be unique
    version Double
    assets CategoryAsset[]
    Can be used to store images, icons or movies related to this category
    categoryId string
    The ID of this resource.
    custom CategoryCustom
    description {[key: string]: string}
    externalId string
    key string
    Category-specific unique identifier. Must be unique across a project
    metaDescription {[key: string]: string}
    metaKeywords {[key: string]: string}
    metaTitle {[key: string]: string}
    name {[key: string]: string}
    orderHint string
    An attribute as base for a custom category order in one level, filled with random value when left empty
    parent string
    A category that is the parent of this category in the category tree
    slug {[key: string]: string}
    Human readable identifiers, needs to be unique
    version number
    assets Sequence[CategoryAssetArgs]
    Can be used to store images, icons or movies related to this category
    category_id str
    The ID of this resource.
    custom CategoryCustomArgs
    description Mapping[str, str]
    external_id str
    key str
    Category-specific unique identifier. Must be unique across a project
    meta_description Mapping[str, str]
    meta_keywords Mapping[str, str]
    meta_title Mapping[str, str]
    name Mapping[str, str]
    order_hint str
    An attribute as base for a custom category order in one level, filled with random value when left empty
    parent str
    A category that is the parent of this category in the category tree
    slug Mapping[str, str]
    Human readable identifiers, needs to be unique
    version float
    assets List<Property Map>
    Can be used to store images, icons or movies related to this category
    categoryId String
    The ID of this resource.
    custom Property Map
    description Map<String>
    externalId String
    key String
    Category-specific unique identifier. Must be unique across a project
    metaDescription Map<String>
    metaKeywords Map<String>
    metaTitle Map<String>
    name Map<String>
    orderHint String
    An attribute as base for a custom category order in one level, filled with random value when left empty
    parent String
    A category that is the parent of this category in the category tree
    slug Map<String>
    Human readable identifiers, needs to be unique
    version Number

    Supporting Types

    CategoryAsset, CategoryAssetArgs

    Name Dictionary<string, string>
    Description Dictionary<string, string>
    Id string
    Key string
    Optional User-defined identifier for the asset. Asset keys are unique inside their container (in this case the category)
    Sources List<CategoryAssetSource>
    Array of AssetSource, Has at least one entry
    Tags List<string>
    Name map[string]string
    Description map[string]string
    Id string
    Key string
    Optional User-defined identifier for the asset. Asset keys are unique inside their container (in this case the category)
    Sources []CategoryAssetSource
    Array of AssetSource, Has at least one entry
    Tags []string
    name Map<String,String>
    description Map<String,String>
    id String
    key String
    Optional User-defined identifier for the asset. Asset keys are unique inside their container (in this case the category)
    sources List<CategoryAssetSource>
    Array of AssetSource, Has at least one entry
    tags List<String>
    name {[key: string]: string}
    description {[key: string]: string}
    id string
    key string
    Optional User-defined identifier for the asset. Asset keys are unique inside their container (in this case the category)
    sources CategoryAssetSource[]
    Array of AssetSource, Has at least one entry
    tags string[]
    name Mapping[str, str]
    description Mapping[str, str]
    id str
    key str
    Optional User-defined identifier for the asset. Asset keys are unique inside their container (in this case the category)
    sources Sequence[CategoryAssetSource]
    Array of AssetSource, Has at least one entry
    tags Sequence[str]
    name Map<String>
    description Map<String>
    id String
    key String
    Optional User-defined identifier for the asset. Asset keys are unique inside their container (in this case the category)
    sources List<Property Map>
    Array of AssetSource, Has at least one entry
    tags List<String>

    CategoryAssetSource, CategoryAssetSourceArgs

    Uri string
    ContentType string
    Dimensions CategoryAssetSourceDimensions
    Key string
    Unique identifier, must be unique within the Asset
    Uri string
    ContentType string
    Dimensions CategoryAssetSourceDimensions
    Key string
    Unique identifier, must be unique within the Asset
    uri String
    contentType String
    dimensions CategoryAssetSourceDimensions
    key String
    Unique identifier, must be unique within the Asset
    uri string
    contentType string
    dimensions CategoryAssetSourceDimensions
    key string
    Unique identifier, must be unique within the Asset
    uri str
    content_type str
    dimensions CategoryAssetSourceDimensions
    key str
    Unique identifier, must be unique within the Asset
    uri String
    contentType String
    dimensions Property Map
    key String
    Unique identifier, must be unique within the Asset

    CategoryAssetSourceDimensions, CategoryAssetSourceDimensionsArgs

    H double
    The height of the asset source
    W double
    The width of the asset source
    H float64
    The height of the asset source
    W float64
    The width of the asset source
    h Double
    The height of the asset source
    w Double
    The width of the asset source
    h number
    The height of the asset source
    w number
    The width of the asset source
    h float
    The height of the asset source
    w float
    The width of the asset source
    h Number
    The height of the asset source
    w Number
    The width of the asset source

    CategoryCustom, CategoryCustomArgs

    TypeId string
    Fields Dictionary<string, string>
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    TypeId string
    Fields map[string]string
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId String
    fields Map<String,String>
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId string
    fields {[key: string]: string}
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    type_id str
    fields Mapping[str, str]
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})
    typeId String
    fields Map<String>
    Custom fields for this resource. Note that the values need to be provided as JSON encoded strings: my-value = jsonencode({"key": "value"})

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools