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

  • Browse
    • Search
    • Recs
Menu
  • Browse
    • Search
    • Recs
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages
  • Browse
    • Search
    • Recs
Menu
  • Browse
    • Search
    • Recs
  • Browse
    • Search
    • Recs
Menu
  • Browse
    • Search
    • Recs
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages
  • Get started
  • Documentation
  • Integration Docs
  • FAQ
Menu
  • Get started
  • Documentation
  • Integration Docs
  • FAQ

Down Arrow up_Arrow_active Feed

Feed Creation

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

Feed API

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

Down Arrow up_Arrow_active Analytics

Introduction

Browser Integration

  • JavaScript Based Integration
  • HTML Based Integration

GTM Integration

  • Introduction to GTM
  • Requirements

Analytics API

  • Introduction
  • Events
  • API Integration

Down Arrow up_Arrow_active Deploy Unbxd

Browse API

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

PDP API

  • PDP API Format

Taxonomy API

  • Taxonomy API Format
  • Taxonomy Feed API

Android SDK

  • System Requirements
  • Install SDK
  • Initialize SDK
  • Unbxd Commerce Search
  • Integrating Unbxd Autosuggest
  • Unbxd Analytics
  • Unbxd Browse
  • Unbxd Recommendations
  • Sample App

iOS SDK

  • Installation
  • Unbxd Analytics
  • Unbxd Commerce Search
  • Unbxd Autosuggest
  • Unbxd Browse
  • Unbxd Recommendations
  • Sample iOS App

Javascript SDK

  • Libraries
  • Quickstart
  • Authentication
  • Types of Pages to Render
  • Configuring the Page
  • Callback Functions
  • Helper Functions
  • Available Configurations

Down Arrow up_Arrow_active Platform Integration

Shopify

  • Installation
  • Configuration
  • Components

Magento 2

  • 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

SAP Hybris

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

PDP API

The PDP API powers the product display pages on your e-commerce site by returning all the product information associated with a product ID. The PDP API also fetches information for one or more than one product ID.

 

You can either view information for a specific product or a product listing with products linked to different product ids. If there are variants of a product, PDP API will include the variants info in the response.

PDP API Format

To integrate this API, you need to make the following API call to Unbxd servers:

Fetch product details using a product-id​

You can get products details of a product by calling the sample API.

Method : GET

 

End Point:https://search.unbxd.io/sites/site-key/products/

 

Parameter : product-id

Fetch Product details for more than one product

You can get products details of multiple products by using product ID’s.

Method : GET

 

End Point:https://search.unbxd.io/sites/site-key/products?id=<product_id1>,<product_id2>

 

Parameter : Comma separated list of product-id

Get Siblings for a product

You can use the rel feature to find any external relationship for a product. This feature fetches all the related parent products.

 

Method : GET

 

End Point:https://search.unbxd.io/sites/<sitekey>/products/<id1>?rel.field=<fieldName>

 

Parameter : 

product-id

rel.fields: The field on which the related products should be matched. The value of this property would be the fieldName.

rel.{fieldName}.fields: This returns a list of sibling product details of a, using the filter field passed as the query parameter.

rel.{fieldName}.rows: Number of related products to be returned. The default value is 1 This would have max value (max value yet to be decided)

rel.{fieldName}.filter: Filters to be applied for relative products. In the case of nested documents, parent_unbxd: true would always be added to exclude variants

NOTE: While using the rel feature, the variants feature will be disabled.

  • Did this answer your question?
  • No…

    I have some feedback

    Feedback is submitted

In this Section

  • To create a Query Rule
  • To Edit a Query Rule
  • Site Rule

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