Data Fields and Specifications for Catalog Add API

Updated on July 5th, 2023

+ More

Table of Contents

Overview Mandatory Fields Additional Required Fields Supported Fields

Overview

In order to give users a top-notch conversational commerce experience, we have outlined the data fields in this article that are necessary for syncing your product/SKU catalog data, categories, brands, and other details with Haptik systems for the Add API.

Add API allows you to add or replace information about your products. Note that before executing the add request, all content for the keys must be updated with the proper information as mentioned in this article.

Mandatory Fields

Each field in your API request body represents information about your products. This contains crucial details including the product description, photos, size and color options, pricing, and stock. Providing complete and relevant data instills user confidence and provides a better user experience, conversion to purchases, and other factors.

All field names and certain supported values must be in English. The following fields are required for each product in your catalog.

Key	Data Type	Default	Description
product_id	string	-	A unique ID identifying a product. Also known as Sku, sku id, product_id or unique product id.
name	string	-	Name of the product.
haptik_category	string	-	Category of the product from the haptik category list. Some examples are mobile, grocery, washing machine, air conditioner etc.
description	string	-	A long description of the product.
images	list of strings	-	List of image url strings. At least 1 image is mandatory for every product.
mrp	numeric (float)	-	The maximum retail price of the product.
price	numeric (float)	mrp	The effective selling price of the product.
store_rank	integer	-	Rank of the product in client search results. Required for ranking search results to users.

If any required fields are missing or formatted incorrectly, products may not be uploaded to your catalog. Click here for more information.

Additional Required Fields

You should also add the below given additional fields to share more product information with customers. This will ultimately help them in finding the product(s) they are searching for. When a user tries to filter on the brand, it helps the company give users more details about the goods that Haptik may use. You can add more or remove any that aren't relevant.

Key	Data Type	Default	Description
product_group_id	string	product id	An ID identifying parent products that are available in variants. This ID should be the same for a group of products that are variants of each other.
display_name	string	name	Name to be used when displaying the product. Required only if different from the product name.
brand	string	-	Name of the brand of the product.
available	boolean	true	Availability status of each product in your catalog. Items marked as unavailable are not displayed to your users.
return_policy	string	-	The return & refund policy of the product.
offers	list of strings	-	A list of all the offers applicable for the product.
country_of_origin	string	-	Country where the product was manufactured.
tags	list of strings	-	If you maintain any additional classifications beyond categories for grouping products, those can be shared here.
features	json object	-	A dictionary of features of the product. Please refer to the category attributes sheet for passing the keys here.
url	string		The URL of the product

Supported Fields

View the additional required fields to include in your data feed for apparels, beauty products, mobile phones, footwear, and grocery.

For more information, please reach out to your Haptik SPOC.

Contact Us