Skip to main content

favoriteListCreate

Create a new favorite list for a customer or contact.

Establishes a new favorite list with name and owner association. The list will be available for adding products and clusters immediately after creation.

Creation process includes:

  • Name validation and uniqueness checking within owner scope
  • Automatic slug generation from the provided name
  • Owner association validation (company, contact, or customer - mutually exclusive)
  • Initial content setup (products and clusters if provided)
  • Default status configuration

The created list is immediately available for item management operations and can be retrieved through search or direct access.

Validation constraints:

  • Name is required with maximum length of 64 characters
  • Only one ownership type allowed (company OR contact OR customer)
  • Product and cluster IDs must reference existing entities
  • Array fields must contain unique values
  • External source references must have valid name and ID format

Possible errors:

  • FAVORITE_LISTS_CREATE_ERROR: Failed to create the favorite list due to system error
  • FAVORITE_LISTS_INVALID_INPUT_ERROR: Favorite list data validation failed or invalid input format
  • FAVORITE_LISTS_UNKNOWN_ERROR: Unexpected system error during creation

AUTH: Role=[shop.OWNER] OR (('user is authenticated') AND ('undefined'))

favoriteListCreate(
  input: FavoriteListsCreateInput!
): FavoriteList!

Arguments​

favoriteListCreate.input ● FavoriteListsCreateInput! non-null input​

Favorite list creation data including name and owner information.

Contains all necessary information to create a functional favorite list including owner association and initial configuration.

Required fields:

  • name: Descriptive name for the list (maximum 64 characters)

Optional fields:

  • Owner association: One of company, contact, or customer (ID or source format)
  • Content: Initial products and/or clusters (ID or source format)
  • isDefault: Whether this should be marked as a default list

Validation rules:

  • Name cannot be empty and must be unique within the owner's scope
  • Only one ownership type can be specified
  • All referenced entities (products, clusters, owners) must exist
  • Array fields automatically remove duplicates

Type​

FavoriteList object​

Favorite list entity for GraphQL federation.

Represents a customer's favorite list containing saved products and clusters for easy access and future purchasing. Used for managing customer preferences and providing personalized shopping experiences across federated services.