Step 3: Update the Index (Beta)

After sending your catalog data, you must call the index API to inform Bloomreach about the new catalog data and to index that catalog.

If this is the first time you are delivering the data or if you have added new attributes, you can first configure your attributes before calling the index API.

Update the index

Generate and publish index for catalog:

This will return a Job ID that can be used to query for status.

{"jobId":"130852d8-d0bb-4073-9e4d-2dd5f32f2022"}

After this job is successful, your catalog item data will be available to query in the Product Search API endpoint after Bloomreach caches have cleared. This may be anywhere from 1-5 minutes.

Index updates more frequent than every 15 minutes may be rate limited.

Catalog and Job Management

List Job Status for a Job ID.

This will return information about the specific ingestion job, including its status.

{
  "account_id": 9999,
  "attempts": 0,
  "created_at": "1586911454615",
  "started_at": "1586911525950",
  "status": "success",
  "stopped_at": "1586911530597",
  "message": "",
  "error_code": ""
  }
}

For now, only the status, started_at, stopped_at properties should be considered stable.

Values for status property:

• creating

• queued

• running

• success

• failed

• skipped

• killed

Values in bold are the ones that will typically be encountered.