Skip to main content

product

Retrieve a single product by identifier, stock keeping unit, or localized slug.

Exactly one lookup parameter must be supplied. When looking up by slug the matching language must also be supplied. The lookup honours orderlist permissions and can be scoped to a specific user or company for personalised catalog views.

Possible errors:

  • PRODUCT_NOT_FOUND: No product matched the supplied lookup parameters.

AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

product(
  id: Int
  productId: Int
  slug: String
  sku: String
  language: String
  applyOrderlists: Boolean = true
  orderlistIds: [Int!]
  userId: Int
  companyId: Int
  hidden: Boolean
): Product!

Arguments​

product.id ● Int scalar​

Numeric identifier of the product retained for compatibility with legacy integrations.

Deprecated: use productId instead.

product.productId ● Int scalar​

Numeric identifier of the product to retrieve.

Mutually exclusive with the other lookup parameters.

product.slug ● String scalar​

Localized slug of the product to retrieve.

Must be paired with the language argument so the catalogue can disambiguate slugs across languages.

product.sku ● String scalar​

Stock keeping unit of the product to retrieve.

Mutually exclusive with the other lookup parameters.

product.language ● String scalar​

Two-letter ISO 639-1 language code paired with the slug lookup.

product.applyOrderlists ● Boolean scalar​

Applies the caller's orderlist filtering to the result when enabled.

Disable to retrieve the product without orderlist permission checks.

product.orderlistIds ● [Int!] list scalar​

Identifiers of specific orderlists to apply during the lookup.

When omitted, the caller's default orderlists are applied.

product.userId ● Int scalar​

Identifier of the user whose catalog view should be impersonated.

Permissions, orderlists and favorites of the supplied user are merged with the caller's own.

product.companyId ● Int scalar​

Identifier of the company whose catalog view should be impersonated.

Permissions, orderlists and favorites of the supplied company are merged with the caller's own.

product.hidden ● Boolean scalar​

Restricts the lookup to products matching the supplied visibility flag.

Omit to fall back to the caller's default visibility scope.

Type​

Product object​

Product entity representing items in the product catalog.

External entity from the product service that provides basic product identification and categorization. Used as a reference for product-specific attributes and relationships within the attribute system.