GraphQL OBJECT
Product
Item or service offered for sale.
link Definition
- type Product {
- #   Unique ID of the product.
- : Int 
- #   Billing terms configured for the product. Billing terms are also referred to as 
- #   payment schedules.
- : [BillingTerm] 
- #   Date and time when the product was created.
- : DateTime 
- #   Date and time when the product was last modified.
- : DateTime 
- #   User who created the product.
- : UserAccount! 
- #   User who last modified the product.
- : UserAccount! 
- #   Client who offers the product for sale.
- : Client 
- #   Type of product offered for sale.
- : ProductType 
- #   Status of the product. Determines how the product is used in the cleverbridge 
- #   platform.
- : ProductStatus! 
- #   Name and ID of the base product from which information is passed down to the 
- #   product.
- : Product 
- #   Category of the product.
- : ProductCategory 
- #   Name of the product. Displays to customers on checkout pages and in emails.
- # 
- # Arguments
- #   languageIds: Array of relevant languageIds.
- (: [LanguageEnum]): [LocalizedString] 
- #   Description of the product. Displays to customers on checkout pages and in 
- #   emails.
- # 
- # Arguments
- #   languageIds: Array of relevant languageIds.
- (
- : [LanguageEnum]
- ): [LocalizedString] 
- #   Support contact for the product. Displays to customers on checkout pages and in 
- #   emails.
- : SupportContact 
- #   Alternate product name printed on the backup CD.
- # 
- # Arguments
- #   languageIds: Array of relevant 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.
- (: [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.
- (: [LanguageEnum]): [LocalizedString] 
- #   List of operating systems for which the product is available. For internal 
- #   information only.
- : [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.
- (: [LanguageEnum]): [LocalizedString] 
- #   Universal Product Code (UPC) or Article Numbering Code (EAN) for boxed products. 
- #   Can be displayed to customers on checkout pages.
- : String 
- #   International Standard Book Number (ISBN) for boxed products. Can be displayed 
- #   to customers on checkout pages.
- : String 
- #   Default language for localized product fields.
- : Language 
- #   Languages in which product information can be entered.
- : [Language] 
- #   Default product selection of the product.
- : ProductSelection 
- #   Indicates whether the product is dependent on the original product when it is 
- #   added to the cart as a recommendation.
- : Boolean! 
- #   Default affiliate ID. Used to credit an affiliate for every purchase of this 
- #   product.
- : 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.
- : Int 
- #   License period by number of months. For internal information only.
- : Int 
- #   Maximum quantity that can be purchased for this product in an order.
- : Int 
- #   Minimum quantity that can be purchased for this product in an order.
- : 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.
- (: [LanguageEnum]): [LocalizedString] 
- #   Reporting group of the product.
- : ProductGroup 
- #   Internal ID of the product. Cross-references the purchases for this product with 
- #   your own internal number.
- : String 
- #   Internal name of the product. Cross-references the purchases for this product 
- #   with your own internal product name.
- : String 
- #   Internal product category for sorting products by a specific type or class.
- : 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.
- : Boolean! 
- #   Price of the product.
- : PriceAbsolute 
- #   Indicates whether dynamic product pricing is enabled for the product.
- : Boolean! 
- #   Shipping configuration for physical products.
- : ClientShippingset @deprecated( reason: "Obsolete field, please use field 'shippingConfiguration' instead."  )
- #   Shipping configuration for physical products.
- : ShippingConfiguration 
- #   Settings for subscription products.
- : ProductSubscriptionSettings 
- #   Content settings of the product.
- : ProductContentSettings 
- #   Delivery settings of the product.
- : ProductDeliverySettings 
- #   List of products that are packaged together.
- : [ProductBundle] 
- #   How much revenue the promotion has generated for the client.
- : ClientSalesRevenueStatistics 
- #   How many orders for the promoted product have been placed.
- : OrderStatistics 
- #   Referring product selections of the product.
- : [ProductSelection] 
- #   Referring catalogs of the product.
- : [Catalog] 
- #   Referring promotions of the product.
- # 
- # Arguments
- #   paginationInput: Input for pagination. Maximum limit: 50
- (
- : ReferringsPaginatedInput
- ): [Promotion] @deprecated( reason: "Deprecated, please use referringPromotionList instead."  )
- #   Paginated referring promotions of the product.
- # 
- # Arguments
- #   paginationInput: Input for pagination. Maximum limit: 50
- (
- : ReferringsPaginatedInput
- ): promotionReferringsResult 
- #   Referring product lists of the product.
- : [ProductList] 
- #   Referring price configurations of the product.
- : [PriceConfiguration] 
- #   Referring recommendations of the product.
- : [Recommendation] 
- #   Referring inheriting products of the queried product.
- : [Product] 
- #   Referring bundle products of the queried product.
- : [Product] 
- #   Holds additional characteristics of the product as a localized string.
- # 
- # Arguments
- #   languageIds: Array of relevant languageIds.
- (: [LanguageEnum]): [LocalizedString] 
- }
link Required by
- BackupMediumJobOne backup medium job related to the purchase item.
- CatalogItemItem in the catalog.
- CreateProductPayloadPayload for created product.
- FollowUpReminder about open product and purchase issues.
- PriceConfigurationItemnull
- PriceConfigurationProductItemnull
- ProductItem or service offered for sale.
- ProductBundleBundle including several products. A bundle is a combination of two or more products sold together at a specific price.
- ProductDeliverynull
- ProductFileProduct file.
- ProductFileSearchResultItemProduct file that matches the search parameters.
- ProductListProduct list for which the notification applies.
- ProductSearchResultnull
- ProductSelectionProduct selection for a product variation. Product selections are used to assign a product to one or more product characteristics.
- ProductSelectionItemItem in the product selection.
- ProductSubscriptionSettingsSettings for subscription products.
- PromotionProductListList of promoted products.
- querynull
- RecommendationProduct suggestion for customers during the checkout process.
- RecommendedProductnull
- ShippingConfigurationShipping configuration you specify for a given product.
- SupportContactSupport contact for the product/client. Displays to customers on checkout pages and in emails.
- UpdateProductPayloadPayload for product update.
- WebFileReusable, localizable web file.
- WebFileSearchResultItemWeb file that matches the search parameters.