Typescript SDK Type Docs
    Preparing search index...

    Interface ReferenceAttribute

    This type represents an attribute whose value is a key reference.

    interface ReferenceAttribute {
        name?: string;
        type: "reference";
        value: KeyReference;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name? type value

    Properties

    name?: string

    Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch.

    Must match `name` of an [AttributeDefinition](ctp:api:type:AttributeDefinition) of the Product Type.
    type: "reference"

    Must match type of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.

    value: KeyReference

    References a resource by key.

    Settings

    Member Visibility

    On This Page

    Properties