Skip to main content

IBaseProduct

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

interface IBaseProduct {
  id: Int!
  language: String
  class: String!
  classId: Int! @deprecated
  isHidden: YesNo!
  name(
    language: String
  ): [LocalizedString!]!
  description(
    language: String
  ): [LocalizedString!]!
  shortDescription(
    language: String
  ): [LocalizedString!]!
  slug(
    language: String
  ): [LocalizedString!]!
  sku: String!
  categoryId: Int!
  path: String @deprecated
  defaultLanguage: String!
  priority: Int
  metadataTitle: [LocalizedString!]
  metadataDescription: [LocalizedString!]
  metadataKeywords: [LocalizedString!]
  metadataCanonicalUrl: [LocalizedString!]
  sources: [ProductSource!]!
}

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 ● String! non-null scalar​

The class of the request resource

IBaseProduct.classId ● Int! deprecated non-null scalar​

DEPRECATED

Deprecated in favor of productId and clusterId

The class ID of the request resource

IBaseProduct.isHidden ● YesNo! non-null enum​

The hidden status of this resource.

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

Localized product name as it is available in the supported language defaults to the product's default language.

IBaseProduct.name.language ● String scalar​

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

The long description for this product, this field can contain html formatting, this field can be translated is case of multilingual catalog

IBaseProduct.description.language ● String scalar​

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

The short description for this product, this field can contain html formatting, this field can be translated is case of multilingual catalog

IBaseProduct.shortDescription.language ● String scalar​

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

Slugified version of the product name, that can be used in urls. A slug is available per language.

IBaseProduct.slug.language ● String scalar​

IBaseProduct.sku ● String! non-null scalar​

The Stock keeping unit for this product.

IBaseProduct.categoryId ● Int! non-null scalar​

IBaseProduct.path ● String deprecated scalar​

DEPRECATED

Path is no longer supported

The catalog path of this product. Contains a list of ID's of categories with a / as delimiter

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 avaialbe in a specific language.

IBaseProduct.priority ● Int scalar​

The order of the product in search results when sorting by priority.

IBaseProduct.metadataTitle ● [LocalizedString!] list object​

[SEO] Localized Metadata title available in multiple languages

IBaseProduct.metadataDescription ● [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.metadataCanonicalUrl ● [LocalizedString!] list object​

[SEO] Localized Metadata canonical url available in multiple languages

IBaseProduct.sources ● [ProductSource!]! non-null object​

Member Of​

Crossupsell object ● ProductsResponse object ● SparePart object

Implemented By​

Cluster object ● Product object