Step 4: Publish the Index - Bloomreach Experience - The Headless Digital Experience Platform Built for Commerce

Step 4: Publish the Index

 

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.

Publish the index

Generate and publish index for catalog:

POST

https://api.connect.bloomreach.com/dataconnect/api/v1/accounts/{account ID}/catalogs/{catalog name}/indexes

Header

Authorization

Bearer {API key}

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. 

Catalog and Job Management

List Job Status for a Job ID.

GET

https://api.connect.bloomreach.com/dataconnect/api/v1/jobs/{job ID}

Header

Authorization

Bearer {API key}

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

{
  "account_id": 9999,
  "catalog_name": "homeoasis_en",
  "created_at": "2021-04-28T13:19:02.000303Z",
  "id": "0e4ccde6-5688-47f5-ba9b-b6ffcdb1010b",
  "started_at": "2021-04-28T13:19:05.000302Z",
  "status": "success", //Possible values: creating, queued, running, failed, skipped, killed
  "stopped_at": "2021-04-28T13:20:22.000204Z",
  "type": "index update" //Possible values: ingest delta, ingest full, index update
}

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.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?