Einstein Recommendations code accepts several different parameters. To initiate an
API call, use HTTP or HTTPS to match the address prefix of the page on your site where the
call is made.
| Parameter |
Details |
| item |
This unique identifier for your product or content must match the
unique key in the catalog and the value sent in the trackPageView
collect item variable. This parameter is required for a product- or
content-based recommendation on any page. The unique identifier is the
product code: item=XXXXXX, where XXXXXX is the ProductCode. |
| search |
This pipe-delimited list contains search terms from your search page
and matches the value sent in the trackPageView collect search
variable. |
| category |
This pipe-delimited list of categories matches both the values sent
in the catalog feed and the value sent in the trackPageView collect
category variable. |
| cart |
This pipe-delimited list of products in the cart matches the
trackCart collect item variable. |
| wishlist |
This pipe-delimited list of products in the customer's wishlist must
match the trackWishlist collect items variable array. |
| email |
Use this parameter for faux-server-side, CloudPages, MobilePush,
FaceBook tab, or some mobile apps. Pass the email address of the profile
recommendation you want to access. The email value is the same value
passed to Collect. If this value is a SubscriberKey, pass the
SubscriberKey value. |
| user_id |
This parameter is used in testing or an advanced setup. It returns
the cookie value from the profile containing the recommendations you
want to access. |
| item_count |
Use this parameter to set the number of returned products or override
the returned products setting. |
| locale |
This five-character value indicates which localized content to
display. |
| exclusion |
Use this parameter to pass a pipe-delimited list of key-value pairs
to exclude: field_name_1|field_value|field_name_2|field_value. |
Calls No Longer Supported
| Parameter |
Details |
| cart_skus |
This pipe-delimited list of products in the cart matches the
trackCart collect unique_id variable. |
| with_root |
Deprecated in V2: When this parameter is set on a product or content
detail page, the first recommendation in each module is the product or
content the subscriber is accessing. The most common use for this value
is a recommendation, such as “People who bought <Root Product> also
bought <with_root recommendation>:” |
| do_not_record nolog |
This parameter instructs the system not to record the
recommendation. |
| inclusion |
Use this parameter to pass a list of product SKUs for
inclusion. |
