Product
No description
type Product implements IResource, IBaseProduct, IProduct {
id: Int!
productId: Int!
categoryId: Int!
attributes(
input: AttributeResultSearchInput
): AttributeResultResponse
bundles(
taxZone: String = "NL"
): [Bundle!]
category: Category
categories(
input: ProductCategorySearchInput
): CategoryResponse
categoryPath: [Category!]!
crossupsellsFrom(
input: CrossupsellSearchInput
): CrossupsellsResponse!
crossupsellsTo(
input: CrossupsellSearchInput
): CrossupsellsResponse!
favoriteLists(
input: FavoriteListsSearchInput
): FavoriteListsResponse
inventory: ProductInventory
mediaImages(
search: MediaImageProductSearchInput = [object Object]
): PaginatedMediaImageResponse @deprecated
mediaVideos(
search: MediaVideoProductSearchInput = [object Object]
): PaginatedMediaVideoResponse @deprecated
mediaDocuments(
search: MediaDocumentProductSearchInput = [object Object]
): PaginatedMediaDocumentResponse @deprecated
media: ProductMedia
orderlists(
input: OrderlistSearchInput
): OrderlistsResponse!
price(
input: PriceCalculateProductInput
): ProductPrice
priceData: Price
bulkPrices(
taxZone: String! = NL
): [ProductPrice!]
language: String
class: ProductClass!
hidden: YesNo!
names(
language: String
): [LocalizedString!]!
descriptions(
language: String
): [LocalizedString!]!
shortDescriptions(
language: String
): [LocalizedString!]!
slugs(
language: String
): [LocalizedString!]!
sku: String!
defaultLanguage: String!
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
cluster: Cluster
surcharges(
input: SurchargeSearchInput
): [Surcharge!]!
}
Fields
Product.id ● Int! non-null scalar
Resource primary identifier
Product.productId ● Int! non-null scalar
This product's unique identifier
Product.categoryId ● Int! non-null scalar
Product.attributes ● AttributeResultResponse object
Lists attributes for this product based on the search input.
Product.attributes.input●AttributeResultSearchInputinput
Product.bundles ● [Bundle!] list object
Product.bundles.taxZone●Stringscalar
Product.category ● Category object
Product main category
Product.categories ● CategoryResponse object
All the categories the product belongs to
Product.categories.input●ProductCategorySearchInputinput
Product.categoryPath ● [Category!]! non-null object
Product.crossupsellsFrom ● CrossupsellsResponse! non-null object
Product.crossupsellsFrom.input●CrossupsellSearchInputinput
Product.crossupsellsTo ● CrossupsellsResponse! non-null object
Product.crossupsellsTo.input●CrossupsellSearchInputinput
Product.favoriteLists ● FavoriteListsResponse object
Product.favoriteLists.input●FavoriteListsSearchInputinput
Product.inventory ● ProductInventory object
Product inventory
Product.mediaImages ● PaginatedMediaImageResponse deprecated object
DEPRECATEDDeprecated in favor of
media.imagesProduct media images
Product.mediaImages.search●MediaImageProductSearchInputinputProduct media images search options
Product.mediaVideos ● PaginatedMediaVideoResponse deprecated object
DEPRECATEDDeprecated in favor of
media.videosProduct media videos
Product.mediaVideos.search●MediaVideoProductSearchInputinputProduct media videos search options
Product.mediaDocuments ● PaginatedMediaDocumentResponse deprecated object
DEPRECATEDDeprecated in favor of
media.documentsProduct media documents
Product.mediaDocuments.search●MediaDocumentProductSearchInputinputProduct media documents search options
Product.media ● ProductMedia object
Product media images
Product.orderlists ● OrderlistsResponse! non-null object
Product.orderlists.input●OrderlistSearchInputinput
Product.price ● ProductPrice object
Product.price.input●PriceCalculateProductInputinput
Product.priceData ● Price object
Product.bulkPrices ● [ProductPrice!] list object
Product.bulkPrices.taxZone●String!non-null scalar
Product.language ● String scalar
The requested language for this this resource, default to the products default language. ISO 639-1 format.
Product.class ● ProductClass! non-null enum
The class of the request resource
Product.hidden ● YesNo! non-null enum
The hidden status of this resource.
Product.names ● [LocalizedString!]! non-null object
Product.names.language●Stringscalar
Product.descriptions ● [LocalizedString!]! non-null object
Product.descriptions.language●Stringscalar
Product.shortDescriptions ● [LocalizedString!]! non-null object
Product.shortDescriptions.language●Stringscalar
Product.slugs ● [LocalizedString!]! non-null object
Product.slugs.language●Stringscalar
Product.sku ● String! non-null scalar
The SKU (stock keeping unit) of this product
Product.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.
Product.shortName ● String! non-null scalar
The short name for the product, used for abbreviated orderlines
Product.keywords ● [LocalizedString!] list object
Additional keywords of this product per language. Added by the supplier
Product.customKeywords ● [LocalizedString!] list object
Additional keywords of this product per language. Added via the PIM
Product.packageDescriptions ● [LocalizedString!] list object
The package description of this product per language
Product.manufacturerCode ● String! non-null scalar
The Original Equipment Manufacturer code (OEM) of this product
Product.eanCode ● String! non-null scalar
The European Article Number (EAN) code of this product
Product.manufacturer ● String! non-null scalar
The manufacturer of this product
Product.supplier ● String! non-null scalar
The supplier of this product
Product.supplierCode ● String! non-null scalar
The supplier code of this product
Product.status ● ProductStatus! non-null enum
The status of this product
Product.statusExtra ● String scalar
The extra status of this product, commonly linked to a custom valueset
Product.barCode ● String scalar
The bar code of this product
Product.turnoverGroup ● String scalar
The turnover group that classifies the product within the financial structure
Product.taxonomy ● String scalar
The taxonomy the product belongs to
Product.priceGroup ● String scalar
The price group the product belongs to, this field can be used for price calculations
Product.orderable ● YesNo! non-null enum
Is this product orderable
Product.returnable ● YesNo! non-null enum
Is this product returnable
Product.physical ● YesNo! non-null enum
Is it a physical product or a service, download or warranty
Product.hasBundle ● YesNo! non-null enum
Is this product part of any product bundles.
Product.isBundleLeader ● YesNo! non-null enum
Is this product leader of any product bundle.
Product.package ● String! non-null scalar
The package type of this product. i.e.: PIECE, BOX, BLISTER
Product.packageUnit ● String! non-null scalar
Description of what an item within a package looks like, i.e.: PIECE or BOX
Product.packageUnitQuantity ● String! non-null scalar
Number of items within the package
Product.minimumQuantity ● Float! non-null scalar
The minimum quantity of products that can be ordered
Product.unit ● Int! non-null scalar
The unit in which the product can be ordered
Product.purchaseUnit ● Int! non-null scalar
The unit in which the product can be ordered when creating a purchase order
Product.purchaseMinimumQuantity ● Int! non-null scalar
The minimum quantity of products that can be ordered when creating a purchase order
Product.economicOrderQuantity ● Int! non-null scalar
The quantity that provides the best value for money for this product
Product.orderableFrom ● DateTime scalar
The orderable from date of this product
Product.orderableTo ● DateTime scalar
The orderable to date of this product
Product.releaseDate ● DateTime scalar
The release date of this product
Product.createdAt ● DateTime! non-null scalar
The creation date of this product
Product.lastModifiedAt ● DateTime! non-null scalar
The last modified date of this product
Product.offers ● [ProductOffer!] list object
Available offers for this Product and Customer/Contact. First item in the array should be regarded as the active price
Product.containerClass ● ProductContainerClass! non-null enum
The container class of this product.
Product.clusterId ● Int scalar
The cluster ID of the product's container
Product.cluster ● Cluster object
Product.surcharges ● [Surcharge!]! non-null object
Product.surcharges.input●SurchargeSearchInputinput
Interfaces
IResource interface
IBaseProduct interface
Interface for the BaseProduct Type, where both Products and clusters derive from
IProduct interface
Interface for the Product Type
Returned By
product query ● productCreate mutation ● productUpdate mutation
Member Of
BundleItem object ● CartBaseItem object ● CartMainItem object ● Cluster object ● ClusterOption object ● Discount object ● ICartBaseItem interface ● ICluster interface ● IClusterOption interface ● OrderItem object ● TenderMainItem object