Skip to main content

IBaseProduct

Interface for the BaseProduct Type, where both Products and clusters derive from

interface IBaseProduct {
  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!]!
}

Fields​

IBaseProduct.id ● Int! non-null scalar​

Resource primary identifier

IBaseProduct.language ● String scalar​

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

IBaseProduct.class ● ProductClass! non-null enum​

The class of the request resource

IBaseProduct.hidden ● YesNo! non-null enum​

The hidden status of this resource.

IBaseProduct.names ● [LocalizedString!]! non-null object​

Localized product names for different languages.

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

IBaseProduct.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.

IBaseProduct.descriptions ● [LocalizedString!]! non-null object​

Detailed product descriptions in multiple languages.

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

IBaseProduct.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.

IBaseProduct.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.

IBaseProduct.shortDescriptions.language ● String scalar​

IBaseProduct.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.

IBaseProduct.slugs.language ● String scalar​

IBaseProduct.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.

IBaseProduct.categoryId ● Int! non-null scalar​

IBaseProduct.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.

IBaseProduct.priority ● Int scalar​

IBaseProduct.metadataTitles ● [LocalizedString!] list object​

[SEO] Localized Metadata title available in multiple languages

IBaseProduct.metadataDescriptions ● [LocalizedString!] list object​

[SEO] Localized Metadata description available in multiple languages

IBaseProduct.metadataKeywords ● [LocalizedString!] list object​

[SEO] Localized Metadata keywords available in multiple languages

IBaseProduct.metadataCanonicalUrls ● [LocalizedString!] list object​

[SEO] Localized Metadata canonical url available in multiple languages

IBaseProduct.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.

Member Of​

Crossupsell object ● ProductsResponse object ● SparePart object

Implemented By​

Cluster object ● Product object