IProduct
Interface for the Product Type
interface IProduct {
id: Int!
language: String
class: ProductClass!
hidden: YesNo!
names(
language: String
): [LocalizedString!]!
descriptions(
language: String
): [LocalizedString!]!
shortDescriptions(
language: String
): [LocalizedString!]!
slugs(
language: String
): [LocalizedString!]!
sku: String!
categoryId: Int!
defaultLanguage: String!
productId: Int!
shortName: String!
keywords: [LocalizedString!]
customKeywords: [LocalizedString!]
packageDescriptions: [LocalizedString!]
manufacturerCode: String!
eanCode: String!
manufacturer: String!
supplier: String!
supplierCode: String!
status: ProductStatus!
statusExtra: String
barCode: String
turnoverGroup: String
taxonomy: String
priceGroup: String
orderable: YesNo!
returnable: YesNo!
physical: YesNo!
hasBundle: YesNo!
isBundleLeader: YesNo!
package: String!
packageUnit: String!
packageUnitQuantity: String!
minimumQuantity: Float!
unit: Int!
purchaseUnit: Int!
purchaseMinimumQuantity: Int!
economicOrderQuantity: Int!
orderableFrom: DateTime
orderableTo: DateTime
releaseDate: DateTime
createdAt: DateTime!
lastModifiedAt: DateTime!
offers: [ProductOffer!]
containerClass: ProductContainerClass!
clusterId: Int
}
Fields
IProduct.id ● Int! non-null scalar
Resource primary identifier
IProduct.language ● String scalar
The requested language for this this resource, default to the products default language. ISO 639-1 format.
IProduct.class ● ProductClass! non-null enum
The class of the request resource
IProduct.hidden ● YesNo! non-null enum
The hidden status of this resource.
IProduct.names ● [LocalizedString!]! non-null object
The names of this product per language
IProduct.names.language●Stringscalar
IProduct.descriptions ● [LocalizedString!]! non-null object
The descriptions of this product per language
IProduct.descriptions.language●Stringscalar
IProduct.shortDescriptions ● [LocalizedString!]! non-null object
The short descriptions of this product per language
IProduct.shortDescriptions.language●Stringscalar
IProduct.slugs ● [LocalizedString!]! non-null object
The slugs for this product per language
IProduct.slugs.language●Stringscalar
IProduct.sku ● String! non-null scalar
The SKU (stock keeping unit) of this product
IProduct.categoryId ● Int! non-null scalar
IProduct.defaultLanguage ● String! non-null scalar
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.
IProduct.productId ● Int! non-null scalar
This product's unique identifier
IProduct.shortName ● String! non-null scalar
The short name for the product, used for abbreviated orderlines
IProduct.keywords ● [LocalizedString!] list object
Additional keywords of this product per language. Added by the supplier
IProduct.customKeywords ● [LocalizedString!] list object
Additional keywords of this product per language. Added via the PIM
IProduct.packageDescriptions ● [LocalizedString!] list object
The package description of this product per language
IProduct.manufacturerCode ● String! non-null scalar
The Original Equipment Manufacturer code (OEM) of this product
IProduct.eanCode ● String! non-null scalar
The European Article Number (EAN) code of this product
IProduct.manufacturer ● String! non-null scalar
The manufacturer of this product
IProduct.supplier ● String! non-null scalar
The supplier of this product
IProduct.supplierCode ● String! non-null scalar
The supplier code of this product
IProduct.status ● ProductStatus! non-null enum
The status of this product
IProduct.statusExtra ● String scalar
The extra status of this product, commonly linked to a custom valueset
IProduct.barCode ● String scalar
The bar code of this product
IProduct.turnoverGroup ● String scalar
The turnover group that classifies the product within the financial structure
IProduct.taxonomy ● String scalar
The taxonomy the product belongs to
IProduct.priceGroup ● String scalar
The price group the product belongs to, this field can be used for price calculations
IProduct.orderable ● YesNo! non-null enum
Is this product orderable
IProduct.returnable ● YesNo! non-null enum
Is this product returnable
IProduct.physical ● YesNo! non-null enum
Is it a physical product or a service, download or warranty
IProduct.hasBundle ● YesNo! non-null enum
Is this product part of any product bundles.
IProduct.isBundleLeader ● YesNo! non-null enum
Is this product leader of any product bundle.
IProduct.package ● String! non-null scalar
The package type of this product. i.e.: PIECE, BOX, BLISTER
IProduct.packageUnit ● String! non-null scalar
Description of what an item within a package looks like, i.e.: PIECE or BOX
IProduct.packageUnitQuantity ● String! non-null scalar
Number of items within the package
IProduct.minimumQuantity ● Float! non-null scalar
The minimum quantity of products that can be ordered
IProduct.unit ● Int! non-null scalar
The unit in which the product can be ordered
IProduct.purchaseUnit ● Int! non-null scalar
The unit in which the product can be ordered when creating a purchase order
IProduct.purchaseMinimumQuantity ● Int! non-null scalar
The minimum quantity of products that can be ordered when creating a purchase order
IProduct.economicOrderQuantity ● Int! non-null scalar
The quantity that provides the best value for money for this product
IProduct.orderableFrom ● DateTime scalar
The orderable from date of this product
IProduct.orderableTo ● DateTime scalar
The orderable to date of this product
IProduct.releaseDate ● DateTime scalar
The release date of this product
IProduct.createdAt ● DateTime! non-null scalar
The creation date of this product
IProduct.lastModifiedAt ● DateTime! non-null scalar
The last modified date of this product
IProduct.offers ● [ProductOffer!] list object
Available offers for this Product and Customer/Contact. First item in the array should be regarded as the active price
IProduct.containerClass ● ProductContainerClass! non-null enum
The container class of this product.
IProduct.clusterId ● Int scalar
The cluster ID of the product's container
Implemented By
Product object