Skip to main content

orderlist

Retrieve detailed information about a specific order list by its unique identifier.

Returns comprehensive order list data including product assignments, user permissions, company associations, and all configuration settings. Essential for order list management, bulk ordering operations, and administrative oversight.

The returned order list includes:

  • Basic information (ID, descriptions, code, dates)
  • Product and cluster assignments
  • User and company permissions
  • Configuration settings (type, active status, partner entity)

Possible errors:

  • ORDERLIST_NOT_FOUND_ERROR: Order list with the specified ID does not exist
  • ORDERLIST_CROSS_SERVICE_ERROR: Failed to validate related entities
  • ORDERLIST_UKNOWN_ERROR: Unexpected system error during retrieval
  • FORBIDDEN: Insufficient permissions to access order list data

AUTH: Role=[shop.OWNER,shop.EDITOR,shop.VIEWER] OR ('user is authenticated')

orderlist(
  id: Int!
): Orderlist!

Arguments​

orderlist.id ● Int! non-null scalar​

Unique identifier of the order list to retrieve.

Must be a valid positive integer representing an existing order list ID in the system. The ID is the primary key used to uniquely identify the order list across all operations.

Validation: Must be a positive integer, order list must exist and be accessible to the authenticated user.

Type​

Orderlist object​

Orderlist entity for GraphQL federation.

Represents a curated list of products and clusters that customers are authorized to view and purchase. Used for implementing customer-specific product catalogs, restricted access controls, and personalized product visibility.