@gradientedge/commercetools-utils
    Preparing search index...

    Interface Variant

    A Variant represents a single Variant with both current (published) and staged (draft) data. Variants are writable resources that support create, update, and delete operations.

    interface Variant {
        createdAt: string;
        createdBy?: CreatedBy;
        current: VariantData;
        id: string;
        key?: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        product: ProductReference;
        published: boolean;
        staged?: VariantData;
        variantId: number;
        version: number;
        warnings?: WarningObject[];
    }

    Hierarchy (View Summary)

    Index
    createdAt createdBy? current id key? lastModifiedAt lastModifiedBy? product published staged? variantId version warnings?
    createdAt: string

    Date and time (UTC) the Variant was initially created.

    createdBy?: CreatedBy

    IDs and references that created the Variant.

    current: VariantData

    The current data of the Variant.

    id: string

    Unique identifier of the Variant.

    key?: string

    User-defined unique identifier of the Variant. This is different from Product key.

    lastModifiedAt: string

    Date and time (UTC) the Variant was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the Variant.

    product: ProductReference

    Reference to the parent Product the Variant belongs to.

    published: boolean

    Whether the Variant is published, false if it is unpublished.

    staged?: VariantData

    The staged data of the Variant. Only present if there are staged changes that differ from the current data.

    variantId: number

    A unique, sequential identifier of the Variant within the parent Product.

    version: number

    Current version of the Variant.

    warnings?: WarningObject[]

    Warnings about processing of a request. Appears in response to requests with response status code 202 Accepted.

    Settings
    Member Visibility

    On This Page
    Properties