OBJECT

Product

link GraphQL Schema definition

  • type Product {
  • # Description of the product. Displays to customers on checkout pages and in
  • # emails.
  • #
  • # Arguments
  • # languageIds: Array of relevant languageIds
  • additionalNameInformation(
  • languageIds: [LanguageEnum]
  • ): [LocalizedString]
  • # Indicates whether dynamic product pricing is enabled for the product.
  • allowDynamicProductPrice: Boolean!
  • # Languages in which product information can be entered.
  • availableLanguages: [Language]
  • # Alternate product name printed on the backup CD.
  • #
  • # Arguments
  • # languageIds: Array of relevant languageIds
  • backupCdAlternateNames(languageIds: [LanguageEnum]): [LocalizedString]
  • # Default language for localized product fields.
  • baseLanguage: Language
  • # Name and ID of the base product from which information is passed down to the
  • # product.
  • baseProduct: Product
  • # List of products that are packaged together.
  • bundleProducts: [ProductBundle]
  • # Client who offers the product for sale.
  • client: Client
  • # Content settings of the product.
  • contentSettings: ProductContentSettings
  • # User who created the product.
  • createdBy: UserAccount
  • # Date and time when the product was created.
  • creationDate: DateTime
  • # Default affiliate ID. Used to credit an affiliate for every purchase of this
  • # product.
  • defaultAffiliateId: String
  • # Default product selection of the product.
  • defaultProductSelection: ProductSelection
  • # Delivery settings of the product.
  • deliverySettings: ProductDeliverySettings
  • # Universal Product Code (UPC) or Article Numbering Code (EAN) for boxed products.
  • # Can be displayed to customers on checkout pages.
  • ean: String
  • # Indicates whether the product is excluded from being registered in third-party
  • # tracking systems such as Google Analytics or third-party affiliate management
  • # systems.
  • excludeFromTracking: Boolean!
  • # Unique ID of the product.
  • id: Int
  • # Internal product category for sorting products by a specific type or class.
  • internalCategory: String
  • # Internal ID of the product. Cross-references the purchases for this product with
  • # your own internal number.
  • internalId: String
  • # Internal name of the product. Cross-references the purchases for this product
  • # with your own internal product name.
  • internalName: String
  • # International Standard Book Number (ISBN) for boxed products. Can be displayed
  • # to customers on checkout pages.
  • isbn: String
  • # Indicates whether the product is dependent on the original product when it is
  • # added to the cart as a recommendation.
  • isDependentOnOriginalProduct: Boolean!
  • # User who last modified the product.
  • lastModifiedBy: UserAccount
  • # Date and time when the product was last modified.
  • lastModifyDate: DateTime
  • # License period by number of months. For internal information only.
  • licensePeriodInMonths: Int
  • # Maximum quantity that can be purchased for this product in an order.
  • maximumOrderQuantity: Int
  • # Minimum quantity that can be purchased for this product in an order.
  • minimumOrderQuantity: Int
  • # Name of the product. Displays to customers on checkout pages and in emails.
  • #
  • # Arguments
  • # languageIds: Array of relevant languageIds
  • names(languageIds: [LanguageEnum]): [LocalizedString]
  • # Equal number of licenses automatically generated for cross-sells and sub-sells
  • # when they are sold with products that have more than one license generated per
  • # product quantity purchased.
  • numberOfLicenses: Int
  • # List of operating systems for which the product is available. For internal
  • # information only.
  • operatingSystems: [OperatingSystem]
  • # List of operating systems for which the product is available. Can be displayed
  • # to customers on checkout pages.
  • #
  • # Arguments
  • # languageIds: Array of relevant languageIds
  • operatingSystemsTexts(languageIds: [LanguageEnum]): [LocalizedString]
  • # Price of the product.
  • price: PriceAbsolute
  • # Category of the product.
  • productCategory: ProductCategory
  • # Type of product offered for sale.
  • productType: ProductType
  • # Reporting group of the product.
  • reportingGroup: ProductGroup
  • # Shipping configuration for physical products.
  • shippingSet: ClientShippingset
  • # Status of the product. Determines how the product is used in the cleverbridge
  • # platform.
  • status: ProductStatus!
  • # Settings for subscription products.
  • subscriptionSettings: ProductSubscriptionSettings
  • # Support contact for the product. Displays to customers on checkout pages and in
  • # emails.
  • supportContact: SupportContact
  • # URL that downloads a demo version of the product for the customer. Can be
  • # displayed to customers on checkout pages.
  • #
  • # Arguments
  • # languageIds: Array of relevant languageIds
  • trialDownloadUrls(languageIds: [LanguageEnum]): [LocalizedString]
  • # User interface language in which the product is available. Can be displayed to
  • # customers on checkout pages.
  • #
  • # Arguments
  • # languageIds: Array of relevant languageIds
  • uiLanguages(languageIds: [LanguageEnum]): [LocalizedString]
  • # Version of the product. Can be displayed to customers on checkout pages.
  • #
  • # Arguments
  • # languageIds: Array of relevant languageIds
  • versions(languageIds: [LanguageEnum]): [LocalizedString]
  • }