Skip to main content

FavoriteListsUpdateInput

No description

input FavoriteListsUpdateInput {
  productIds: [Int!]
  productSources: [SourceInput!]
  clusterIds: [Int!]
  clusterSources: [SourceInput!]
  isDefault: Boolean
  name: String
}

Fields​

FavoriteListsUpdateInput.productIds ● [Int!] list scalar​

Array of unique product identifiers to include in the favorite list.

Each ID must be a positive integer representing a valid product in the system. Duplicate values are automatically removed during processing. Cannot be used together with productSources in the same request.

Validation constraints:

  • Each ID must be a positive integer (minimum: 1)
  • Array must contain unique values only
  • Each ID must reference an existing product in the system
  • Cannot be combined with productSources in the same request

Use cases:

  • Adding products to shopping lists
  • Building product catalogs
  • Creating curated collections
  • Inventory management

FavoriteListsUpdateInput.productSources ● [SourceInput!] list input​

Array of product source identifiers for external system integration.

Use this when referencing products from external systems that are not directly managed in the internal catalog. Each source must contain a valid name and external ID combination. Cannot be used together with productIds in the same request - choose one approach.

Validation constraints:

  • Each source must have a valid name and id field
  • Array must contain unique combinations
  • Cannot be combined with productIds in the same request
  • Source names must match configured external systems

Use cases:

  • Integration with external product catalogs
  • Cross-platform product synchronization
  • Third-party marketplace integration

FavoriteListsUpdateInput.clusterIds ● [Int!] list scalar​

Array of unique cluster identifiers to include in the favorite list.

Each ID must be a positive integer representing a valid product cluster in the system. Duplicate values are automatically removed during processing. Cannot be used together with clusterSources in the same request.

Validation constraints:

  • Each ID must be a positive integer (minimum: 1)
  • Array must contain unique values only
  • Each ID must reference an existing cluster in the system
  • Cannot be combined with clusterSources in the same request

Use cases:

  • Bulk product management
  • Category-based organization
  • Hierarchical product grouping
  • Efficient inventory management

FavoriteListsUpdateInput.clusterSources ● [SourceInput!] list input​

Array of cluster source identifiers for external system integration.

Use this when referencing product clusters from external systems that are not directly managed in the internal catalog. Each source must contain a valid name and external ID combination. Cannot be used together with clusterIds in the same request - choose one approach.

Validation constraints:

  • Each source must have a valid name and id field
  • Array must contain unique combinations
  • Cannot be combined with clusterIds in the same request
  • Source names must match configured external systems

Use cases:

  • Integration with external cluster systems
  • Cross-platform cluster synchronization
  • Third-party category management

FavoriteListsUpdateInput.isDefault ● Boolean scalar​

Specifies whether this favorite list should be marked as a default list.

Default lists have special significance in the system and may be automatically selected or prioritized in user interfaces. Only one default list per owner is typically allowed, and setting this to true may affect other default lists.

Validation constraints:

  • Must be a boolean value (true or false)
  • Default value: false
  • Only one default list per owner is typically allowed

Use cases for default lists:

  • Primary shopping list for customers
  • Main product catalog for companies
  • Default collection for sales representatives

FavoriteListsUpdateInput.name ● String scalar​

A new descriptive name for the favorite list.

When updated, a new URL-friendly slug will be automatically generated. The name should be meaningful and help users identify the purpose of the list. Maximum length is 64 characters and must be unique within the owner's scope.

Member Of​

favoriteListUpdate mutation