Skip to main content

Algolia Component

You can integrate Commerce with Algolia using the Algolia component. This means you can synchronize Commerce data such as products, prices, images, categories, custom attributes, and variations with Algolia, giving you advanced searching capabilities.

Connections

You can find this information in the Settings, Teams and Access, API keys section on the Algolia Dashboard.

OptionDescription
App IDYour Application ID for your Algolia account.
Admin API keyYour Admin API Key for your Algolia account.

Actions

The component has the following actions.

Copy Index

InputTypeDescription
Application IDstringYour Application ID for your Algolia account.
Admin API KeystringYour Admin API Key for your Algolia account.
SourcestringThe sources from which to get the items to display.
TargetstringThe target Algolia index.
Scopes InputsstringThe scope, for example, exclude or include some users and groups, limit duration of a user's access and so on.

Copy Settings

InputTypeDescription
Application IDstringYour Application ID for your Algolia account.
Admin API KeystringYour Admin API Key for your Algolia account.
SourcestringThe sources from which to get the items to display.
TargetstringThe target Algolia index.

Get Indices Details

InputTypeDescription
Application IDstringYour Application ID for your Algolia account.
Admin API KeystringYour Admin API Key for your Algolia account.
Index NamestringYour Algolia index name.

Move Index

InputTypeDescription
Application IDstringYour Application ID for your Algolia account.
Admin API KeystringYour Admin API Key for your Algolia account.
SourcestringThe sources from which to get the items to display.
TargetstringThe target Algolia index.

Multi-batch Add/Update

InputTypeDescription
Application IDstringYour Application ID for your Algolia account.
Admin API KeystringYour Admin API Key for your Algolia account.
Batch ObjectstringThe objecs to add/update.

Replace All Objects

InputTypeDescription
Application IDstringYour Application ID for your Algolia account.
Admin API KeystringYour Admin API Key for your Algolia account.
SourcestringThe sources from which to get the items to display.
TargetstringThe target Algolia index.
Objects InputsstringThe objects to replace.