Skip to main content

orderlistCreate

Create a new order list for bulk ordering operations with comprehensive configuration.

Establishes a new order list with complete configuration including descriptions, product assignments, user permissions, company associations, and operational settings. The order list becomes immediately available for bulk ordering operations upon successful creation.

Creation process includes:

  • Validation of all input data and constraints
  • Verification of referenced products, clusters, users, and companies
  • Assignment of permissions and associations
  • Configuration of ordering behavior (positive/negative type)
  • Setting up validity periods and activation status

The newly created order list will be fully functional and accessible to assigned users and companies according to the specified configuration.

Possible errors:

  • ORDERLIST_VALIDATION_ERROR: Input data validation failed (invalid types, missing required fields, constraint violations)
  • ORDERLIST_CROSS_SERVICE_ERROR: Referenced entities don't exist (invalid product IDs, user IDs, company IDs, cluster IDs)
  • ORDERLIST_UKNOWN_ERROR: Unexpected system error during creation process
  • FORBIDDEN: Insufficient permissions to create order lists

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

orderlistCreate(
  input: OrderlistCreateInput!
): Orderlist!

Arguments​

orderlistCreate.input ● OrderlistCreateInput! non-null input​

Complete order list configuration data for creation.

Comprehensive input object containing all necessary information to create a functional order list:

  • Basic information (type, descriptions, code, validity dates)
  • Product and cluster assignments for ordering scope
  • User and company permissions for access control
  • Operational settings (active status, partner entity)
  • External system integrations (source references)

All fields are validated for correctness and consistency before creation. Referenced entities (products, users, companies, clusters) must exist in the system.

Validation: All input data is validated according to business rules and system constraints.

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.