Interface CreateProductDto<CustomFields, VariantCustomFields>

Payload for creating a product

See

ProductResponse for details on fields

interface CreateProductDto {
    additionalInformation?: string;
    addressLine1?: string;
    addressLine2?: string;
    addressLine3?: string;
    attributes?: {
        attributeId: string;
        value: string | number | boolean | string[] | Date;
    }[];
    categoryId: string;
    customFields?: CustomFields;
    description?: string;
    dimensions?: string;
    features?: {
        name: string;
        value: string;
    }[];
    geoCoordinatesField?: {
        coordinates: [number, number];
        type: string;
    };
    imageIds?: string[];
    isPromoted?: boolean;
    locationIds?: string[];
    name: string;
    postalCode?: string;
    publication?: Partial<ProductPublication>;
    tags?: string[];
    variantNote?: string;
    variants?: {
        customFields?: VariantCustomFields;
        description?: string;
        imageIds?: string[];
        price?: {
            amount?: number;
            currency?: string;
            taxIncluded?: boolean;
            taxable?: boolean;
        };
        sku?: string;
        title?: string;
    }[];
}

Type Parameters

  • CustomFields = unknown

  • VariantCustomFields = unknown

Properties

additionalInformation? addressLine1? addressLine2? addressLine3? attributes? categoryId customFields? description? dimensions? features? geoCoordinatesField? imageIds? isPromoted? locationIds? name postalCode? publication? tags? variantNote? variants?

Properties

Optional additionalInformation

additionalInformation?: string

Optional addressLine1

addressLine1?: string

Optional addressLine2

addressLine2?: string

Optional addressLine3

addressLine3?: string

Optional attributes

attributes?: {
    attributeId: string;
    value: string | number | boolean | string[] | Date;
}[]

Type declaration

  • attributeId: string
  • value: string | number | boolean | string[] | Date

categoryId

categoryId: string

Optional customFields

customFields?: CustomFields

Optional description

description?: string

Optional dimensions

dimensions?: string

Optional features

features?: {
    name: string;
    value: string;
}[]

Type declaration

  • name: string
  • value: string

Optional geoCoordinatesField

geoCoordinatesField?: {
    coordinates: [number, number];
    type: string;
}

Type declaration

  • coordinates: [number, number]
  • type: string

Optional imageIds

imageIds?: string[]

Optional isPromoted

isPromoted?: boolean

Optional locationIds

locationIds?: string[]

name

name: string

Optional postalCode

postalCode?: string

Optional publication

publication?: Partial<ProductPublication>

Optional tags

tags?: string[]

Optional variantNote

variantNote?: string

Optional variants

variants?: {
    customFields?: VariantCustomFields;
    description?: string;
    imageIds?: string[];
    price?: {
        amount?: number;
        currency?: string;
        taxIncluded?: boolean;
        taxable?: boolean;
    };
    sku?: string;
    title?: string;
}[]

Type declaration

  • Optional customFields?: VariantCustomFields
  • Optional description?: string
  • Optional imageIds?: string[]
  • Optional price?: {
        amount?: number;
        currency?: string;
        taxIncluded?: boolean;
        taxable?: boolean;
    }
    • Optional amount?: number
    • Optional currency?: string
    • Optional taxIncluded?: boolean
    • Optional taxable?: boolean
  • Optional sku?: string
  • Optional title?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc