Parameters for the MLT API

Example request

Here’s an example API call for an MLT query, using the product ID, 1000065194:

GET http://core.dxpapi.com/api/v1/core/?
account_id=<Bloomreach Provided Account ID>
&domain_key=example_com
&request_id=8438674518839
&url=test
&request_type=mlt
&rows=5
&start=0
&pid=1000065194
&title=Boys Graphic Tee
&fl=pid,title

The parameter,  pid, in the API call is the product that the MLT suggestions are based on.

All of the parameters in the example call are required parameters for all MLT calls. Your own MLT calls might include optional parameters, but must always include these parameters, too. As a More Like This query, the request_type parameter must be defined with the specific setting, mlt.

Example response

{
 "response": {
 
   "numFound": 284,
   "start": 0,
   "docs": [
 
     {
 
       "pid": "1000068980",
       "title": "Strapless Tea Length Lace Dress with Sweetheart Neckline"
     }
,
     {
 
       "pid": "1000063663",
       "title": "Sleeveless Short Prom Dress with Illusion Lace and Pleated Skirt"
     }
,
     {
 
       "pid": "1000065223",
       "title": "Short Lace Prom Dress with Pleated Illusion Neckline"
     }
,
     {
 
       "pid": "1000063668",
       "title": "Two Tone Short Prom Dress with Scalloped Lace Illusion Bodice"
     }
,
     {
 
       "pid": "1000064025",
       "title": "Glitter Short Prom Dress with Spaghetti Straps and Lace Waist"
 ]
 
}

Quick reference: request parameters

This table provides a list of each parameter and a description. A yes flag in the Required column indicates that the parameter is required for all MLT calls, not some.

Detailed reference: request parameters

Some of the request parameters need a little more explanation than others. You can find this extra information here.

domain_key parameter

The Bloomreach-provided ID of the domain receiving the request. This parameter identifies the specific site version when the one account ID hosts multiple site versions with unique characteristics, such as language versions. Bloomreach uses your domain_key parameter value to ensure that only the data that pertains to that site version is used for query and analytics features, such as autosuggestions.

fl parameter

The fl parameter is a comma-separated list of fields returned with MLT results, such as the name of products and prices. The following list is representative of the fields that you can use, but it isn't exhaustive. Your list depends on the values in your product feed.

• PID is the product ID

• Title is the title or name of the product

• URL is the URL of the product description page

• price is the price of the product

• sale_price is the price of the product on sale

• sku_swatch_image is a thumbnail image for a particular sku variation of a product

 fq parameter

The fq parameter applies a faceted filter to the returned products, searching for products that fit your parameter values. Any facet that you want to filter must be in your product feed.

Read more about using fq parameter in the Faceting and filtering page. 

request_id Parameter

The request_id parameter value is a random 12 or 13-digit ID that you supply to enable click-tracking. Bloomreach doesn't automatically enforce the requirements for this parameter. For example, you can enter  test  as your value for each instance of the request_id parameter without triggering an error message. However, if you don't use a unique value, then Bloomreach can't help you with potential problems you might experience while using the API.

Sort Parameter

The sort parameter sorts results based on the field value in ascending, descending, or another combination of orders. You can sort any fl field. Some examples are given below:

• sale_price desc sorts in descending order of the sale price

• sale_price asc sorts in ascending order of the sale price

• price_desc sorts in descending order of the price

• price_asc sorts in ascending order of the price

• launch_date desc sorts in descending order of the date on which products launched

• launch_date asc sorts in descending order of the date on which products launched

user_id Parameter

The user_id parameter is a universal customer ID of a user. The parameter captures user IDs from the customer side, and reuses the information when powering apps or enhancing cross-device linking. In this way, Commerce Search and Categories recognizes users in a way that's aligned with your system. Use an anonymous string. Don't use email or other personally identifiable information. If you do not track users this way, then omit this field.

view_id Parameter

The view_id parameter is a unique identifier for a specific view of your product catalog. If you have multiple versions of your site, each with their own product catalog characteristics like product titles and prices, then add view_id to your call. Bloomreach uses your view_id parameter value to display the right product information for your customers based on their individual site views.

You can enter any string value to identify the specific site catalog view. This string must be consistent in your pixel, API, and product catalog. For example, Abacus Thinking sells different academic products to different grade levels. A first grade teacher looks in their Kindergarten through Grade 3 catalog, which Abacus Thinking assigns the ID, k-3:

Consistent, valid values

Your view_id values must be the same in your API, pixel, and product catalog. If Abacus Thinking assigns the value, kindergarten-3rd, to the view_id parameter in their product feed, then the API value, k-3, doesn't match any catalog view.

Quick reference: response parameters