IProduct

No description

interface IProduct {
  uuid: ID!
  id: Int!
  type: ProductClass!
  sku: String!
  language: String @deprecated
  hidden: YesNo!
  priority: Int
  categoryId: Int!
  categoryIds: [Int!]!
  defaultLanguage: String!
  names(language: String): [LocalizedString!]!
  descriptions(language: String): [LocalizedString!]!
  shortDescriptions: [LocalizedString!]!
  slugs(language: String): [LocalizedString!]!
  shortNames: [LocalizedString!]!
  metadataTitles: [LocalizedString!]!
  metadataDescriptions: [LocalizedString!]!
  metadataKeywords: [LocalizedString!]!
  metadataCanonicalUrls: [LocalizedString!]!
  sources: [Source!]!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  class: ProductClass! @deprecated
  productId: Int!
  shortName: String! @deprecated
  keywords: [LocalizedString!]!
  customKeywords: [LocalizedString!]!
  packageDescriptions: [LocalizedString!]!
  status: ProductStatus!
  manufacturer: String!
  supplier: String!
  manufacturerCode: String!
  eanCode: String!
  supplierCode: String!
  barCode: String
  statusExtra: String
  orderable: YesNo!
  returnable: YesNo!
  physical: YesNo!
  package: String!
  packageUnit: String!
  packageUnitQuantity: String!
  minimumQuantity: Float!
  unit: Int!
  purchaseUnit: Int!
  purchaseMinimumQuantity: Int!
  economicOrderQuantity: Int!
  turnoverGroup: String
  taxonomy: String
  priceGroup: String
  orderableFrom: DateTime
  orderableTo: DateTime
  releaseDate: DateTime
  clusterId: Int
}

Fields

IProduct.uuid ● ID! non-null scalar

Globally unique identifier for the product or cluster.

IProduct.id ● Int! non-null scalar

Numeric identifier retained for compatibility with legacy integrations.

IProduct.type ● ProductClass! non-null enum

Discriminator that distinguishes between a product and a cluster within the shared catalogue.

IProduct.sku ● String! non-null scalar

Stock keeping unit. Uniquely identifies a product within the catalogue.

IProduct.hidden ● YesNo! non-null enum

Whether the product is hidden from public display

IProduct.priority ● Int scalar

Priority for sorting and display

IProduct.categoryId ● Int! non-null scalar

Default category ID

IProduct.categoryIds ● [Int!]! non-null scalar

All category IDs this base product belongs to

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.names ● [LocalizedString!]! non-null object

Localized names shown to end users in catalog and search surfaces. The catalogue's default language must be present.

IProduct.names.language ● String scalar

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

Localized long-form descriptions shown on product detail surfaces.

IProduct.descriptions.language ● String scalar

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

Localized short descriptions

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

URL-friendly identifiers, one per language, used in human-readable links.

IProduct.slugs.language ● String scalar

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

Localized short names for display purposes

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

Localized titles surfaced in search engine result pages.

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

Localized descriptive snippets surfaced in search engine result pages.

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

Localized keyword lists used by search engines, supplied as comma-separated values.

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

Localized canonical URLs that search engines should treat as the authoritative location.

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

Source/SourceId combinations for external system lookup

IProduct.createdAt ● DateTime! non-null scalar

Timestamp marking when the record was created, in UTC ISO 8601 format.

IProduct.lastModifiedAt ● DateTime! non-null scalar

Timestamp marking the last modification of the record, in UTC ISO 8601 format.

IProduct.productId ● Int! non-null scalar

Product ID (legacy field)

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

Localized keywords

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

Localized custom keywords

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

Localized package descriptions

IProduct.status ● ProductStatus! non-null enum

Product status

IProduct.manufacturer ● String! non-null scalar

Manufacturer

IProduct.supplier ● String! non-null scalar

Supplier

IProduct.manufacturerCode ● String! non-null scalar

Manufacturer code

IProduct.eanCode ● String! non-null scalar

EAN barcode

IProduct.supplierCode ● String! non-null scalar

Supplier code

IProduct.barCode ● String scalar

Barcode identifier

IProduct.statusExtra ● String scalar

Additional status information

IProduct.orderable ● YesNo! non-null enum

Whether the product is orderable

IProduct.returnable ● YesNo! non-null enum

Whether product is returnable

IProduct.physical ● YesNo! non-null enum

Whether product is physical (vs digital)

IProduct.package ● String! non-null scalar

Package type

IProduct.packageUnit ● String! non-null scalar

Package unit

IProduct.packageUnitQuantity ● String! non-null scalar

Package unit quantity

IProduct.minimumQuantity ● Float! non-null scalar

Minimum quantity for ordering

IProduct.unit ● Int! non-null scalar

Unit value

IProduct.purchaseUnit ● Int! non-null scalar

Purchase unit configuration

IProduct.purchaseMinimumQuantity ● Int! non-null scalar

Purchase minimum quantity

IProduct.economicOrderQuantity ● Int! non-null scalar

Economic order quantity

IProduct.turnoverGroup ● String scalar

Turnover group classification

IProduct.taxonomy ● String scalar

Taxonomy classification

IProduct.priceGroup ● String scalar

Price group classification

IProduct.orderableFrom ● DateTime scalar

Date from which product can be ordered

IProduct.orderableTo ● DateTime scalar

Date until which product can be ordered

IProduct.releaseDate ● DateTime scalar

Product release date

IProduct.clusterId ● Int scalar

Cluster ID if assigned to cluster

Show deprecated

Implemented By

Product object