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!
  priority: Int
  metadataTitles: [LocalizedString!]
  metadataDescriptions: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrls: [LocalizedString!]
  sources: [Source!]!
  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!
  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

Localized product names for different languages.

Collection of product names in various languages for international markets and multilingual storefronts.

IProduct.names.language ● String scalar

Language code to filter names.

ISO 639-1 uppercase language code (e.g., 'EN', 'NL', 'DE'). If provided, returns only names for that language.

IProduct.descriptions ● [LocalizedString!]! non-null object

Detailed product descriptions in multiple languages.

Comprehensive product information including features, specifications, and benefits for each supported language.

IProduct.descriptions.language ● String scalar

Language code to filter descriptions.

ISO 639-1 uppercase language code (e.g., 'EN', 'NL', 'DE'). If provided, returns only descriptions for that language.

IProduct.shortDescriptions ● [LocalizedString!]! non-null object

Brief product summaries for listings and previews.

Concise product descriptions suitable for category pages, search results, and product cards where space is limited.

IProduct.shortDescriptions.language ● String scalar

IProduct.slugs ● [LocalizedString!]! non-null object

URL-friendly product identifiers for each language.

SEO-optimized URL segments used in product page URLs for better search engine visibility and user-friendly links.

IProduct.slugs.language ● String scalar

IProduct.sku ● String! non-null scalar

Stock Keeping Unit for inventory management.

Unique alphanumeric code used for inventory tracking, order processing, and product identification across all systems and channels.

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.priority ● Int scalar

IProduct.metadataTitles ● [LocalizedString!] list object

[SEO] Localized Metadata title available in multiple languages

IProduct.metadataDescriptions ● [LocalizedString!] list object

[SEO] Localized Metadata description available in multiple languages

IProduct.metadataKeywords ● [LocalizedString!] list object

[SEO] Localized Metadata keywords available in multiple languages

IProduct.metadataCanonicalUrls ● [LocalizedString!] list object

[SEO] Localized Metadata canonical url available in multiple languages

IProduct.sources ● [Source!]! non-null object

Product data sources and external system references.

Returns information about external systems and sources that provide data for this product, used for data lineage and integration management.

IProduct.productId ● Int! non-null scalar

Primary product identifier.

Unique numeric identifier used throughout the system for product references, ordering, and integration with external systems.

IProduct.shortName ● String! non-null scalar

Abbreviated product name.

Concise product identifier used where space is limited.

IProduct.keywords ● [LocalizedString!] list object

Supplier-provided search keywords.

Additional search terms provided by the supplier to improve product discoverability and search engine optimization.

IProduct.customKeywords ● [LocalizedString!] list object

Custom search keywords managed via PIM.

Additional search terms added through the Product Information Management system for enhanced search functionality.

IProduct.packageDescriptions ● [LocalizedString!] list object

Localized packaging information.

Detailed packaging descriptions in multiple languages for customer information and marketing purposes.

IProduct.manufacturerCode ● String! non-null scalar

Original Equipment Manufacturer (OEM) code.

Manufacturer's own product code used for cross-referencing, warranty claims, and supplier communication.

IProduct.eanCode ● String! non-null scalar

European Article Number for global identification.

Standardized number used for product identification, inventory management, and point-of-sale systems.

IProduct.manufacturer ● String! non-null scalar

Product manufacturer information.

Company or brand that produces the product, used for brand filtering, warranty information, and supplier relationships.

IProduct.supplier ● String! non-null scalar

Primary supplier information.

Company or organization that supplies this product, used for procurement, inventory management, and supplier relationships.

IProduct.supplierCode ● String! non-null scalar

Supplier's product identification code.

Supplier-specific product code used for ordering, inventory management, and communication with suppliers.

IProduct.status ● ProductStatus! non-null enum

Current product lifecycle status.

Indicates the product's current state in its lifecycle, affecting availability and visibility.

IProduct.statusExtra ● String scalar

Additional status classification.

Supplementary status information often linked to custom value sets for specific business requirements and workflows.

IProduct.barCode ● String scalar

Product barcode for scanning and identification.

Machine-readable code used for inventory management, checkout processes, and automated product identification.

IProduct.turnoverGroup ● String scalar

Financial classification for reporting.

Groups products for financial reporting and analysis, used in accounting systems and business intelligence.

IProduct.taxonomy ● String scalar

Product classification hierarchy.

Standardized product categorization system used for organization, reporting, and integration with external systems.

IProduct.priceGroup ● String scalar

Pricing strategy classification.

Groups products with similar pricing rules and strategies, used by pricing engines for consistent pricing logic.

IProduct.orderable ● YesNo! non-null enum

Product availability for ordering.

Indicates whether customers can currently place orders for this product through the storefront and ordering systems.

IProduct.returnable ● YesNo! non-null enum

Product return policy eligibility.

Indicates whether this product can be returned by customers according to the return policy and business rules.

IProduct.physical ● YesNo! non-null enum

Product type classification for fulfillment.

Indicates whether this is a physical product requiring shipping or a digital product/service like downloads, warranties, or services.

IProduct.package ● String! non-null scalar

Product packaging type classification.

Describes how the product is packaged for sale (e.g., PIECE, BOX, BLISTER), affecting shipping, storage, and display.

IProduct.packageUnit ● String! non-null scalar

Individual item description within package.

Describes what constitutes one unit within the package (e.g., PIECE, BOX), used for inventory and ordering clarity.

IProduct.packageUnitQuantity ● String! non-null scalar

Quantity of individual items per package.

Number of individual units contained within one package, used for inventory calculations and customer information.

IProduct.minimumQuantity ● Float! non-null scalar

Minimum order quantity for customers.

Smallest quantity customers can order, used to enforce business rules and ensure order profitability.

IProduct.unit ● Int! non-null scalar

Base unit of measure for customer ordering.

Standard unit in which customers can order this product, used for pricing and quantity calculations.

IProduct.purchaseUnit ● Int! non-null scalar

Unit of measure for supplier ordering.

Unit used when ordering from suppliers, which may differ from customer ordering units for bulk purchasing efficiency.

IProduct.purchaseMinimumQuantity ● Int! non-null scalar

Minimum order quantity for supplier purchases.

Smallest quantity that can be ordered from suppliers, used for procurement planning and inventory management.

IProduct.economicOrderQuantity ● Int! non-null scalar

Optimal order quantity for cost efficiency.

Quantity that provides the best balance of ordering costs and inventory holding costs, used for purchasing recommendations.

IProduct.orderableFrom ● DateTime scalar

Start date for product ordering availability.

Date from which customers can begin placing orders for this product, used for product launches and seasonal availability.

IProduct.orderableTo ● DateTime scalar

End date for product ordering availability.

Date after which customers can no longer place orders for this product, used for product discontinuation and seasonal restrictions.

IProduct.releaseDate ● DateTime scalar

Product launch date for availability planning.

Date when the product was or will be officially released to the market, used for launch planning and availability scheduling.

IProduct.createdAt ● DateTime! non-null scalar

Product record creation timestamp.

Date and time when this product was first added to the system, used for auditing and product lifecycle tracking.

IProduct.lastModifiedAt ● DateTime! non-null scalar

Product record last modification timestamp.

Date and time when any product information was last updated, used for change tracking and synchronization.

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