Product
No description
type Product implements IResource, IBaseProduct, IProduct {
id: Int!
classId: Int! @deprecated
categoryId: Int!
attributes(
filter: AttributeFilterInput
): [Attribute!]! @deprecated
attributeValues(
filter: AttributeFilterInput
): AttributeValueResponse!
productId: Int!
bundles(
taxZone: String = "NL"
): [Bundle!]
category: Category
categoryPath: [Category!]!
crossupsells(
input: CrossupsellTypesInput
): [Crossupsell!]!
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!
isAllowed(
userId: Int!
permission: Permission!
): Boolean!
price(
quantity: Int
taxZone: String! = NL
userId: Int
): ProductPrice
bulkPrices(
taxZone: String! = NL
): [BulkPrice!]
language: String
class: String!
isHidden: YesNo!
name(
language: String
): [LocalizedString!]!
description(
language: String
): [LocalizedString!]!
shortDescription(
language: String
): [LocalizedString!]!
slug(
language: String
): [LocalizedString!]!
sku: String!
path: String @deprecated
defaultLanguage: String!
shortName: String!
manufacturerCode: String!
eanCode: String!
manufacturer: String!
supplier: String!
supplierCode: String!
tag: String!
taxCode: TaxCode!
status: ProductStatus!
isOrderable: YesNo!
isReturnable: YesNo!
hasBundle: YesNo!
isBundleLeader: YesNo!
package: String!
packageUnit: String!
packageUnitQuantity: String!
priceDisplay: String!
originalPrice: Float!
costPrice: Float!
suggestedPrice: Float!
storePrice: Float!
creditPoints: Float!
minimumQuantity: Float!
unit: Int!
purchaseUnit: Int!
purchaseMinimumQuantity: Int!
econommicOrderQuantity: Int!
orderableFrom: DateTime
orderableTo: DateTime
releaseDate: DateTime
dateCreated: DateTime!
dateChanged: DateTime!
offers: [ProductOffer!]
containerClass: String!
cluster: Cluster
surcharges(
input: SurchargeSearchInput
): [Surcharge!]!
}
Fields
Product.id ● Int! non-null scalar
Resource primary identifier
Product.classId ● Int! deprecated non-null scalar
DEPRECATEDDeprecated in favor of productId and clusterId
The class ID of the request resource
Product.categoryId ● Int! non-null scalar
Product.attributes ● [Attribute!]! deprecated non-null object
DEPRECATEDDeprecated is favour of attributeValues. Added pagination to ther query the default offset will be 12 values. Increasing the offset in a listed view will impact the performance of the api.
Returns an array of legacy Attribute Entities
Product.attributes.filter●AttributeFilterInputinput
Product.attributeValues ● AttributeValueResponse! non-null object
Returns a paginated response of AttributeValues
Product.attributeValues.filter●AttributeFilterInputinput
Product.productId ● Int! non-null scalar
This product's classID
Product.bundles ● [Bundle!] list object
Product.bundles.taxZone●Stringscalar
Product.category ● Category object
Product.categoryPath ● [Category!]! non-null object
Product.crossupsells ● [Crossupsell!]! non-null object
Product.crossupsells.input●CrossupsellTypesInputinput
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.isAllowed ● Boolean! non-null scalar
Product.isAllowed.userId●Int!non-null scalar
Product.isAllowed.permission ● Permission! non-null enum
Product.price ● ProductPrice object
Product.price.quantity●IntscalarThe order quantity to calculate the price for
Product.price.taxZone ● String! non-null scalar
The taxZone used for calculating net price of the prices below. Will likely be deprecated in the future in favor of adding the taxZone argument on the net() field instead
Product.price.userId ● Int scalar
The id of the user you want to calculate the price for. Defaults to the logged in user. Can only be altered when the logged in user had sufficient permissions
Product.bulkPrices ● [BulkPrice!] 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 ● String! non-null scalar
The class of the request resource
Product.isHidden ● YesNo! non-null enum
The hidden status of this resource.
Product.name ● [LocalizedString!]! non-null object
Product.name.language●Stringscalar
Product.description ● [LocalizedString!]! non-null object
Product.description.language●Stringscalar
Product.shortDescription ● [LocalizedString!]! non-null object
Product.shortDescription.language●Stringscalar
Product.slug ● [LocalizedString!]! non-null object
Product.slug.language●Stringscalar
Product.sku ● String! non-null scalar
The Stock keeping unit for this product.
Product.path ● String deprecated scalar
DEPRECATEDPath is no longer supported
The catalog path of this product. Contains a list of ID's of categories with a / as delimiter
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 avaialbe in a specific language.
Product.shortName ● String! non-null scalar
The short name product. Commonly used for connections with third parties that have a size limitation on the product name field.
Product.manufacturerCode ● String! non-null scalar
The Original Equipment Manufacturer code for this product.
Product.eanCode ● String! non-null scalar
The European Article Number or barcode for this product.
Product.manufacturer ● String! non-null scalar
The manufacturer name for this product.
Product.supplier ● String! non-null scalar
The supplier of this product.
Product.supplierCode ● String! non-null scalar
The supplierCode as it's know at the given supplier of this product.
Product.tag ● String! non-null scalar
The tag of this product.
Product.taxCode ● TaxCode! non-null enum
The tax code for this product, either: H = High L = Low N = No tax
Product.status ● ProductStatus! non-null enum
The status of this product:
Product.isOrderable ● YesNo! non-null enum
The orderable status of this product.
Product.isReturnable ● YesNo! non-null enum
The returnable status of this product.
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 default package type for this product.
Product.packageUnit ● String! non-null scalar
The default package unit for this product.
Product.packageUnitQuantity ● String! non-null scalar
The default package unit quantity for this product.
Product.priceDisplay ● String! non-null scalar
Indicates how a product should be shown
Product.originalPrice ● Float! non-null scalar
Original price of the product
Product.costPrice ● Float! non-null scalar
Product cost price
Product.suggestedPrice ● Float! non-null scalar
Product suggested price
Product.storePrice ● Float! non-null scalar
Product store price
Product.creditPoints ● Float! non-null scalar
Product credit points
Product.minimumQuantity ● Float! non-null scalar
Product minimum quantity
Product.unit ● Int! non-null scalar
Product unit
Product.purchaseUnit ● Int! non-null scalar
Product purchase unit
Product.purchaseMinimumQuantity ● Int! non-null scalar
Product minimum purchasable quantity
Product.econommicOrderQuantity ● Int! non-null scalar
Product minimal economic order quantity
Product.orderableFrom ● DateTime scalar
Product orderable from date
Product.orderableTo ● DateTime scalar
Product orderable to date
Product.releaseDate ● DateTime scalar
Product release date
Product.dateCreated ● DateTime! non-null scalar
Product creation date
Product.dateChanged ● DateTime! non-null scalar
Product last modified date
Product.offers ● [ProductOffer!] list object
Available offers for this product and User. First item in the array should be regarded as the active price
Product.containerClass ● String! non-null scalar
The class of the product's container, can be either folder or cluster
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 ● Crossupsell object ● ICartBaseItem interface ● ICluster interface ● IClusterOption interface ● OrderItem object ● TenderMainItem object