Documentation
All Release Notes
Introduced Business Unit Search in beta
20 December 2024
Composable Commerce
HTTP API
New feature
B2BCustomersGraphQL

The new Business Unit Search API allows merchants to search across a large number of Business Unit within a Project with improved performance and enhanced query capabilities. The API is intended for back-office use cases, not for searching business unit data in a storefront application. The API must be activated for the Project before it can be used.

Changes:

The following changes were introduced in terms of GraphQL SDL:

extend type SearchIndexingConfiguration {
  "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
  businessUnits: BusinessUnitSearchConfiguration
}

extend input ProjectSettingsUpdateAction {
  "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
  changeBusinessUnitSearchStatus: ChangeProjectSettingsBusinessUnitSearchStatus
}

"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
type BusinessUnitSearchConfiguration {
  status: BusinessUnitSearchStatus!
  lastModifiedAt: DateTime!
  lastModifiedBy: Initiator
}

"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
enum BusinessUnitSearchStatus {
  Activated
  Deactivated
}

"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
input ChangeProjectSettingsBusinessUnitSearchStatus {
  status: BusinessUnitSearchStatus!
}