Interface UpdateProductDto<CustomFields>

Payload for updating a product

See

ProductResponse for details on fields

interface UpdateProductDto {
    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;
}

Type Parameters

  • CustomFields = unknown

Properties

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

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

Optional 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[]

Optional name

name?: string

Optional postalCode

postalCode?: string

Optional publication

publication?: Partial<ProductPublication>

Optional tags

tags?: string[]

Optional variantNote

variantNote?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc