post https://discovery.bloomreach.com/dataconnect/api/v3/accounts//catalogs//environments//configs/LATEST
Programmatically modify the current catalog configuration to automate common tasks.
Note
The
datafield in the response object differs based on the type on Catalog. For product catalogs, you will only get theProductConfigurationpart, and for content catalogs, you will only get theContentConfigurationpart of the response.
Sample POST request
| POST | https://discovery.bloomreach.com/dataconnect/api/v3/accounts/{account_name}/catalogs/{catalog_name}/environments/{environment_name}/recordsThe catalog name is exactly the same as your domain key in your Search API requests, and points to where this information will be stored on the backend, represented with catalog name and language key. |
| Header | Authorization: Bearer <API key>Replace with your API key. |
| Request Body | A sample JSON request body is given below. The if_match_etag value determines the current catalog configuration. If the configuration object sent in the request body has any changes from the current configuration, the changes are saved and applied as a new configuration with a new etag. You can edit or add multiple attribute objects in the custom_attributes object at once. |
{
"meta": {
"if_match_etag": "c9c7b0817ac8638c2fefc68525cda58e"
},
"data": {
"config": {
"feed": {
"enable_feed_jobs": true
},
"index": {
"enable_index_jobs": true,
"enable_auto_indexing": false,
"search_docs_drop_threshold": 40,
"search_unavailable_docs": false
},
"variants": {
"sku_select": "off",
"enable_hero_sku_ranking": false,
"enable_filtering": false,
"ranking_attributes": \[],
"grouping_attribute": "",
"use_unavailable_variant_as_hero": true,
"search_document_variants_limit": -1
},
"custom_attributes_defaults": {
"facetable": "off",
"searchable": false
},
"custom_attributes": {
"brand": {
"level": "product",
"displayable": true,
"facetable": "manual",
"searchable": true,
"multi_valued": false,
"data_type": "text"
},
"category2": {
"level": "product",
"displayable": true,
"facetable": "auto",
"searchable": true,
"multi_valued": false,
"data_type": "text"
},
"hidden": {
"level": "product",
"displayable": true,
"facetable": "manual",
"searchable": false,
"multi_valued": false,
"data_type": "text"
}
},
"autosuggest": {
"product_attributes": {
"categories": "leaf_only",
"other_attributes": [
"title"
]
},
"minimum_character_count": 4,
"word_count_limit": 5,
"product_autosuggest": true,
"attribute_autosuggest": false,
"attribute_type": "brand",
"attribute_autosuggest_limit": 0
},
"core_attribute_searchability": {
"category_ids": true,
"category_names": true,
"product_ids": true,
"variant_ids": true
},
"reserved_attribute_searchability": {
"brand": true,
"capacity": true,
"catalog_code": true,
"color": true,
"color_group": true,
"depth": false,
"description": true,
"gender": false,
"height": false,
"item_no": true,
"keywords": true,
"model_no": true,
"price": false,
"reviews": false,
"sale_price": true,
"size": true,
"store_id": true,
"suite_info": true,
"title": true,
"width": false
}
}
}
}