Product Catalog Fields

This article lists the supported fields and their properties for items added to different Product Catalogs. Each section below is structured to show a product catalog category and its sub categories. Inside each sub category, we can find a list of all the fields that items added to that category can have, along with other details like the max size, type, description and whether they are a required field or an optional one.

Category: Ecommerce

Sub category: Items

Field Max size Type Mandatory Description Comments
Id 100 string Y Unique ID for item. Can be a variant for a product.  If there are multiple instances of the same ID, we ignore all instances.
title 100 string Y Title of item  
description 5000 string N Short text describing product.  
image_link   string Y Link to item image on the merchant website  
condition   string N Product condition: supported values "New", "Refurbished", "Used"  default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued"  default = In Stock
category   string N    
sub_category   string N    
additional_image_urls  2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
price   float Y Cost of Item  
gender   string N Supported values male, female, or unisex  
item_group_id   string N For items that are varients of a product. Provide the same item_group_id for all items that are varients. For example, Red Polo Shirt is a variant of Polo Shirt.  
google_product_category  250 string N Predefined values from Google's product taxonomy.  
color   string N Item color  
size   int/string N Size of an Item  

Sub category: Service

Field Max size Type Mandatory Description Comments
Id 100 string Y Unique ID for item. Can be a variant for a product.  If there are multiple instances of the same ID, we ignore all instances.
title 100 string Y Title of item  
description 5000 string N Short text describing product.  
image_link   string Y Link to item image on the merchant website  
condition   string N Product condition: supported values "New", "Refurbished", "Used"  default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued"  default = In Stock
category   string N    
sub_category   string N    
additional_image_urls  2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
price   float Y Cost of Item  
gender   string N Supported values male, female, or unisex  
item_group_id   string N For items that are varients of a product. Provide the same item_group_id for all items that are varients. For example, Red Polo Shirt is a variant of Polo Shirt.  
google_product_category  250 string N Predefined values from Google's product taxonomy.  
color   string N Item color  
size   int/string N Size of an Item  

Sub category: Other

Field Max size Type Mandatory Description Comments
Id 100 string Y Unique ID for item. Can be a variant for a product.  If there are multiple instances of the same ID, we ignore all instances.
title 100 string Y Title of item  
description 5000 string N Short text describing product.  
image_link   string Y Link to item image on the merchant website  
condition   string N Product condition: supported values "New", "Refurbished", "Used"  default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued"  default = In Stock
category   string N    
sub_category   string N    
additional_image_urls  2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
price   float Y Cost of Item  
gender   string N Supported values male, female, or unisex  
item_group_id   string N For items that are varients of a product. Provide the same item_group_id for all items that are varients. For example, Red Polo Shirt is a variant of Polo Shirt.  
google_product_category  250 string N Predefined values from Google's product taxonomy.  
color   string N Item color  
size   int/string N Size of an Item  

Category: Travel

Sub category: Hotel

Field Max size Type Mandatory Description Comments
id 100 string Y Unique ID for item. Can be a variant for a product. If there are multiple instances of the same ID, we ignore all instances.  
title 100 string Y Title of item.  
description 5000 string N Short text describing product.  
link   string Y Link to merchant's site where someone can buy the item.  
image_link   string Y Link to item image on the merchant website.  
price   float N Cost of Item.  
condition   string N Product condition: supported values "New", "Refurbished", "Used" default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued" default = In Stock
category   string N    
sub_category   string N    
additional_image_urls 2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
address.addr1   String N Address is defined as complete address for the hotel that must be resolvable to its location. Address.addr1 is Street address of hotel.  
address.city   String N City hotel is in.  
address.region   String N State, county, region or province for hotel.  
address.country   String N Country of the hotel.  
address.postal_code   String N Postal or zip-code of the hotel  
geolocation.lattitude   float N Lattitude of the hotel  
geolocation.longitude   float N Longitude of the hotel  
rating   float/string N Hotel star rating. The valid values are between 1 to 5 and should be multiples of 0.5.  
phone   string N Phone Number  
guest_rating   float N Guest ratings for the hotel. If specified, score, number_of_reviewers and rating_system must be provided. not defined yet
star_rating   float N Hotel star rating. The valid values are between 1 to 5 and should be multiples of 0.5. not defined yet
price   float Y    

Sub category: Destination

Field Max size Type Mandatory Description Comments
id 100 string Y Unique ID for item. Can be a variant for a product. If there are multiple instances of the same ID, we ignore all instances.  
title 100 string Y Title of item.  
description 5000 string N Short text describing product.  
link   string Y Link to merchant's site where someone can buy the item.  
image_link   string Y Link to item image on the merchant website.  
price   float N Cost of Item.  
condition   string N Product condition: supported values "New", "Refurbished", "Used" default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued" default = In Stock
category   string N    
sub_category   string N    
additional_image_urls 2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
address.addr1   String N Address is defined as complete address for the hotel that must be resolvable to its location. Address.addr1 is Street address of hotel.  
address.city   String N City hotel is in.  
address.region   String N State, county, region or province for hotel.  
address.country   String N Country of the hotel.  
address.postal_code   String N Postal or zip-code of the hotel  
geolocation.lattitude   float N Lattitude of the hoel  
geolocation.longitude   float N Lngitude of the hotel  
rating   float/string N Hotel star rating. The valid values are between 1 to 5 and should be multiples of 0.5.  
phone   string N Phone Number  
guest_rating   float N Guest ratings for the hotel. If specified, score, number_of_reviewers and rating_system must be provided. not defined yet
star_rating   float N Hotel star rating. The valid values are between 1 to 5 and should be multiples of 0.5. not defined yet
price   float Y    

Sub category: Activity

Field Max size Type Mandatory Description Comments
id 100 string Y Unique ID for item. Can be a variant for a product. If there are multiple instances of the same ID, we ignore all instances.  
title 100 string Y Title of item.  
description 5000 string N Short text describing product.  
link   string Y Link to merchant's site where someone can buy the item.  
image_link   string Y Link to item image on the merchant website.  
price   float N Cost of Item.  
condition   string N Product condition: supported values "New", "Refurbished", "Used" default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued" default = In Stock
category   string N    
sub_category   string N    
additional_image_urls 2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
address.addr1   String N Address is defined as complete address for the hotel that must be resolvable to its location. Address.addr1 is Street address of hotel.  
address.city   String N City hotel is in.  
address.region   String N State, county, region or province for hotel.  
address.country   String N Country of the hotel.  
address.postal_code   String N Postal or zip-code of the hotel  
geolocation.lattitude   float N Lattitude of the hoel  
geolocation.longitude   float N Lngitude of the hotel  
rating   float/string N Hotel star rating. The valid values are between 1 to 5 and should be multiples of 0.5.  
phone   string N Phone Number  
age_limit   int   Age limit specified for the activity  
duration   TBD      

Sub category: Event

Field Max size Type Mandatory Description Comments
id 100 string Y Unique ID for item. Can be a variant for a product. If there are multiple instances of the same ID, we ignore all instances.  
title 100 string Y Title of item.  
description 5000 string N Short text describing product.  
link   string Y Link to merchant's site where someone can buy the item.  
image_link   string Y Link to item image on the merchant website.  
price   float N Cost of Item.  
condition   string N Product condition: supported values "New", "Refurbished", "Used" default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued" default = In Stock
category   string N    
sub_category   string N    
additional_image_urls 2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
address.addr1   String N Address is defined as complete address for the hotel that must be resolvable to its location. Address.addr1 is Street address of hotel.  
address.city   String N City hotel is in.  
address.region   String N State, county, region or province for hotel.  
address.country   String N Country of the hotel.  
address.postal_code   String N Postal or zip-code of the hotel  
geolocation.lattitude   float N Lattitude of the hoel  
geolocation.longitude   float N Lngitude of the hotel  
rating   float/string N Hotel star rating. The valid values are between 1 to 5 and should be multiples of 0.5.  
phone   string N Phone Number  
event_time   datetime N   not defined yet
price   float Y    

Sub category: Room

Field Max size Type Mandatory Description Comments
id 100 string Y Unique ID for item. Can be a variant for a product. If there are multiple instances of the same ID, we ignore all instances.  
title 100 string Y Title of item.  
description 5000 string N Short text describing product.  
link   string Y Link to merchant's site where someone can buy the item.  
image_link   string Y Link to item image on the merchant website.  
price   float N Cost of Item.  
condition   string N Product condition: supported values "New", "Refurbished", "Used" default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued" default = In Stock
category   string N    
sub_category   string N    
additional_image_urls 2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
address.addr1   String N Address is defined as complete address for the hotel that must be resolvable to its location. Address.addr1 is Street address of hotel.  
address.city   String N City hotel is in.  
address.region   String N State, county, region or province for hotel.  
address.country   String N Country of the hotel.  
address.postal_code   String N Postal or zip-code of the hotel  
geolocation.lattitude   float N Lattitude of the hoel  
geolocation.longitude   float N Lngitude of the hotel  
rating   float/string N Hotel star rating. The valid values are between 1 to 5 and should be multiples of 0.5.  

phone

  string N Phone Number  
room_tax   float N    
fees   float N    

Sub category: Other

Field Max size Type Mandatory Description Comments
id 100 string Y Unique ID for item. Can be a variant for a product. If there are multiple instances of the same ID, we ignore all instances.  
title 100 string Y Title of item.  
description 5000 string N Short text describing product.  
link   string Y Link to merchant's site where someone can buy the item.  
image_link   string Y Link to item image on the merchant website.  
price   float N Cost of Item.  
condition   string N Product condition: supported values "New", "Refurbished", "Used" default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued" default = In Stock
category   string N    
sub_category   string N    
additional_image_urls 2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
address.addr1   String N Address is defined as complete address for the hotel that must be resolvable to its location. Address.addr1 is Street address of hotel.  
address.city   String N City hotel is in.  
address.region   String N State, county, region or province for hotel.  
address.country   String N Country of the hotel.  
address.postal_code   String N Postal or zip-code of the hotel  
geolocation.lattitude   float N Lattitude of the hoel  
geolocation.longitude   float N Lngitude of the hotel  
rating   float/string N Hotel star rating. The valid values are between 1 to 5 and should be multiples of 0.5.  
phone   string N Phone Number  

Category: Music

Sub category: Other

Field Max size Type Mandatory Description Comments
id 100 string Y Unique ID for item. Can be a variant for a product. If there are multiple instances of the same ID, we ignore all instances.  
title 100 string Y Title of item.  
description 5000 string N Short text describing product.  
link   string Y Link to merchant's site where someone can buy the item.  
image_link   string Y Link to item image on the merchant website.  
price   float N Cost of Item.  
condition   string N Product condition: supported values "New", "Refurbished", "Used" default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued" default = In Stock
category   string N    
sub_category   string N    
additional_image_urls 2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  

Category: Other

Sub category: Other

Field Max size Type Mandatory Description Comments
id 100 string Y Unique ID for item. Can be a variant for a product. If there are multiple instances of the same ID, we ignore all instances.  
title 100 string Y Title of item.  
description 5000 string N Short text describing product.  
link   string Y Link to merchant's site where someone can buy the item.  
image_link   string Y Link to item image on the merchant website.  
price   float N Cost of Item.  
condition   string N Product condition: supported values "New", "Refurbished", "Used" default= New
availability   string N If item in stock. Accepted values are: "In Stock", "Out of Stock", "Preorder", "Avalilable for Order", "Discontinued" default = In Stock
category   string N    
sub_category   string N    
additional_image_urls 2000 list N You can include up to 10 additional images; provide them as comma-separated URLs. pipe-separated string OR list of strings
windows_phone_url   string N Custom scheme for Windows Phone app as URL  
windows_phone_app_id   string N App ID, as a GUID, for app store  
windows_phone_app_name   string N Name of app for display  
android_url   string N Custom scheme for Android app as URL  
android_package   string N Fully-qualified package name for intent generation  
android_app_name   string N Name of app for display  
ios_url   string N Custom scheme for iOS app as URL  
ios_app_store_id   string N App ID for App Store  
ios_app_name   string N Name of app to display  
Was this article helpful?
0 out of 0 found this helpful