CommerceSearchSettings Class

Get indexes. Get index logs. Create an index of a product catalog.

Namespace

ConnectApi

CommerceSearchSettings Methods

These methods are for CommerceSearchSettings. All methods are static.

createCommerceSearchIndex(webstoreId, indexBuildType)

Create an index of a product catalog.

API Version

57.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommerceSearchIndex createCommerceSearchIndex(String webstoreId, String indexBuildType)

Parameters

webstoreId
Type: String
ID of the webstore.
indexBuildType
Type: ConnectApi.CommerceSearchIndexBuildType
Build type of the index. Values are:
  • Full
  • Incremental

Return Value

Type: ConnectApi.CommerceSearchIndex

Usage

This method creates a live index that replaces the current live index. Any indexes that are in progress are removed when you manually create an index with this method.

getCommerceSearchIndex(webstoreId, indexId)

Get a Commerce search index.

API Version

52.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommerceSearchIndex getSingleCommerceSearchIndex(String webstoreId, String indexId)

Parameters

webstoreId
Type: String
ID of the webstore.
indexId
Type: String
ID of the index.

Return Value

Type: ConnectApi.CommerceSearchIndex

getCommerceSearchIndexes(webstoreId)

Get Commerce search indexes.

API Version

52.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommerceSearchIndexCollection getCommerceSearchIndexes(String webstoreId)

Parameters

webstoreId
Type: String
ID of the webstore.

getCommerceSearchIndexLogs(webstoreId)

Get Commerce search index logs.

API Version

57.0

Requires Chatter

No

Signature

public static ConnectApi.CommerceSearchIndexLogCollection getCommerceSearchIndexLogs(String webstoreId)

Parameters

webstoreId
Type: String
ID of the webstore.