Skip to main content

Interface: Product

Defined in: type/Product.ts:25

Object class for Product

Extends​

Properties​

attributes?​

optional attributes?: AttributeResultResponse

Defined in: type/Product.ts:33

Lists attributes for this product based on the search input.

barCode?​

optional barCode?: string

Defined in: type/Product.ts:115

The bar code of this product

bulkPrices?​

optional bulkPrices?: ProductPrice[]

Defined in: type/Product.ts:59

bulkPrices field

bundles?​

optional bundles?: Bundle[]

Defined in: type/Product.ts:35

bundles field

categories?​

optional categories?: CategoryResponse

Defined in: type/Product.ts:39

All the categories the product belongs to

category?​

optional category?: Category

Defined in: type/Product.ts:37

Product main category

categoryId​

categoryId: number

Defined in: type/Product.ts:31

categoryId field

Overrides​

IBaseProduct.categoryId

categoryPath​

categoryPath: Category[]

Defined in: type/Product.ts:41

categoryPath field

class​

class: ProductClass

Defined in: type/Product.ts:65

The class of the request resource

Overrides​

IBaseProduct.class

cluster?​

optional cluster?: Cluster

Defined in: type/Product.ts:165

cluster field

clusterId?​

optional clusterId?: number

Defined in: type/Product.ts:163

The cluster ID of the product's container

containerClass​

containerClass: ProductContainerClass

Defined in: type/Product.ts:161

The container class of this product.

createdAt​

createdAt: string

Defined in: type/Product.ts:155

The creation date of this product

crossupsellsFrom​

crossupsellsFrom: CrossupsellsResponse

Defined in: type/Product.ts:43

crossupsellsFrom field

crossupsellsTo​

crossupsellsTo: CrossupsellsResponse

Defined in: type/Product.ts:45

crossupsellsTo field

customKeywords?​

optional customKeywords?: LocalizedString[]

Defined in: type/Product.ts:97

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

defaultLanguage​

defaultLanguage: string

Defined in: type/Product.ts:79

The default language for this product or cluster, this is the language to fall back too, when there is no translation available in a specific language.

Overrides​

IBaseProduct.defaultLanguage

descriptions​

descriptions: LocalizedString[]

Defined in: type/Product.ts:71

descriptions field

Overrides​

IBaseProduct.descriptions

eanCode​

eanCode: string

Defined in: type/Product.ts:103

The European Article Number (EAN) code of this product

economicOrderQuantity​

economicOrderQuantity: number

Defined in: type/Product.ts:147

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

favoriteLists?​

optional favoriteLists?: FavoriteListsResponse

Defined in: type/Product.ts:47

favoriteLists field

hasBundle​

hasBundle: YesNo

Defined in: type/Product.ts:129

Is this product part of any product bundles.

hidden​

hidden: YesNo

Defined in: type/Product.ts:67

The hidden status of this resource.

Overrides​

IBaseProduct.hidden

id​

id: number

Defined in: type/Product.ts:27

Resource primary identifier

Overrides​

IBaseProduct.id

inventory?​

optional inventory?: ProductInventory

Defined in: type/Product.ts:49

Product inventory

isBundleLeader​

isBundleLeader: YesNo

Defined in: type/Product.ts:131

Is this product leader of any product bundle.

keywords?​

optional keywords?: LocalizedString[]

Defined in: type/Product.ts:95

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

language?​

optional language?: string

Defined in: type/Product.ts:63

The requested language for this this resource, default to the products default language. ISO 639-1 format.

Overrides​

IBaseProduct.language

lastModifiedAt​

lastModifiedAt: string

Defined in: type/Product.ts:157

The last modified date of this product

manufacturer​

manufacturer: string

Defined in: type/Product.ts:105

The manufacturer of this product

manufacturerCode​

manufacturerCode: string

Defined in: type/Product.ts:101

The Original Equipment Manufacturer code (OEM) of this product

media?​

optional media?: ProductMedia

Defined in: type/Product.ts:51

Product media images

metadataCanonicalUrls?​

optional metadataCanonicalUrls?: LocalizedString[]

Defined in: type/Product.ts:89

[SEO] Localized Metadata canonical url available in multiple languages

Overrides​

IBaseProduct.metadataCanonicalUrls

metadataDescriptions?​

optional metadataDescriptions?: LocalizedString[]

Defined in: type/Product.ts:85

[SEO] Localized Metadata description available in multiple languages

Overrides​

IBaseProduct.metadataDescriptions

metadataKeywords?​

optional metadataKeywords?: LocalizedString[]

Defined in: type/Product.ts:87

[SEO] Localized Metadata keywords available in multiple languages

Overrides​

IBaseProduct.metadataKeywords

metadataTitles?​

optional metadataTitles?: LocalizedString[]

Defined in: type/Product.ts:83

[SEO] Localized Metadata title available in multiple languages

Overrides​

IBaseProduct.metadataTitles

minimumQuantity​

minimumQuantity: number

Defined in: type/Product.ts:139

The minimum quantity of products that can be ordered

names​

names: LocalizedString[]

Defined in: type/Product.ts:69

names field

Overrides​

IBaseProduct.names

offers?​

optional offers?: ProductOffer[]

Defined in: type/Product.ts:159

Available offers for this Product and Customer/Contact. First item in the array should be regarded as the active price

orderable​

orderable: YesNo

Defined in: type/Product.ts:123

Is this product orderable

orderableFrom?​

optional orderableFrom?: string

Defined in: type/Product.ts:149

The orderable from date of this product

orderableTo?​

optional orderableTo?: string

Defined in: type/Product.ts:151

The orderable to date of this product

orderlists​

orderlists: OrderlistsResponse

Defined in: type/Product.ts:53

orderlists field

package​

package: string

Defined in: type/Product.ts:133

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

packageDescriptions?​

optional packageDescriptions?: LocalizedString[]

Defined in: type/Product.ts:99

The package description of this product per language

packageUnit​

packageUnit: string

Defined in: type/Product.ts:135

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

packageUnitQuantity​

packageUnitQuantity: string

Defined in: type/Product.ts:137

Number of items within the package

physical​

physical: YesNo

Defined in: type/Product.ts:127

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

price?​

optional price?: ProductPrice

Defined in: type/Product.ts:55

price field

priceData?​

optional priceData?: Price

Defined in: type/Product.ts:57

priceData field

priceGroup?​

optional priceGroup?: string

Defined in: type/Product.ts:121

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

priority?​

optional priority?: number

Defined in: type/Product.ts:81

priority field

Overrides​

IBaseProduct.priority

productId​

productId: number

Defined in: type/Product.ts:29

This product's unique identifier

purchaseMinimumQuantity​

purchaseMinimumQuantity: number

Defined in: type/Product.ts:145

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

purchaseUnit​

purchaseUnit: number

Defined in: type/Product.ts:143

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

releaseDate?​

optional releaseDate?: string

Defined in: type/Product.ts:153

The release date of this product

returnable​

returnable: YesNo

Defined in: type/Product.ts:125

Is this product returnable

shortDescriptions​

shortDescriptions: LocalizedString[]

Defined in: type/Product.ts:73

shortDescriptions field

Overrides​

IBaseProduct.shortDescriptions

shortNames​

shortNames: LocalizedString[]

Defined in: type/Product.ts:93

Short names for this product per language

sku​

sku: string

Defined in: type/Product.ts:77

The SKU (stock keeping unit) of this product

Overrides​

IBaseProduct.sku

slugs​

slugs: LocalizedString[]

Defined in: type/Product.ts:75

slugs field

Overrides​

IBaseProduct.slugs

sources​

sources: Source[]

Defined in: type/Product.ts:91

sources field

Overrides​

IBaseProduct.sources

status​

status: ProductStatus

Defined in: type/Product.ts:111

The status of this product

statusExtra?​

optional statusExtra?: string

Defined in: type/Product.ts:113

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

supplier​

supplier: string

Defined in: type/Product.ts:107

The supplier of this product

supplierCode​

supplierCode: string

Defined in: type/Product.ts:109

The supplier code of this product

surcharges​

surcharges: Surcharge[]

Defined in: type/Product.ts:167

surcharges field

taxonomy?​

optional taxonomy?: string

Defined in: type/Product.ts:119

The taxonomy the product belongs to

turnoverGroup?​

optional turnoverGroup?: string

Defined in: type/Product.ts:117

The turnover group that classifies the product within the financial structure

unit​

unit: number

Defined in: type/Product.ts:141

The unit in which the product can be ordered