We have launched our new documentation. Please head here to read it.

Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

  • Prepare your Schema
  • Prepare your Catalog
  • Upload your Feed

  • Full Feed Upload
  • Delta Feed Upload
  • Single Record Upload
  • Check Product Count

  • Events
  • Browser Integration

  • Introduction to GTM
  • Requirements

  • Introduction
  • Events
  • API Integration

  • Recommendations Endpoint
  • Authentication
  • Header
  • Request Parameter
  • Response Components
  • Explanation Request Parameter

  • Quick Integration
  • Installation
  • Fetch Recommendation Results
  • Default Unbxd Template
  • Custom Template
  • Unbxd Template Customization
  • Custom Feature Examples

  • Quick Integration
  • Installation
  • Fetch Recommendation Results

  • Installation
  • Configuration
  • Components

  • Composer
  • Direct Plugin Feed Upload
  • Authentication
  • General Settings
  • Configuration
  • Catalog Sync
  • Catalog Sync Information
  • Product Feed Generator
  • Feed View
  • Indexing Queue View
  • Analytics Integration
  • Upgrade
  • Uninstall

  • Installation
  • Configuration
  • Configure Feed
  • Cron Job
  • Features
  • Uninstall

Recommendations API

The Recommendations API lets you interact with the Unbxd platform and implement all recommendation-related functionality with ease. Unbxd Recommendations are a set of widgets, both pre-defined and customizable, designed to showcase personalized product suggestions to shoppers on your web store.

 

You can use the JSON /XML response format and customize your recommendation experience by leveraging various built-in features of Recommendations. This API can communicate over HTTP and HTTPS. However, we recommend using the HTTPS protocol.

Recommendations Endpoint

Request Method: GET

 

Endpoint: recommendations.unbxd.io/v2.0/{apikey}/{sitekey}/items

 

This API call fetches recommendations for the corresponding page type, for your website.

 

Path Parameters

<isitename>: Unique site key for each site. This is a required field.

<apikey>: Unique API key for each site. This is a required field.

Authentication

Our APIs use an API_KEY and a SITE_KEY to authenticate recommendation requests. 

These keys are generated at the time of account creation and can be accessed within Console at User Management-> Configure Site -> Keys.

Request Parameters

The values of the request parameters are defined below:

Parameters

Description

Type

Required

pageType

Define the Page type for which the recommendations have to be requested

String (enumerated)

  • HOME
  • CATEGORY
  • BRAND 
  • PRODUCT
  • CART

Yes

widget

 

Defines the position of the widgets on the page. If nothing is specified, recommendations for all widgets are given.

String (enumerated)

  • Widget 1
  • Widget 2
  • Widget 3

No

id

 

Unique ID of the product

String

Required to be passed only for PRODUCT, CART Page type

uid

 

Unique identifier of a user. It cannot have special character except ‘_’

String

All Page types

catlevel1Name

 

The first level of products. Denotes the hierarchy of products in your catalog.

String

Required to be passed only for CATEGORY Page type

catlevel2Name

 

The second level of products. Denotes the hierarchy of products in your catalog.

String

Required to be passed only for CATEGORY Page type

catlevel3Name

 

The third level of products. Denotes the hierarchy of products in your catalog.

String

Required to be passed only for CATEGORY Page type

catlevel4Name

 

The fourth level of products. Denotes the hierarchy of products in your catalog.

String

Required to be passed only for CATEGORY Page type

brand

 

Distinctive name or label of the manufacturer of the product.

String

Required to be passed only for BRAND Page type

ip

IP address for which recommendation is required 

X.X.X.X

All Page types

Response Components

After you input the request body(Path and Query) parameters and run the call successfully, we receive a response with the following parameters:

 

Parameter

Description

Always Present

widget1 

ExperienceResponse

No

widget2

ExperienceResponse

No

widget3

ExperienceResponse

No

error

ErrorResponse

No

Experience Response

Parameter

Description

Always Present

count

Size of list

Yes

recommendations

List of items

Yes

Component Description

The aforementioned table provided a with the default values of the request parameters. It is a pre-defined table of APIs which you can directly integrate by inputting the <sitekey> and <apikey> of your site. 

Let’s dwell deep and understand the API calls of each page individually.

Home Page 

https://recommendations.unbxd.io/v2.0/<apiKey>/<isitename>/items?pageType=HOME&uid=<uid>&ip=<ip>

Category Page

https://recommendations.unbxd.io/v2.0/<apiKey>/<isitename>/items?pageType=CATEGORY&catlevel1Name=cat1&catlevel2Name=cat2&catlevel3Name=cat3&catlevel4Name=cat4&uid=<uid>&ip=<ip>

PDP

https://recommendations.unbxd.io/v2.0/<apiKey>/<isitename>/items?pageType=PRODUCT&id=<pid1>&uid=<uid>&ip=<ip>

Cart Page

With UIDs: Recommendations are based on the carted products fetched from the UID.

https://recommendations.unbxd.io/v2.0/<apiKey>/<isitename>/items?pageType=CART&uid=<uid>&ip=<ip>

With PIDs: The recommendations are shown based on the PIDs and not UIDs.

https://recommendations.unbxd.io/v2.0/<apiKey>/<isitename>/items?pageType=CART&id=<pid1>&id=<pid2>&uid=<uid>&ip=<ip>

Brand Page

https://recommendations.unbxd.io/v2.0/<apiKey>/<isitename>/items?pageType=BRAND&brand=<brand1>&uid=<uid>&ip=<ip>

Copyright 2020 © Unbxd Inc, All Rights Reserved. Privacy Policy