GraphQL GraphQL OBJECT

Recommendation

Product suggestion for customers during the checkout process.

link Definition

  • type Recommendation {
  • # Unique ID of the recommendation.
  • id: Int!
  • # Date and time when the recommendation was created.
  • creationDate: DateTime
  • # User who created the recommendation.
  • createdBy: UserAccount!
  • # Date and time when the last edit occurred.
  • lastModifyDate: DateTime
  • # User who last edited the recommendation.
  • lastModifiedBy: UserAccount!
  • # Name of the recommendation.
  • name: String
  • # Indicates whether the recommendation is active.
  • isActive: Boolean!
  • # First date and time in which the recommendation is valid.
  • validFrom: DateTime
  • # Last date and time in which the recommendation is valid.
  • validTo: DateTime
  • # Controls whether or not the recommendation displays in the cart.
  • parameter: RecommendationParameter
  • # Client who offers the recommended product for sale.
  • client: Client
  • # Client who owns the recommended product.
  • relatedClient: Client
  • # Controls how customers are given the choice of purchasing or not purchasing a
  • # cross-sell or a sub-sell.
  • optionType: RecommendationOptionType
  • # Determines where the recommendation displays in the checkout process.
  • positionType: RecommendationPositionType
  • # Determines how the quantity of the recommendation is adjusted based on the
  • # quantity of the original product it is being recommended with.
  • quantityLimit: RecommendationQuantityLimit
  • # Products that initiate the recommendation. When a customer adds the product to
  • # the cart, the recommendation is triggered.
  • originalProducts: [Product]
  • # Products that are recommended when the recommendation is triggered.
  • recommendedProducts: [RecommendedProduct]
  • # Options to limit the discount and to specify a pricing model.
  • discount: PriceSettingsInterface
  • # Whether the recommendation is a cross-sell, sub-sell, or up-sell.
  • type: RecommendationType
  • # List of price configurations that limit the recommendation.
  • priceConfigurationList: PriceConfigurationList
  • # Which template controls how the recommendation looks. The template is designed
  • # by either cleverbridge or you.
  • template: Template
  • # Indicates whether the recommendation is currently active and valid.
  • isActiveAndValid: Boolean
  • # How much revenue the recommendation has generated for the client.
  • clientSalesRevenueStatistics: ClientSalesRevenueStatistics
  • # How many orders for the recommended product have been placed.
  • orderStatistics: OrderStatistics
  • # How many licenses for the recommended product the client has sold.
  • licenseStatistics: LicenseStatistics
  • # Example URLs that let you preview the recommendation.
  • sampleUrls: SampleUrls
  • # Indicates if this recommendation is applied to the original products.
  • applyRecommendationToOriginalProducts: Boolean
  • }