Skip to main content

Interface: CreateProductInput

Defined in: type/CreateProductInput.ts:8

Input object for CreateProductInput

Properties​

autoGenerateSlugs?​

optional autoGenerateSlugs?: boolean

Defined in: type/CreateProductInput.ts:103

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

barCode?​

optional barCode?: string

Defined in: type/CreateProductInput.ts:32

The bar code of this product

categoryId?​

optional categoryId?: number

Defined in: type/CreateProductInput.ts:10

The id of the category the product should be created in

clusterId?​

optional clusterId?: number

Defined in: type/CreateProductInput.ts:93

Identifier of the cluster the product is assigned to, if any.

customKeywords?​

optional customKeywords?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:20

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

depth?​

optional depth?: number

Defined in: type/CreateProductInput.ts:99

Depth of the product expressed in the catalogue's base length unit.

descriptions?​

optional descriptions?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:14

The descriptions of this product per language

eanCode?​

optional eanCode?: string

Defined in: type/CreateProductInput.ts:36

The European Article Number (EAN) code of this product

economicOrderQuantity?​

optional economicOrderQuantity?: number

Defined in: type/CreateProductInput.ts:42

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

height?​

optional height?: number

Defined in: type/CreateProductInput.ts:97

Height of the product expressed in the catalogue's base length unit.

hidden​

hidden: YesNo

Defined in: type/CreateProductInput.ts:88

Product hidden status, defaults to N

keywords?​

optional keywords?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:18

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

manufacturer?​

optional manufacturer?: string

Defined in: type/CreateProductInput.ts:44

The manufacturer of this product

manufacturerCode?​

optional manufacturerCode?: string

Defined in: type/CreateProductInput.ts:34

The Original Equipment Manufacturer code (OEM) of this product

metadataCanonicalUrls?​

optional metadataCanonicalUrls?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:86

[SEO] Metadata canonical urls in different languages.

metadataDescriptions?​

optional metadataDescriptions?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:82

[SEO] Metadata description in different languages.

metadataKeywords?​

optional metadataKeywords?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:84

[SEO] Metadata keywords in different languages.

metadataTitles?​

optional metadataTitles?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:80

[SEO] Metadata title in different languages.

minimumQuantity?​

optional minimumQuantity?: number

Defined in: type/CreateProductInput.ts:40

The minimum quantity of products that can be ordered

names?​

optional names?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:12

The names of this product per language

notes?​

optional notes?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:76

Notes on the product for internal use

orderable?​

optional orderable?: YesNo

Defined in: type/CreateProductInput.ts:56

Is this product orderable

orderableFrom?​

optional orderableFrom?: string

Defined in: type/CreateProductInput.ts:58

The orderable from date of this product

orderableTo?​

optional orderableTo?: string

Defined in: type/CreateProductInput.ts:60

The orderable to date of this product

package?​

optional package?: string

Defined in: type/CreateProductInput.ts:46

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

packageDescriptions?​

optional packageDescriptions?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:74

The package description of this product per language

packageUnit?​

optional packageUnit?: string

Defined in: type/CreateProductInput.ts:48

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

packageUnitQuantity?​

optional packageUnitQuantity?: string

Defined in: type/CreateProductInput.ts:50

Number of items within the package

physical?​

optional physical?: YesNo

Defined in: type/CreateProductInput.ts:66

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

priceGroup?​

optional priceGroup?: string

Defined in: type/CreateProductInput.ts:70

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

priority?​

optional priority?: number

Defined in: type/CreateProductInput.ts:78

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

purchaseMinimumQuantity?​

optional purchaseMinimumQuantity?: number

Defined in: type/CreateProductInput.ts:54

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

purchaseUnit?​

optional purchaseUnit?: number

Defined in: type/CreateProductInput.ts:52

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

releaseDate?​

optional releaseDate?: string

Defined in: type/CreateProductInput.ts:62

The release date of this product

returnable?​

optional returnable?: YesNo

Defined in: type/CreateProductInput.ts:64

Is this product returnable

shortDescriptions?​

optional shortDescriptions?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:16

The short descriptions of this product per language

sku?​

optional sku?: string

Defined in: type/CreateProductInput.ts:22

The SKU (stock keeping unit) of this product

slugs?​

optional slugs?: LocalizedStringInput[]

Defined in: type/CreateProductInput.ts:91

URL-friendly identifiers, one per language, used in human-readable links.

sources?​

optional sources?: SourceInput[]

Defined in: type/CreateProductInput.ts:105

Pairs of external system names and the identifiers each system assigned to the record.

status?​

optional status?: ProductStatus

Defined in: type/CreateProductInput.ts:24

The status of this product

statusExtra?​

optional statusExtra?: string

Defined in: type/CreateProductInput.ts:26

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

supplier?​

optional supplier?: string

Defined in: type/CreateProductInput.ts:28

The supplier of this product

supplierCode?​

optional supplierCode?: string

Defined in: type/CreateProductInput.ts:30

The supplier code of this product

taxonomy?​

optional taxonomy?: string

Defined in: type/CreateProductInput.ts:72

The taxonomy the product belongs to

turnoverGroup?​

optional turnoverGroup?: string

Defined in: type/CreateProductInput.ts:68

The turnover group that classifies the product within the financial structure

unit?​

optional unit?: number

Defined in: type/CreateProductInput.ts:38

The unit in which the product can be ordered

weight?​

optional weight?: number

Defined in: type/CreateProductInput.ts:101

Weight of the product expressed in the catalogue's base weight unit.

width?​

optional width?: number

Defined in: type/CreateProductInput.ts:95

Width of the product expressed in the catalogue's base length unit.