Skip to main content

Interface: Product

Defined in: type/Product.ts:26

Object class for Product

Extends​

Properties​

attributes?​

optional attributes?: AttributeResultResponse

Defined in: type/Product.ts:34

Lists attributes for this product based on the search input.

barCode?​

optional barCode?: string

Defined in: type/Product.ts:108

The bar code of this product

bulkPrices?​

optional bulkPrices?: ProductPrice[]

Defined in: type/Product.ts:60

bulkPrices field

bundles?​

optional bundles?: Bundle[]

Defined in: type/Product.ts:36

bundles field

categories?​

optional categories?: CategoryResponse

Defined in: type/Product.ts:40

All the categories the product belongs to

category?​

optional category?: Category

Defined in: type/Product.ts:38

Product main category

categoryId​

categoryId: number

Defined in: type/Product.ts:32

categoryId field

Overrides​

IBaseProduct.categoryId

categoryIds​

categoryIds: number[]

Defined in: type/Product.ts:167

Identifiers of every category the product belongs to.

Overrides​

IBaseProduct.categoryIds

categoryPath​

categoryPath: Category[]

Defined in: type/Product.ts:42

categoryPath field

categoryRelations​

categoryRelations: BaseProductCategoryRelationship[]

Defined in: type/Product.ts:179

Relationships that link the product to its categories, including the default-category flag.

classId​

classId: number

Defined in: type/Product.ts:161

Class ID for federation compatibility (same as productId)

cluster?​

optional cluster?: Cluster

Defined in: type/Product.ts:156

cluster field

clusterId?​

optional clusterId?: number

Defined in: type/Product.ts:154

The cluster ID of the product's container

containerClass​

containerClass: ProductContainerClass

Defined in: type/Product.ts:152

The container class of this product.

createdAt​

createdAt: string

Defined in: type/Product.ts:148

The creation date of this product

Overrides​

IBaseProduct.createdAt

crossUpsells​

crossUpsells: CrossupsellsResponse

Defined in: type/Product.ts:177

Cross- and up-sell relationships in which the product participates, in either direction.

crossupsellsFrom​

crossupsellsFrom: CrossupsellsResponse

Defined in: type/Product.ts:44

crossupsellsFrom field

crossupsellsTo​

crossupsellsTo: CrossupsellsResponse

Defined in: type/Product.ts:46

crossupsellsTo field

customKeywords?​

optional customKeywords?: LocalizedString[]

Defined in: type/Product.ts:90

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

defaultLanguage​

defaultLanguage: string

Defined in: type/IBaseProduct.ts:26

The default language for this product or cluster

Inherited from​

IBaseProduct.defaultLanguage

depth?​

optional depth?: number

Defined in: type/Product.ts:173

Product depth in cm

descriptions​

descriptions: LocalizedString[]

Defined in: type/Product.ts:66

descriptions field

Overrides​

IBaseProduct.descriptions

eanCode​

eanCode: string

Defined in: type/Product.ts:96

The European Article Number (EAN) code of this product

economicOrderQuantity​

economicOrderQuantity: number

Defined in: type/Product.ts:140

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

favoriteLists?​

optional favoriteLists?: FavoriteListsResponse

Defined in: type/Product.ts:48

favoriteLists field

hasBundle​

hasBundle: YesNo

Defined in: type/Product.ts:122

Is this product part of any product bundles.

height?​

optional height?: number

Defined in: type/Product.ts:171

Product height in cm

hidden​

hidden: YesNo

Defined in: type/Product.ts:62

The hidden status of this resource.

Overrides​

IBaseProduct.hidden

id​

id: number

Defined in: type/Product.ts:28

Resource primary identifier

Overrides​

IBaseProduct.id

inventory?​

optional inventory?: ProductInventory

Defined in: type/Product.ts:50

Product inventory

isBundleLeader​

isBundleLeader: YesNo

Defined in: type/Product.ts:124

Is this product leader of any product bundle.

keywords?​

optional keywords?: LocalizedString[]

Defined in: type/Product.ts:88

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

lastModifiedAt​

lastModifiedAt: string

Defined in: type/Product.ts:150

The last modified date of this product

Overrides​

IBaseProduct.lastModifiedAt

manufacturer​

manufacturer: string

Defined in: type/Product.ts:98

The manufacturer of this product

manufacturerCode​

manufacturerCode: string

Defined in: type/Product.ts:94

The Original Equipment Manufacturer code (OEM) of this product

media?​

optional media?: ProductMedia

Defined in: type/Product.ts:52

Product media images

metadataCanonicalUrls?​

optional metadataCanonicalUrls?: LocalizedString[]

Defined in: type/Product.ts:82

[SEO] Localized Metadata canonical url available in multiple languages

Overrides​

IBaseProduct.metadataCanonicalUrls

metadataDescriptions?​

optional metadataDescriptions?: LocalizedString[]

Defined in: type/Product.ts:78

[SEO] Localized Metadata description available in multiple languages

Overrides​

IBaseProduct.metadataDescriptions

metadataKeywords?​

optional metadataKeywords?: LocalizedString[]

Defined in: type/Product.ts:80

[SEO] Localized Metadata keywords available in multiple languages

Overrides​

IBaseProduct.metadataKeywords

metadataTitles?​

optional metadataTitles?: LocalizedString[]

Defined in: type/Product.ts:76

[SEO] Localized Metadata title available in multiple languages

Overrides​

IBaseProduct.metadataTitles

minimumQuantity​

minimumQuantity: number

Defined in: type/Product.ts:132

The minimum quantity of products that can be ordered

names​

names: LocalizedString[]

Defined in: type/Product.ts:64

names field

Overrides​

IBaseProduct.names

orderable​

orderable: YesNo

Defined in: type/Product.ts:116

Is this product orderable

orderableFrom?​

optional orderableFrom?: string

Defined in: type/Product.ts:142

The orderable from date of this product

orderableTo?​

optional orderableTo?: string

Defined in: type/Product.ts:144

The orderable to date of this product

orderlists​

orderlists: OrderlistsResponse

Defined in: type/Product.ts:54

orderlists field

package​

package: string

Defined in: type/Product.ts:126

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

packageDescriptions?​

optional packageDescriptions?: LocalizedString[]

Defined in: type/Product.ts:92

The package description of this product per language

packageUnit​

packageUnit: string

Defined in: type/Product.ts:128

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

packageUnitQuantity​

packageUnitQuantity: string

Defined in: type/Product.ts:130

Number of items within the package

physical​

physical: YesNo

Defined in: type/Product.ts:120

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

price?​

optional price?: ProductPrice

Defined in: type/Product.ts:56

price field

priceData?​

optional priceData?: Price

Defined in: type/Product.ts:58

priceData field

priceGroup?​

optional priceGroup?: string

Defined in: type/Product.ts:114

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

priority?​

optional priority?: number

Defined in: type/Product.ts:74

priority field

Overrides​

IBaseProduct.priority

productId​

productId: number

Defined in: type/Product.ts:30

This product's unique identifier

purchaseMinimumQuantity​

purchaseMinimumQuantity: number

Defined in: type/Product.ts:138

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

purchaseUnit​

purchaseUnit: number

Defined in: type/Product.ts:136

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

releaseDate?​

optional releaseDate?: string

Defined in: type/Product.ts:146

The release date of this product

returnable​

returnable: YesNo

Defined in: type/Product.ts:118

Is this product returnable

shortDescriptions​

shortDescriptions: LocalizedString[]

Defined in: type/Product.ts:68

shortDescriptions field

Overrides​

IBaseProduct.shortDescriptions

shortNames​

shortNames: LocalizedString[]

Defined in: type/Product.ts:86

Short names for this product per language

sku​

sku: string

Defined in: type/Product.ts:72

The SKU (stock keeping unit) of this product

Overrides​

IBaseProduct.sku

slugs​

slugs: LocalizedString[]

Defined in: type/Product.ts:70

slugs field

Overrides​

IBaseProduct.slugs

sources​

sources: Source[]

Defined in: type/Product.ts:84

sources field

Overrides​

IBaseProduct.sources

status​

status: ProductStatus

Defined in: type/Product.ts:104

The status of this product

statusExtra?​

optional statusExtra?: string

Defined in: type/Product.ts:106

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

supplier​

supplier: string

Defined in: type/Product.ts:100

The supplier of this product

supplierCode​

supplierCode: string

Defined in: type/Product.ts:102

The supplier code of this product

surcharges​

surcharges: Surcharge[]

Defined in: type/Product.ts:158

surcharges field

taxonomy?​

optional taxonomy?: string

Defined in: type/Product.ts:112

The taxonomy the product belongs to

turnoverGroup?​

optional turnoverGroup?: string

Defined in: type/Product.ts:110

The turnover group that classifies the product within the financial structure

type​

type: ProductClass

Defined in: type/Product.ts:165

Discriminator that distinguishes between a product and a cluster within the shared catalogue.

Overrides​

IBaseProduct.type

unit​

unit: number

Defined in: type/Product.ts:134

The unit in which the product can be ordered

uuid​

uuid: string

Defined in: type/Product.ts:163

Globally unique identifier for the product or cluster.

Overrides​

IBaseProduct.uuid

weight?​

optional weight?: number

Defined in: type/Product.ts:175

Product weight in kg

width?​

optional width?: number

Defined in: type/Product.ts:169

Product width in cm