GraphQL GraphQL OBJECT
Product

Item or service offered for sale.
Definition

type Product {
#   Unique ID of the product.
id: Int 
#   Billing terms configured for the product. Billing terms are also referred to as 
#   payment schedules.
billingTerms: [BillingTerm] 
#   Date and time when the product was created.
creationDate: DateTime 
#   Date and time when the product was last modified.
lastModifyDate: DateTime 
#   User who created the product.
createdBy: UserAccount! 
#   User who last modified the product.
lastModifiedBy: UserAccount! 
#   Client who offers the product for sale.
client: Client 
#   Type of product offered for sale.
productType: ProductType 
#   Status of the product. Determines how the product is used in the cleverbridge 
#   platform.
status: ProductStatus! 
#   Name and ID of the base product from which information is passed down to the 
#   product.
baseProduct: Product 
#   Category of the product.
productCategory: ProductCategory 
#   Name of the product. Displays to customers on checkout pages and in emails.
# 
# Arguments
#   languageIds: Array of relevant languageIds.
names(languageIds: [LanguageEnum]): [LocalizedString] 
#   Description of the product. Displays to customers on checkout pages and in 
#   emails.
# 
# Arguments
#   languageIds: Array of relevant languageIds.
additionalNameInformation(
languageIds: [LanguageEnum]
): [LocalizedString] 
#   Support contact for the product. Displays to customers on checkout pages and in 
#   emails.
supportContact: SupportContact 
#   Alternate product name printed on the backup CD.
# 
# Arguments
#   languageIds: Array of relevant languageIds.
backupCdAlternateNames(
languageIds: [LanguageEnum]
): [LocalizedString] @deprecated( reason: "Deprecated, please do not use this field. Starting December 2022, Cleverbridge no longer offers backup CD, DVD, or USB drive production and delivery through our offices."  )
#   Version of the product. Can be displayed to customers on checkout pages.
# 
# Arguments
#   languageIds: Array of relevant languageIds.
versions(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] 
#   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] 
#   Universal Product Code (UPC) or Article Numbering Code (EAN) for boxed products. 
#   Can be displayed to customers on checkout pages.
ean: String 
#   International Standard Book Number (ISBN) for boxed products. Can be displayed 
#   to customers on checkout pages.
isbn: String 
#   Default language for localized product fields.
baseLanguage: Language 
#   Languages in which product information can be entered.
availableLanguages: [Language] 
#   Default product selection of the product.
defaultProductSelection: ProductSelection 
#   Indicates whether the product is dependent on the original product when it is 
#   added to the cart as a recommendation.
isDependentOnOriginalProduct: Boolean! 
#   Default affiliate ID. Used to credit an affiliate for every purchase of this 
#   product.
defaultAffiliateId: String 
#   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 
#   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 
#   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] 
#   Reporting group of the product.
reportingGroup: ProductGroup 
#   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 
#   Internal product category for sorting products by a specific type or class.
internalCategory: 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! 
#   Price of the product.
price: PriceAbsolute 
#   Indicates whether dynamic product pricing is enabled for the product.
allowDynamicProductPrice: Boolean! 
#   Shipping configuration for physical products.
shippingSet: ClientShippingset 
#   Settings for subscription products.
subscriptionSettings: ProductSubscriptionSettings 
#   Content settings of the product.
contentSettings: ProductContentSettings 
#   Delivery settings of the product.
deliverySettings: ProductDeliverySettings 
#   List of products that are packaged together.
bundleProducts: [ProductBundle] 
#   How much revenue the promotion has generated for the client.
clientSalesRevenueStatistics: ClientSalesRevenueStatistics 
#   How many orders for the promoted product have been placed.
orderStatistics: OrderStatistics 
#   Referring product selections of the product.
referringProductSelections: [ProductSelection] 
#   Referring catalogs of the product.
referringCatalogs: [Catalog] 
#   Referring promotions of the product.
# 
# Arguments
#   paginationInput: Input for pagination. Maximum limit: 50
referringPromotions(
paginationInput: ReferringsPaginatedInput
): [Promotion] @deprecated( reason: "Deprecated, please use referringPromotionList instead."  )
#   Paginated referring promotions of the product.
# 
# Arguments
#   paginationInput: Input for pagination. Maximum limit: 50
referringPromotionList(
paginationInput: ReferringsPaginatedInput
): promotionReferringsResult 
#   Referring product lists of the product.
referringProductLists: [ProductList] 
#   Referring price configurations of the product.
referringPriceConfigurations: [PriceConfiguration] 
#   Referring recommendations of the product.
referringRecommendations: [Recommendation] 
#   Referring inheriting products of the queried product.
referringChildProducts: [Product] 
#   Referring bundle products of the queried product.
referringBundleProducts: [Product] 
#   Holds additional characteristics of the product as a localized string.
# 
# Arguments
#   languageIds: Array of relevant languageIds.
productFeatures(languageIds: [LanguageEnum]): [LocalizedString] 
}
Product

link Definition

link Required by

Definition

Required by
