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 24-character hexadecimal id or a UUID
  • 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: Malformed identifier provided
  • FAVORITE_LISTS_UNKNOWN_ERROR: Unexpected system error during retrieval

AUTH: Role=[shop.OWNER,shop.EDITOR,shop.VIEWER] 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 the identifier of an existing favorite list. Two formats are accepted and both remain valid: a 24-character hexadecimal id (lists created before the PostgreSQL migration) or a UUID (lists created after it). The format is validated automatically and will return an error for anything else.

Validation Constraints:

  • Required field (cannot be null or empty)
  • Must be a 24-character hexadecimal id or a UUID
  • Must reference an existing favorite list in the system
  • Must be treated as opaque: do not parse it or derive a creation time from it

Examples of Valid IDs:

  • 67d2a7d52dfe2a405d3bd5b9
  • 0192f3a1-4b2c-7d8e-9f01-23456789abcd

Where to Find IDs:

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

Type​

FavoriteList object​