Skip to main content

Crossupsell

Cross-sell and upsell recommendation entity representing product relationship rules.

Defines recommendation relationships between products or product clusters to drive sales optimization. Each recommendation specifies a source (trigger) and target (suggested) product or cluster, along with the relationship type and optional categorization.

Supports both individual product recommendations and scalable cluster-based recommendations for comprehensive product relationship management.

type Crossupsell {
  id: String!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  type: CrossupsellType!
  subType: String
  productTo(
    hidden: Boolean
  ): IBaseProduct
  productFrom(
    hidden: Boolean
  ): IBaseProduct
  clusterTo(
    hidden: Boolean
  ): IBaseProduct
  clusterFrom(
    hidden: Boolean
  ): IBaseProduct
}

Fields​

Crossupsell.id ● String! non-null scalar​

Unique identifier for the cross-sell or upsell recommendation.

This UUID serves as the primary key for the recommendation and is automatically generated when a new recommendation is created. Used for referencing, updating, or deleting specific recommendations.

Crossupsell.createdAt ● DateTime! non-null scalar​

Timestamp when the recommendation was originally created.

Automatically set when a new cross-sell or upsell recommendation is first saved to the system. Used for tracking recommendation age, analyzing creation patterns, and filtering by creation timeframes.

Crossupsell.lastModifiedAt ● DateTime! non-null scalar​

Timestamp when the recommendation was last modified.

Automatically updated whenever any field of the recommendation is changed. Used for tracking recent updates, cache invalidation, and analyzing recommendation maintenance activity.

Crossupsell.type ● CrossupsellType! non-null enum​

The type of cross-sell or upsell recommendation relationship.

Defines the nature of the relationship between source and target products:

  • ACCESSORIES: Complementary products that enhance the main product
  • ALTERNATIVES: Substitute products for comparison or when main product unavailable
  • OPTIONS: Upgrades, variations, or enhanced versions of the main product
  • PARTS: Replacement components, spare parts, or consumables
  • RELATED: Products commonly purchased together with the main product

Crossupsell.subType ● String scalar​

Custom subtype classification for more granular categorization within the main recommendation type.

Provides additional context for recommendation logic and presentation. Examples include:

  • For ALTERNATIVES: "CHEAPER_ALTERNATIVE", "PREMIUM_ALTERNATIVE"
  • For ACCESSORIES: "ESSENTIAL", "OPTIONAL", "PREMIUM_ADDON"
  • For OPTIONS: "SIZE_VARIANT", "COLOR_VARIANT", "FEATURE_UPGRADE"

Maximum length: 64 characters

Crossupsell.productTo ● IBaseProduct interface​

Target product being recommended in the cross-upsell relationship.

Returns the complete product information for the product being suggested to customers. This is the product that will be recommended when customers view or purchase the source product.

Crossupsell.productTo.hidden ● Boolean scalar​

Include hidden products in the lookup.

When true, includes products marked as hidden in the search. When false or not specified, only returns visible products.

Crossupsell.productFrom ● IBaseProduct interface​

Source product that triggers the cross-upsell recommendation.

Returns the complete product information for the product that initiates this recommendation. When customers view or purchase this product, the target product will be suggested.

Crossupsell.productFrom.hidden ● Boolean scalar​

Include hidden products in the lookup.

When true, includes products marked as hidden in the search. When false or not specified, only returns visible products.

Crossupsell.clusterTo ● IBaseProduct interface​

Target cluster being recommended in the cross-upsell relationship.

Returns the complete cluster information for the cluster being suggested to customers. Products from this cluster will be recommended when customers view or purchase from the source cluster.

Crossupsell.clusterTo.hidden ● Boolean scalar​

Include hidden clusters in the lookup.

When true, includes clusters marked as hidden in the search. When false or not specified, only returns visible clusters.

Crossupsell.clusterFrom ● IBaseProduct interface​

Source cluster that triggers the cross-upsell recommendation.

Returns the complete cluster information for the cluster that initiates this recommendation. When customers view or purchase from this cluster, the target cluster will be suggested.

Crossupsell.clusterFrom.hidden ● Boolean scalar​

Include hidden clusters in the lookup.

When true, includes clusters marked as hidden in the search. When false or not specified, only returns visible clusters.

Returned By​

crossupsell query ● crossupsellCreate mutation ● crossupsellUpdate mutation

Member Of​

CrossupsellsResponse object