Catalog Management SDK Integration

Product

Initializing the Product API object:

CmProductApi productApi = new CmProductApi.Builder()
     		.accountId("<ACCOUNT_ID>")
                .catalogName("<CATALOG_NAME>")
                .authorizationKey("<AUTHORIZATION_KEY>")
                .build();

Parameter	Description
accountId	Account ID provided by Bloomreach
catalogName	Catalog name
authorizationKey	Points to where this information will be stored on the backend represented with catalog name and language key. Use the same value as your domain key in your search API requests.
environment	Server environment to be execute the request against, STAGE or PROD
baseUrl	Base URL for a custom staging or performance testing environment
connectionTimeOut	Connection timeout in milliseconds
maxTotalConnections	Max total connections
responseTimeout	Connection timeout for getting a response

PUT

1. ** PUT request using a JSON String **

CatalogManagementResponse response = productApi.ingestPut(“<JSON_STRING>”);

if(response.getError() != null) {
// error
} else {
//  success
String jobId = response.getJobId();
 }

For more information on the format of the JSON String, please refer to the Format your Data (Product) page.

2. PUT request using an Object

// Create Attributes object
Attributes attributes = new Attributes();
attributes.setTitle("Title");
attributes.setUrl("example/url/path");

// Create View object
LinkedHashMap<String, Value> views = new LinkedHashMap<String,Value>();
Value valueForView = new Value();

Attributes attributesForView = new Attributes();
attributesForView.setTitle("Title");
attributesForView.setUrl("example/url/path");
valueForView.setAttributes(attributesForView);

views.put("view-key", valueForView);

// Create Value Object
Value value = new Value();
value.setAttributes(attributes);
value.addView("view-key",valueForView);

// Create CatalogManagementProductRequestItem and set Create Value to the item
CatalogManagementProductRequestItem item = new CatalogManagementProductRequestItem("add", "/products/ptr0921110", value);

// Create CatalogManagementProductRequest object and add CatalogManagementProductRequestItem
CatalogManagementProductRequest request = new CatalogManagementProductRequest();
request.add(item);
CatalogManagementResponse response = productApi.ingestPut(request);

if(response.getError() != null) {
// error
} else {
//  success
String jobId = response.getJobId();
 }

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

3. PUT request for an Array of File Paths

   (Refer SFTP Sample here.)

ArrayList<String> request = new ArrayList<>();
request.add("<catalog name>/<catalog1.jsonl>");
request.add("<catalog name>/<catalog2.jsonl>");

CatalogManagementResponse response = productApi.ingestPut(request);

if(response.getError() != null) {
// error
} else {
//  success
String jobId = response.getJobId();
 }

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

PATCH

1. PATCH request using a JSON String

CatalogManagementResponse response = productApi.ingestPatch(“<JSON_STRING>”);

if(response.getError() != null) {
// error
} else {
//  success
String jobId = response.getJobId();
 }

2. PATCH request using an Object

CatalogManagementResponse response = productApi.ingestPut(request);

if(response.getError() != null) {
// error
} else {
//  success
String jobId = response.getJobId();
}

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

3. PATCH request for an Array of File Paths

ArrayList<String> request = new ArrayList<>();
request.add("<catalog name>/<catalog1.jsonl>");
request.add("<catalog name>/<catalog2.jsonl>");

CatalogManagementResponse response = productApi.ingestPatch(request);

if(response.getError() != null) {
// error
} else {
//  success
String jobId = response.getJobId();
 }

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

INDEX

// Use the Job Id got from above methods
CatalogManagementResponse response = productApi.index(“<JOB_ID>”); 

if(response.getError() != null) {
// error
} else {
//  success
 }

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

STATUS

// Use the Job Id got from above methods
StatusResponse response = productApi.getStatus(“<JOB_ID>”);

if(response.getError() != null) {
// error
} else {
//  success
}

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

---

Content

Initializing the Content API object:

CmContentApi contentApi = new CmContentApi.Builder()
     		.accountId("<ACCOUNT_ID>")
           	.catalogName("<CATALOG_NAME>")
            	.authorizationKey("<AUTHORIZATION_KEY>")
            	.build();

Parameter	Description
accountId	Account ID provided by Bloomreach
catalogName	Catalog name
authorizationKey	Points to where this information will be stored on the backend represented with catalog name and language key. Use the same value as your domain key in your search API requests.
environment	Server environment to be execute the request against, STAGE or PROD
baseUrl	Base URL for a custom staging or performance testing environment
connectionTimeOut	Connection timeout in milliseconds
maxTotalConnections	Max total connections
responseTimeout	Connection timeout for getting a response

PUT

1. ** PUT request using a JSON String **

CatalogManagementResponse response = contentApi.ingestPut(jsonBody);

if(response.getError() != null) {
// error
} else {
//  success
 }

For more information on the format of the JSON String, please refer to the Format your Data (Product) page.

2. PUT request using an Object

// Create Attributes object

Attributes attributes = new Attributes();
attributes.setTitle("Title");
attributes.setUrl("example/url/path");

//Create Value Object

Value value = new Value();
value.setAttributes(attributes);
value.setViews(views);

 //Create CatalogManagementContentRequestItem and set Create Value to the item

CatalogManagementContentRequestItem item = new CatalogManagementContentRequestItem();
item.setOp("add");
item.setPath("/products/ptr0921110");
item.setValue(value);

// Create CatalogManagementContentRequest object and add 

CatalogManagementContentRequest request = new CatalogManagementContentRequest();
        request.add(item);

CatalogManagementResponse response = contentApi.ingestPut(request);

if(response.getError() != null) {
// error
} else {
//  success
}

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

3. PUT request for an Array of File Paths

ArrayList<String> request = new ArrayList<>();
request.add("<catalog name>/<catalog1.jsonl>");
request.add("<catalog name>/<catalog2.jsonl>");

CatalogManagementResponse response = contentApi.ingestPut(request);

if(response.getError() != null) {
// error
} else {
//  success
 }

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

PATCH

1. PATCH request using a JSON String

CatalogManagementResponse response = contentApi.ingestPatch(“<JSON_STRING>”);

if(response.getError() != null) {
// error
} else {
//  success
 }

2. PATCH request using an Object

CatalogManagementResponse response = contentApi.ingestPut(request);

if(response.getError() != null) {
// error
} else {
//  success
 }

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

3. PATCH request for an Array of File Paths

ArrayList<String> request = new ArrayList<>();
request.add("<catalog name>/<catalog1.jsonl>");
request.add("<catalog name>/<catalog2.jsonl>");

CatalogManagementResponse response = contentApi.ingestPatch(request);

if(response.getError() != null) {
// error
} else {
//  success
 }

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

INDEX

// Use the Job Id from above methods
CatalogManagementResponse response = contentApi.index(“<JOB_ID>”);

if(response.getError() != null) {
// error
} else {
//  success
}

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.

STATUS

// Use the Job Id got from above methods
StatusResponse response = contentApi.getStatus(“<JOB_ID>”);

if(response.getError() != null) {
// error
} else {
//  success

}

For more information on the underlying API call and the associated parameters, please refer to the related Catalog Management API page.