Customer Search achieved general availability status | HTTP API

Customer Search achieved general availability status

1 October 2024

Composable Commerce

HTTP API

Announcement

CustomersSearchGraphQL

After collecting feedback during the beta phase, we have moved the Customer Search API out of beta into general availability.

The Customer Search API offers improved performance and enhanced query capabilities, supporting Projects with a large number of Customers. In addition to the Merchant Center, the feature is also intended to support other back-office applications you use. It is not intended for searching through customers in a storefront.

Changes:

[API] Added customers field to SearchIndexingConfiguration on Projects.
[API] Added the SearchNotReady error code.
[GraphQL API] Added the following types to the GraphQL schema: ChangeProjectSettingsCustomerSearchStatus, CustomerSearchConfiguration, CustomerSearchStatus.
[GraphQL API] Added the changeCustomerSearchStatus input field to the ProjectSettingsUpdateAction type.
[GraphQL API] Added the customers field to the SearchIndexingConfiguration type.

The following changes were introduced in terms of GraphQL SDL:

extend type SearchIndexingConfiguration {
  customers: CustomerSearchConfiguration
}

extend input ProjectSettingsUpdateAction {
  changeCustomerSearchStatus: ChangeProjectSettingsCustomerSearchStatus
}

input ChangeProjectSettingsCustomerSearchStatus {
  status: CustomerSearchStatus!
}

type CustomerSearchConfiguration {
  status: CustomerSearchStatus!
  lastModifiedAt: DateTime!
  lastModifiedBy: Initiator
}

enum CustomerSearchStatus {
  Activated
  Deactivated
}