Skip to main content

Interface: UpdateProductInput

Defined in: type/UpdateProductInput.ts:8

Input object for UpdateProductInput

Properties​

autoGenerateSlugs?​

optional autoGenerateSlugs?: boolean

Defined in: type/UpdateProductInput.ts:103

Whether to auto-generate slugs from names. When true (default), slugs are always regenerated for languages with names unless explicitly provided. When false, slugs are only generated for languages without existing slugs in the database.

barCode?​

optional barCode?: string

Defined in: type/UpdateProductInput.ts:32

The bar code of this product

categoryId?​

optional categoryId?: number

Defined in: type/UpdateProductInput.ts:10

The id of the category the product should be created in

clusterId?​

optional clusterId?: number

Defined in: type/UpdateProductInput.ts:93

Cluster ID if assigned to a cluster

customKeywords?​

optional customKeywords?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:20

Additional keywords of this product per language. Added via the PIM

depth?​

optional depth?: number

Defined in: type/UpdateProductInput.ts:99

Product depth

descriptions?​

optional descriptions?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:14

The descriptions of this product per language

eanCode?​

optional eanCode?: string

Defined in: type/UpdateProductInput.ts:36

The European Article Number (EAN) code of this product

economicOrderQuantity?​

optional economicOrderQuantity?: number

Defined in: type/UpdateProductInput.ts:78

The quantity that provides the best value for money for this product

height?​

optional height?: number

Defined in: type/UpdateProductInput.ts:97

Product height

hidden?​

optional hidden?: YesNo

Defined in: type/UpdateProductInput.ts:88

Product hidden status

keywords?​

optional keywords?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:18

Additional keywords of this product per language. Added by the supplier

manufacturer?​

optional manufacturer?: string

Defined in: type/UpdateProductInput.ts:38

The manufacturer of this product

manufacturerCode?​

optional manufacturerCode?: string

Defined in: type/UpdateProductInput.ts:34

The Original Equipment Manufacturer code (OEM) of this product

metadataCanonicalUrls?​

optional metadataCanonicalUrls?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:72

[SEO] Metadata canonical urls in different languages.

metadataDescriptions?​

optional metadataDescriptions?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:68

[SEO] Metadata description in different languages.

metadataKeywords?​

optional metadataKeywords?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:70

[SEO] Metadata keywords in different languages.

metadataTitles?​

optional metadataTitles?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:66

[SEO] Metadata title in different languages.

minimumQuantity?​

optional minimumQuantity?: number

Defined in: type/UpdateProductInput.ts:76

The minimum quantity of products that can be ordered

names?​

optional names?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:12

The names of this product per language

notes?​

optional notes?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:62

Notes on the product for internal use

orderable?​

optional orderable?: YesNo

Defined in: type/UpdateProductInput.ts:80

Is this product orderable

orderableFrom?​

optional orderableFrom?: string

Defined in: type/UpdateProductInput.ts:48

The orderable from date of this product

orderableTo?​

optional orderableTo?: string

Defined in: type/UpdateProductInput.ts:50

The orderable to date of this product

package?​

optional package?: string

Defined in: type/UpdateProductInput.ts:40

The package type of this product. i.e.: PIECE, BOX, BLISTER

packageDescriptions?​

optional packageDescriptions?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:60

The package description of this product per language

packageUnit?​

optional packageUnit?: string

Defined in: type/UpdateProductInput.ts:42

Description of what an item within a package looks like, i.e.: PIECE or BOX

packageUnitQuantity?​

optional packageUnitQuantity?: string

Defined in: type/UpdateProductInput.ts:86

Number of items within the package

physical?​

optional physical?: YesNo

Defined in: type/UpdateProductInput.ts:84

Is it a physical product or a service, download or warranty

priceGroup?​

optional priceGroup?: string

Defined in: type/UpdateProductInput.ts:56

The price group the product belongs to, this field can be used for price calculations

priority?​

optional priority?: number

Defined in: type/UpdateProductInput.ts:64

The products priority, this field can be used to sort the products

purchaseMinimumQuantity?​

optional purchaseMinimumQuantity?: number

Defined in: type/UpdateProductInput.ts:46

The minimum quantity of products that can be ordered when creating a purchase order

purchaseUnit?​

optional purchaseUnit?: number

Defined in: type/UpdateProductInput.ts:44

The unit in which the product can be ordered when creating a purchase order

releaseDate?​

optional releaseDate?: string

Defined in: type/UpdateProductInput.ts:52

The release date of this product

returnable?​

optional returnable?: YesNo

Defined in: type/UpdateProductInput.ts:82

Is this product returnable

shortDescriptions?​

optional shortDescriptions?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:16

The short descriptions of this product per language

sku?​

optional sku?: string

Defined in: type/UpdateProductInput.ts:22

The SKU (stock keeping unit) of this product

slugs?​

optional slugs?: LocalizedStringInput[]

Defined in: type/UpdateProductInput.ts:91

Localized slugs

sources?​

optional sources?: SourceInput[]

Defined in: type/UpdateProductInput.ts:105

Source/SourceId combinations for external system lookup (replaces existing sources)

status?​

optional status?: ProductStatus

Defined in: type/UpdateProductInput.ts:24

The status of this product

statusExtra?​

optional statusExtra?: string

Defined in: type/UpdateProductInput.ts:26

The extra status of this product, commonly linked to a custom valueset

supplier?​

optional supplier?: string

Defined in: type/UpdateProductInput.ts:28

The supplier of this product

supplierCode?​

optional supplierCode?: string

Defined in: type/UpdateProductInput.ts:30

The supplier code of this product

taxonomy?​

optional taxonomy?: string

Defined in: type/UpdateProductInput.ts:58

The taxonomy the product belongs to

turnoverGroup?​

optional turnoverGroup?: string

Defined in: type/UpdateProductInput.ts:54

The turnover group that classifies the product within the financial structure

unit?​

optional unit?: number

Defined in: type/UpdateProductInput.ts:74

The unit in which the product can be ordered

weight?​

optional weight?: number

Defined in: type/UpdateProductInput.ts:101

Product weight

width?​

optional width?: number

Defined in: type/UpdateProductInput.ts:95

Product width