Skip to main content

OrderlistCreateInput

No description

input OrderlistCreateInput {
  productIds: [Int!]
  productSources: [SourceInput!]
  clusterIds: [Int!]
  clusterSources: [SourceInput!]
  type: OrderlistType!
  descriptions: [LocalizedStringInput!]
  extras: [LocalizedStringInput!]
  code: String
  validFrom: String
  validTo: String
  userIds: [Int!]
  userSources: [SourceInput!]
  partnerEntity: String
  active: YesNo
  companyIds: [Int!]
  companySources: [SourceInput!]
}

Fields​

OrderlistCreateInput.productIds ● [Int!] list scalar​

Product identifiers to include in or remove from the order list.

Specify individual products that should be associated with this order list. These products will be available for bulk ordering operations.

Validation: Each ID must be a valid integer, array must contain unique values, products must exist in the system. Possible errors: ORDERLIST_CROSS_SERVICE_ERROR if product IDs don't exist.

OrderlistCreateInput.productSources ● [SourceInput!] list input​

External product sources to include in or remove from the order list.

Reference products from external systems using their source identifiers and system names. This allows integration with external product catalogs and inventory systems.

Validation: Each source must have valid id and name fields, array must contain unique combinations.

OrderlistCreateInput.clusterIds ● [Int!] list scalar​

Product cluster identifiers to include in or remove from the order list.

Clusters group related products together for convenient bulk ordering operations. Adding a cluster makes all products within that cluster available for ordering.

Validation: Each ID must be a valid integer, array must contain unique values, clusters must exist in the system. Possible errors: ORDERLIST_CROSS_SERVICE_ERROR if cluster IDs don't exist.

OrderlistCreateInput.clusterSources ● [SourceInput!] list input​

External cluster sources to include in or remove from the order list.

Reference product clusters from external systems using their source identifiers and system names. This allows integration with external categorization and clustering systems.

Validation: Each source must have valid id and name fields, array must contain unique combinations.

OrderlistCreateInput.type ● OrderlistType! non-null enum​

Order list behavior type that controls product visibility and ordering permissions for assigned users/companies.

POSITIVE: Users/companies assigned to this list can ONLY see and order the products included in the list. All other products are hidden from them. NEGATIVE: Users/companies assigned to this list CANNOT see or order the products included in the list. These products are hidden from them.

OrderlistCreateInput.descriptions ● [LocalizedStringInput!] list input​

Localized descriptions for the order list in multiple languages.

Provide clear, descriptive names that help users understand the purpose and contents of the order list. Each entry must have a unique language code.

Validation: Array must contain unique language codes, each description is validated for proper structure.

OrderlistCreateInput.extras ● [LocalizedStringInput!] list input​

Additional metadata or supplementary information in multiple languages.

Use for ordering instructions, special terms, category details, or other contextual information. Each entry must have a unique language code.

Validation: Array must contain unique language codes, each entry is validated for proper structure.

OrderlistCreateInput.code ● String scalar​

Unique reference code for easy identification and integration.

Use alphanumeric codes that are meaningful for your organization and external system integrations. This code can be used for reporting, API integrations, and user-friendly references.

Validation: No specific length restrictions, but should be meaningful and unique within your organization.

OrderlistCreateInput.validFrom ● String scalar​

Date and time when the order list becomes active and accessible to users.

Users cannot access or order from the list before this date. If not specified, the order list is immediately available upon creation.

Validation: Must be a valid ISO 8601 date-time string.

OrderlistCreateInput.validTo ● String scalar​

Date and time when the order list expires and becomes inaccessible to users.

Users cannot access or order from the list after this date. If not specified, the order list remains active indefinitely.

Validation: Must be a valid ISO 8601 date-time string and should be after validFrom if both are specified.

OrderlistCreateInput.userIds ● [Int!] list scalar​

User identifiers who are authorized to access and order from this list.

Specify individual users who should have permission to view and order from this order list. These users will be able to see the order list in their available ordering options.

Validation: Each ID must be a valid integer, array must contain unique values, users must exist in the system. Possible errors: ORDERLIST_CROSS_SERVICE_ERROR if user IDs don't exist.

OrderlistCreateInput.userSources ● [SourceInput!] list input​

External user sources who are authorized to access this order list.

Reference users from external systems using their source identifiers and system names. This allows integration with external user management systems.

Validation: Each source must have valid id and name fields, array must contain unique combinations.

OrderlistCreateInput.partnerEntity ● String scalar​

Associated partner or organizational entity responsible for this order list.

Specify the business partner, department, or organizational unit that manages this order list. This helps with organization, reporting, and responsibility tracking.

Validation: No specific restrictions, but should be meaningful for organizational purposes.

OrderlistCreateInput.active ● YesNo enum​

Order list availability status that controls user access.

Y (Yes): Order list is active and accessible to assigned users. N (No): Order list is inactive and not accessible for ordering.

Defaults to Y (active) if not specified.

Validation: Must be either Y or N.

OrderlistCreateInput.companyIds ● [Int!] list scalar​

Company identifiers that are authorized to access and order from this list.

Specify which companies should have permission to view and order from this order list. These companies will be able to see the order list in their available ordering options.

Validation: Each ID must be a valid integer, array must contain unique values, companies must exist in the system. Possible errors: ORDERLIST_CROSS_SERVICE_ERROR if company IDs don't exist.

OrderlistCreateInput.companySources ● [SourceInput!] list input​

External company sources that are authorized to access this order list.

Reference companies from external systems using their source identifiers and system names. This allows integration with external company management systems.

Validation: Each source must have valid id and name fields, array must contain unique combinations.

Member Of​

orderlistCreate mutation