CreateProductInput

Input for creating a new product

input CreateProductInput {
  names: [LocalizedStringInput!]
  descriptions: [LocalizedStringInput!]
  shortDescriptions: [LocalizedStringInput!]
  keywords: [LocalizedStringInput!]
  customKeywords: [LocalizedStringInput!]
  packageDescriptions: [LocalizedStringInput!]
  slugs: [LocalizedStringInput!]
  notes: [LocalizedStringInput!]
  metadataTitles: [LocalizedStringInput!]
  metadataDescriptions: [LocalizedStringInput!]
  metadataKeywords: [LocalizedStringInput!]
  metadataCanonicalUrls: [LocalizedStringInput!]
  sku: String
  categoryId: Int
  shortNames: [LocalizedStringInput!]
  hidden: YesNo!
  priority: Int
  manufacturerCode: String
  eanCode: String
  supplierCode: String
  barCode: String
  status: ProductStatus
  manufacturer: String
  supplier: String
  orderable: YesNo
  minimumQuantity: Int
  unit: Int
  clusterId: Int
  statusExtra: String
  returnable: YesNo
  physical: YesNo
  width: Float
  height: Float
  depth: Float
  weight: Float
  package: String
  packageUnit: String
  packageUnitQuantity: String
  purchaseUnit: Int
  purchaseMinimumQuantity: Int
  economicOrderQuantity: Int
  turnoverGroup: String
  taxonomy: String
  priceGroup: String
  orderableFrom: String
  orderableTo: String
  releaseDate: String
  autoGenerateSlugs: Boolean
  sources: [SourceInput!]
}

Fields

CreateProductInput.names ● [LocalizedStringInput!] list input

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

CreateProductInput.descriptions ● [LocalizedStringInput!] list input

Localized long-form descriptions shown on product detail surfaces.

CreateProductInput.shortDescriptions ● [LocalizedStringInput!] list input

Localized short descriptions surfaced in listings and tiles.

CreateProductInput.keywords ● [LocalizedStringInput!] list input

Localized keywords used by search ranking. Supplied as comma-separated lists per language.

CreateProductInput.customKeywords ● [LocalizedStringInput!] list input

Localized custom keywords appended to the search index in addition to the standard keywords.

CreateProductInput.packageDescriptions ● [LocalizedStringInput!] list input

Localized descriptions of the product packaging.

CreateProductInput.slugs ● [LocalizedStringInput!] list input

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

CreateProductInput.notes ● [LocalizedStringInput!] list input

Internal localized notes that are not exposed to end users.

CreateProductInput.metadataTitles ● [LocalizedStringInput!] list input

Localized titles surfaced in search engine result pages.

CreateProductInput.metadataDescriptions ● [LocalizedStringInput!] list input

Localized descriptive snippets surfaced in search engine result pages.

CreateProductInput.metadataKeywords ● [LocalizedStringInput!] list input

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

CreateProductInput.metadataCanonicalUrls ● [LocalizedStringInput!] list input

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

CreateProductInput.sku ● String scalar

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

CreateProductInput.categoryId ● Int scalar

Identifier of the category exposed as the default for federation purposes.. Ignored when used with clusterProductCreate (cluster products cannot have categories).

CreateProductInput.shortNames ● [LocalizedStringInput!] list input

Localized short labels shown when the full name is too long.

CreateProductInput.hidden ● YesNo! non-null enum

Hides the record from public catalog and search surfaces when set.

CreateProductInput.priority ● Int scalar

Relative ranking used when ordering records; higher values surface first.

CreateProductInput.manufacturerCode ● String scalar

Code assigned to the product by its manufacturer.

CreateProductInput.eanCode ● String scalar

European Article Number barcode value.

CreateProductInput.supplierCode ● String scalar

Code assigned to the product by its supplier.

CreateProductInput.barCode ● String scalar

General-purpose barcode value for warehouse and point-of-sale scanning.

CreateProductInput.status ● ProductStatus enum

Lifecycle status of the product within the catalogue.

CreateProductInput.manufacturer ● String scalar

Name of the manufacturer that produced the product.

CreateProductInput.supplier ● String scalar

Name of the supplier that delivers the product.

CreateProductInput.orderable ● YesNo enum

Indicates whether the product can currently be added to an order.

CreateProductInput.minimumQuantity ● Int scalar

Smallest quantity a customer may add to a single order line.

CreateProductInput.unit ● Int scalar

Unit of measurement used when ordering and pricing the product.

CreateProductInput.clusterId ● Int scalar

Identifier of the cluster the product is assigned to, if any.

CreateProductInput.statusExtra ● String scalar

Free-text status note that complements the structured status field.

CreateProductInput.returnable ● YesNo enum

Indicates whether the product can be returned by the customer after purchase.

CreateProductInput.physical ● YesNo enum

Distinguishes physical goods from digital ones for shipping and tax handling.

CreateProductInput.width ● Float scalar

Width of the product expressed in the catalogue's base length unit.

CreateProductInput.height ● Float scalar

Height of the product expressed in the catalogue's base length unit.

CreateProductInput.depth ● Float scalar

Depth of the product expressed in the catalogue's base length unit.

CreateProductInput.weight ● Float scalar

Weight of the product expressed in the catalogue's base weight unit.

CreateProductInput.package ● String scalar

Type of packaging used to ship the product.

CreateProductInput.packageUnit ● String scalar

Unit of measurement for the contents of a single package.

CreateProductInput.packageUnitQuantity ● String scalar

Quantity of the package unit contained in a single package.

CreateProductInput.purchaseUnit ● Int scalar

Unit used by buyers when placing purchase orders.

CreateProductInput.purchaseMinimumQuantity ● Int scalar

Smallest quantity that can be placed on a purchase order.

CreateProductInput.economicOrderQuantity ● Int scalar

Quantity that minimises ordering and holding costs for purchase orders.

CreateProductInput.turnoverGroup ● String scalar

Classification used for turnover analysis and financial reporting.

CreateProductInput.taxonomy ● String scalar

Taxonomy code used to slot the product into external classification systems.

CreateProductInput.priceGroup ● String scalar

Group used to apply shared pricing rules and discounts to the product.

CreateProductInput.orderableFrom ● String scalar

Earliest moment from which the product may be ordered.

CreateProductInput.orderableTo ● String scalar

Latest moment until which the product may be ordered.

CreateProductInput.releaseDate ● String scalar

Date on which the product is released to the market.

CreateProductInput.autoGenerateSlugs ● Boolean scalar

Whether to auto-generate slugs from names. When true (default), slugs are always generated for languages with names unless explicitly provided. When false, slugs are only generated for languages without existing slugs.

CreateProductInput.sources ● [SourceInput!] list input

Pairs of external system names and the identifiers each system assigned to the record.

Member Of

clusterOptionProductCreate mutation ● clusterProductCreate mutation ● productCreate mutation