Glossary¶
Product APIs¶
Product Feed Listing API JSON: XML: Product Feed API JSON: XML: Delta Feed API JSON: XML: Search Query based on Keywords API JSON: XML: Search Query based on Product ID API JSON: XML: Feed Download Listing API JSON: XML: Feed Download API
|
| API Datatype (Attribute/Variable) | Description |
|---|---|
productId |
A unique SKU ID assigned by Flipkart to a particular product. |
title |
The specific product name which includes the brand name and, in some cases, the version/model number. |
imageUrl |
Image URL of the product |
categoryPaths |
This represents all the category hierarchies to which this product belongs. Category hierarchy is a list titles of category and sub categories to which this product is classified. |
mrp |
This mentions the Maximum Retail Price of the product. |
price |
This mentions the actual price (after Discount) at which Flipkart is selling the product. |
productUrl |
This is the URL of the product page on Flipkart.com. Your affiliate tracking id will be automatically appended to the product url. |
productDescription |
Long description of what this product is all about. |
productBrand |
This is the Brand Name of this product?s manufacturer. |
productShippingBaseInfo |
This column mentions the maximum delivery time of the product in bangalore. For all out-of-stock products, the value would be Empty. |
inStock |
The value “false” implies product is not in stock; “true” means the product is in stock. |
isAvailable |
The value “false” implies product is not available in the Flipkart Catalogue; “true” means the product is available in the Flipkart Catalogue. |
codAvailable |
This column mentions whether COD (Cash On Delivery) is available for this product. The value would be true or false. |
emiAvailable |
This column mentions whether EMI is available. false means EMI is not available on the product, true means EMI option is available. |
offers |
This column mentions if any ADDITIONAL promotional offers are available for this product (It is over & above the pricing discount available). In case any offers are applicable, description of all offers will be mentioned. |
discount |
This column mentions the pricing discount percentage available on the product?s Maximum Retail Price [this does not include the Offers column above] |
cashBack |
This column mentions if any additional Cash back being offered by Flipkart on the product. |
size |
Size of the item. |
color |
Color of the item. |
sizeUnit |
Measurement unit of the size. |
sizeVariants |
List of related products varying only in size. |
colorVariants |
List of related products varying only in color. |
styleCode |
A unique value that is common for all sizeVariants and colorVariants. |
offset |
The entry correspond to the offset of the given product in the product base. |
Product APIs New (v1.0)¶
Product Feed Listing API JSON: XML: Product Feed API JSON: XML: Delta Feed API JSON: XML: Top Selling ProductAPI JSON: XML: Search Query based on Keywords API JSON: XML: Search Query based on Product ID API JSON: XML: Feed Download Listing API JSON: XML: Feed Download API
|
| API Datatype (Attribute/Variable) | Description |
|---|---|
productId |
A unique SKU ID assigned by Flipkart to a particular product. |
title |
The specific product name which includes the brand name and, in some cases, the version/model number. |
imageUrls |
This column provides imageUrl of the product with different resolutions. |
categoryPaths |
This represents all the category hierarchies to which this product belongs. Category hierarchy is a list titles of category and sub categories to which this product is classified. |
maximumRetailPrice |
This mentions the Maximum Retail Price of the product. |
flipkartSellingPrice |
This mentions the actual price (after Discount) at which Flipkart is selling the product. |
flipkartSpecialPrice |
This mentions the price at which Flipkart is selling the product after applying extra offers if any. |
productUrl |
This is the URL of the product page on Flipkart.com. Your affiliate tracking id will be automatically appended to the product url. |
productDescription |
Long description of what this product is all about. |
productBrand |
This is the Brand Name of this product?s manufacturer. |
inStock |
The value “false” implies product is not in stock; “true” means the product is in stock. |
isAvailable |
The value “false” implies product is not available at Flipkart; “true” means the product is available at Flipkart. |
codAvailable |
This column mentions whether COD (Cash On Delivery) is available for this product. The value would be true or false. |
offers |
This column mentions if any ADDITIONAL promotional offers are available for this product (It is over & above the pricing discount available). In case any offers are applicable, description of all offers will be mentioned. |
discount |
This column mentions the pricing discount percentage available on the product?s Maximum Retail Price [this does not include the Offers column above] |
size |
Size of the item. |
color |
Color of the item. |
storage |
Storage capacity of the item (Useful in case of mobiles). |
sizeUnit |
Measurement unit of the size. |
displaySize |
Display Size of item (Useful in case of television). |
productFamily |
List of related products varying in size/color or some other attribute. |
offset |
The entry correspond to the offset of the given product in the product base. |
shippingCharges |
This mentions the price of shipping the product to the destination. |
sellerName |
This mentions the name of the seller. |
sellerAverageRating |
This mentions the seller average rating on flipkart. |
sellerNoOfRatings |
This mentions the total number of ratings given for the seller on flipkart. |
sellerNoOfReviews |
This mentions the total number of reviews on flipkart for the seller. |
keySpecs |
This mentions the key features of the product. |
detailedSpecs |
This mentions all the features of the product. |
specificationList |
This mentions all the specifications of the product. |
booksInfo |
This mentions all the books related details if the product is a books. |
lifeStyleInfo |
This mentions all the details related to lifestyle products(such as it is ideal for both Men and Women). |
Offer APIs¶
All Offer API JSON: XML: Deals of the Day (DOTD) Offer API JSON: XML: |
| API Datatype (Attribute/Variable) | Description |
|---|---|
startTime |
Offer start time in Unix Time Format |
endTime |
Offer end time in Unix Time Format |
title |
Title of the offer |
description |
Description about the offer |
url |
URL for the offer |
imageUrls |
List of Image URLs with resolutionType corresponding to the Offer |
resolutionType |
Image resolution. Possible values: * default: this corresponds to highest resolution image * low: this corresponds to image of size 200x200 px * mid: this corresponds to image of size 400x400 px * high: this corresponds to image of size 800x800 px |
availability |
Availability of products with offer as LIVE (In-stock) or OOS (Out-of-stock) |
Report APIs¶
Orders Report API JSON: XML: App Install Report API JSON: XML: |
| API Datatype (Attribute/Variable) | Description |
|---|---|
price |
Price of order item in INR |
category |
The broader category the product falls under |
title |
Name of order item |
productId |
ID of the product on flipkart.com |
quantity |
Total number of items in the order |
sales |
Price multiplied by quantity in INR |
status |
Order status |
affiliateOrderItemId |
orderId |
orderDate |
The date when order was placed in MM-DD-YYYY format |
commissionRate |
Rate at which commission is calculated |
tentativeCommission |
Commission (amount and currency) earned for the particular order |
affExtParam1 and affExtParam2 |
Affiliate tracking parameters. Additional subId value passed |
salesChannel |
The channel through which order was placed on flipkart.com |
customerType |
Whether the order was the customer’s first purchase or not |
date |
Date of App Install in YYYY-MM-DD format |
os |
Type of Mobile Operating System |
clickType |
Type of Install Campaign |
title |
Type of OS and Install campaign |
installCount |
Number of installs |
commissionPerInstall |
Commision rate in INR |
totalCommission |
Total commission amount in INR |