Skip to main content

favoriteList

Retrieve detailed information about a specific favorite list.

Returns comprehensive favorite list data including items, metadata, and owner information. Used for favorite list management and item display in user interfaces.

Key Features:

  • Returns complete favorite list data structure
  • Includes all associated products and clusters
  • Provides ownership and metadata information
  • Supports real-time data access

Response Data:

  • Basic list information (name, slug, default status)
  • Owner association (company, contact, or customer - mutually exclusive)
  • Content arrays (product IDs and cluster IDs)
  • Timestamps (creation and last modification dates in ISO 8601 format)

Validation Constraints:

  • ID must be a valid MongoDB ObjectId format (24-character hexadecimal string)
  • Favorite list must exist in the system
  • User must have appropriate access permissions
  • ID cannot be null or empty

Performance Considerations:

  • Direct database lookup by primary key for optimal performance
  • Minimal data transfer with complete object structure
  • Suitable for real-time applications

Access is controlled by authentication and authorization rules based on the list's ownership and user permissions.

Possible Errors:

  • FAVORITE_LISTS_NOT_FOUND_ERROR: Favorite list with the specified ID does not exist
  • FAVORITE_LISTS_INVALID_INPUT_ERROR: Invalid ObjectId format provided
  • FAVORITE_LISTS_UNKNOWN_ERROR: Unexpected system error during retrieval

AUTH: Role=[system] OR ('user is authenticated')

favoriteList(
  id: String!
): FavoriteList!

Arguments​

favoriteList.id ● String! non-null scalar​

Unique identifier of the favorite list to retrieve.

Must be a valid MongoDB ObjectId string with length of 12 or 24 characters representing an existing favorite list. The ObjectId format is validated automatically and will return an error for invalid formats.

Validation Constraints:

  • Required field (cannot be null or empty)
  • Must be valid ObjectId format (hexadecimal string)
  • Must reference an existing favorite list in the system
  • Length must be exactly 24 characters (or 12 bytes in binary)
  • Must contain only hexadecimal characters (0-9, a-f, A-F)

Examples of Valid IDs:

  • 67d2a7d52dfe2a405d3bd5b9
  • 507f1f77bcf86cd799439011
  • 123456789012345678901234

Where to Find IDs:

  • Response from favoriteListCreate mutation
  • Results from favoriteLists search query
  • Database records or external system references

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.