Interface Asset

interface Asset {
    custom?: CustomFields;
    description?: LocalizedString;
    id: string;
    key?: string;
    name: LocalizedString;
    sources: AssetSource[];
    tags?: string[];
}

Index

Properties

custom? description? id key? name sources tags?

Properties

`Optional` `Readonly`custom

custom?: CustomFields

Custom Fields defined for the Asset.

`Optional` `Readonly`description

description?: LocalizedString

Description of the Asset.

`Readonly`id

id: string

Unique identifier of the Asset. Not required when importing Assets using the Import API.

`Optional` `Readonly`key

key?: string

User-defined identifier of the Asset. It is unique per Category or ProductVariant.

`Readonly`name

name: LocalizedString

Name of the Asset.

`Readonly`sources

sources: AssetSource[]

`Optional` `Readonly`tags

tags?: string[]

Keywords for categorizing and organizing Assets.