product Query

Look up a product by ID.

Requires one of the following permissions to include the unpublished items: MANAGE_ORDERSMANAGE_DISCOUNTSMANAGE_PRODUCTS

product(
  id: ID
  slug: String
  slugLanguageCode: LanguageCodeEnum
  externalReference: String
  channel: String
): Product

Details

type Product implements Node, ObjectWithMetadata, ObjectWithAttributes {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  assignedAttribute(
    slug: String!
  ): AssignedAttribute
  assignedAttributes(
    limit: PositiveInt = 100
  ): [AssignedAttribute!]!
  seoTitle: String
  seoDescription: String
  name: String!
  description: JSONString
  productType: ProductType!
  slug: String!
  category: Category
  created: DateTime!
  updatedAt: DateTime!
  chargeTaxes: Boolean! @deprecated
  weight: Weight
  defaultVariant: ProductVariant
  rating: Float
  channel: String
  descriptionJson: JSONString @deprecated
  thumbnail(
    size: Int
    format: ThumbnailFormatEnum = ORIGINAL
  ): Image
  pricing(
    address: AddressInput
  ): ProductPricingInfo
  isAvailable(
    address: AddressInput
  ): Boolean
  taxType: TaxType @deprecated
  attribute(
    slug: String!
  ): SelectedAttribute @deprecated
  attributes: [SelectedAttribute!]! @deprecated
  channelListings: [ProductChannelListing!]
  mediaById(
    id: ID!
  ): ProductMedia
  imageById(
    id: ID!
  ): ProductImage @deprecated
  variant(
    id: ID
    sku: String
  ): ProductVariant @deprecated
  variants: [ProductVariant!] @deprecated
  productVariants(
    filter: ProductVariantFilterInput
    where: ProductVariantWhereInput
    sortBy: ProductVariantSortingInput
    before: String
    after: String
    first: Int
    last: Int
  ): ProductVariantCountableConnection
  media(
    sortBy: MediaSortingInput
  ): [ProductMedia!]
  images: [ProductImage!] @deprecated
  collections: [Collection!]
  translation(
    languageCode: LanguageCodeEnum!
  ): ProductTranslation
  availableForPurchase: Date @deprecated
  availableForPurchaseAt: DateTime
  isAvailableForPurchase: Boolean
  taxClass: TaxClass
  externalReference: String
}