Content Search API v1

📘

For more information on the Content Search feature and how to integrate it, refer to its guide here.

What's the difference between products and content?

Products are items on your site that a customer can purchase, while content includes non-product items such as knowledge-base articles or videos.

Run in Postman

Easily import the Discovery API collection and try the endpoints in Postman. It offers many examples of how the endpoints can be used for different use cases.

Follow this quick step-by-step guide to set up the environment and use the APIs: Postman Collections Welcome Kit

OpenAPI spec

The detailed OpenAPI specification for the Content Search API v1 can be found on GitHub:

Endpoints

Production: https://core.dxpapi.com/api/v1/core/?
Staging: https://staging-core.dxpapi.com/api/v1/core/?

Example request

GET https://core.dxpapi.com/api/v1/core/?
account_id=<Bloomreach Provided Account ID>
&auth_key=jazzhands
&domain_key=example_com 
&_br_uid_2=uid=7797686432023:v=11.5:ts=1428617911187:hc=55
&url=http://www.example.com/index.html?q=popcorn
&catalog_name=Recipes
&request_type=search #Value must be search for Content Search API
&search_type=keyword #Value must be keyword for Content Search API
&q=popcorn
&fl=item_id,item_title,thumb_image,url,description
&rows=10
&start=0

❗️

API requests should be limited to 16K Bytes. API requests above this length will throw Error Code 414 .