Orderlist

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.

type Orderlist {
  id: Int!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  descriptions: [LocalizedString!]!
  extras: [LocalizedString!]
  code: String
  validFrom: DateTime
  validTo: DateTime
  type: OrderlistType!
  partnerEntity: String
  active: YesNo!
  products(
    input: ProductSearchInput
  ): ProductsResponse
  clusters(
    input: ProductSearchInput
  ): ProductsResponse
  users: [IBaseUser!]! @deprecated
  usersPaginated(
    input: OrderlistUserSearchInput
  ): UsersResponse!
  companies: [Company!]! @deprecated
  companiesPaginated(
    input: OrderlistCompanySearchInput
  ): CompaniesResponse!
}

Fields

Orderlist.id ● Int! non-null scalar

Unique system-generated identifier for the order list.

This primary key is used for all order list operations, references, and relationships. It remains constant throughout the order list's lifecycle.

Orderlist.createdAt ● DateTime! non-null scalar

Timestamp when the order list was first created in the system.

This date is automatically set when the order list is created and never changes. Useful for tracking order list age and creation patterns.

Orderlist.lastModifiedAt ● DateTime! non-null scalar

Timestamp when the order list was last modified.

This date is automatically updated whenever any property of the order list changes. Useful for tracking recent changes and synchronization purposes.

Orderlist.descriptions ● [LocalizedString!]! non-null object

Localized descriptions of the order list in multiple languages.

Each entry contains a language code and corresponding description text. Provides clear, descriptive names that help users understand the purpose and contents of the order list. Essential for international organizations with multi-language support requirements.

Orderlist.extras ● [LocalizedString!] list object

Additional metadata or supplementary information in multiple languages.

Use for ordering instructions, special terms, category details, discount information, or other contextual data. Each entry contains a language code and corresponding text value. Helps provide comprehensive information to users in their preferred language.

Orderlist.code ● String scalar

Unique reference code for easy identification and integration.

Alphanumeric identifier that provides a user-friendly way to reference the order list. Useful for reporting, API integrations, and human-readable references. Maximum length of 64 characters.

Orderlist.validFrom ● DateTime scalar

Date and time when this order list automatically becomes effective and starts enforcing its product restrictions.

Before this date:

• Assigned users/companies maintain their default product visibility and ordering permissions
• The order list configuration and user assignments exist but are not enforced
• Similar to setting active=N, but activation happens automatically at the specified time

If not specified, the order list rules are enforced immediately upon creation (if active=Y).

Useful for scheduling future product access changes such as new catalog launches, contract start dates, or planned promotional periods.

Orderlist.validTo ● DateTime scalar

Date and time when this order list automatically expires and stops enforcing its product restrictions.

After expiration:

• Assigned users/companies revert to their default product visibility and ordering permissions
• The order list configuration and user assignments are preserved but not enforced
• Similar to setting active=N, but happens automatically at the specified time

If not specified, the order list remains enforceable indefinitely (controlled only by the active field).

Useful for time-limited product access such as promotional periods, seasonal catalogs, or temporary supplier agreements.

Orderlist.type ● OrderlistType! non-null enum

Order list behavior type that determines how products are handled.

POSITIVE: Include only specified products for ordering - users can order from products explicitly added to this list. NEGATIVE: Exclude specified products from ordering - users can order from all products except those explicitly added to this list.

This fundamental property determines the order list's filtering behavior in bulk ordering operations.

Orderlist.partnerEntity ● String scalar

Associated partner or organizational entity responsible for this order list.

Identifies the business partner, department, or organizational unit that manages this order list. Helps with organization, reporting, responsibility tracking, and access control. Useful for multi-partner or multi-department environments.

Orderlist.active ● YesNo! non-null enum

Activation status that controls whether this order list's rules are currently enforced.

Y (Yes): Order list rules are active. Assigned users/companies are subject to the product visibility and ordering restrictions defined by this list. N (No): Order list rules are suspended. Assigned users/companies revert to their default product access as if they were not assigned to this list.

Useful for temporarily disabling restrictions without losing the list configuration or user assignments (e.g., seasonal promotions, maintenance periods, testing).

Orderlist.products ● ProductsResponse object

Paginated collection of products in this orderlist.

Complete product information for all products included in this orderlist, with pagination, filtering, and search capabilities.

Orderlist.products.input ● ProductSearchInput input

Orderlist.clusters ● ProductsResponse object

Paginated collection of clusters in this orderlist.

Complete cluster information for all clusters included in this orderlist, with pagination, filtering, and search capabilities.

Orderlist.clusters.input ● ProductSearchInput input

Orderlist.users ● [IBaseUser!]! deprecated non-null interface

DEPRECATED

Use usersPaginated.

Use usersPaginated.

Orderlist.usersPaginated ● UsersResponse! non-null object

Orderlist.usersPaginated.input ● OrderlistUserSearchInput input

Orderlist.companies ● [Company!]! deprecated non-null object

DEPRECATED

Use companiesPaginated.

Use companiesPaginated.

Orderlist.companiesPaginated ● CompaniesResponse! non-null object

Orderlist.companiesPaginated.input ● OrderlistCompanySearchInput input

Returned By

orderlist query ● orderlistAddItems mutation ● orderlistAssignCompanies mutation ● orderlistAssignUsers mutation ● orderlistCreate mutation ● orderlistRemoveItems mutation ● orderlistUnassignCompanies mutation ● orderlistUnassignUsers mutation ● orderlistUpdate mutation

Member Of

OrderlistsResponse object