Offer APIs Reference

Offer APIs enable registered affiliates to get details on:

  • The complete list of active offers on Flipkart
  • The deals of the day

All Offer API

Description - This API allows you to get the complete offers list.

Request and Response Details

☰ SHOW | HIDE

Header format: curl -H "Fk-Affiliate-Id:<Affiliate Tracking ID>" -H "Fk-Affiliate-Token:<Affiliate API Token>" "<API URL>"

URL:

  • JSON: https://affiliate-api.flipkart.net/affiliate/offers/v1/all/json
  • XML: https://affiliate-api.flipkart.net/affiliate/offers/v1/all/xml

Request Parameters:

  • There are no request parameters

Response Parameters:

API Datatype (Attribute/Variable) Description
title Offer title
description Offer description
url Offer URL
category Product category to which offer belongs
startTime Offer start time in Unix time format
endTime Offer expiry time in Unix time format
imageUrls List of image URLs with resolutionType corresponding to the offer
resolutionType Image resolution. Possible values: * default: Corresponds to highest resolution image * low: Corresponds to image size 200x200 px * mid: Corresponds to image size 400x400 px * high: Corresponds to image size 800x800 px
availability Availability of products with offer as LIVE (In-stock) or OOS (Out-of-stock)


Example

Sample JSON Response

☰ SHOW | HIDE
{
    "allOffersList": [
    {
        "startTime": 1447785000000,
        "endTime": 1448821800000,
        "title": "Up to 30% off",
        "description": "From Formula1",
        "url": "http://dl.flipkart.com/dl/automotive/accessories-spare-parts/car-bike-care/pr?p%5B%5D=facets.brand%255B%255D%3DFormula%2B1&p%5B%5D=facets.brand%255B%255D%3DFormula1&sid=0hx%2Cbwd%2Cbyn&filterNone=true&affid=keshav",
        "category": "automotive",
        "imageUrls": [
        {
            "url": "http://img.fkcdn.com/image/scratch-remover-wax/a/h/v/formula-1-227-scratch-out-original-imae3728msy6fh4v.jpeg",
            "resolutionType": "default"
        },
        {
            "url": "https://rukminim1.flixcart.com/image/200/200/scratch-remover-wax/a/h/v/formula-1-227-scratch-out-original-imae3728msy6fh4v.jpeg?q=90",
            "resolutionType": "low"
        },
        {
            "url": "https://rukminim1.flixcart.com/image/400/400/scratch-remover-wax/a/h/v/formula-1-227-scratch-out-original-imae3728msy6fh4v.jpeg?q=90",
            "resolutionType": "mid"
        },
        {
            "url": "https://rukminim1.flixcart.com/image/800/800/scratch-remover-wax/a/h/v/formula-1-227-scratch-out-original-imae3728msy6fh4v.jpeg?q=90",
            "resolutionType": "high"
        }
        ],
        "availability": "LIVE"
    }
    ]
}


Sample XML Response

☰ SHOW | HIDE
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:AllOfferFeed xmlns:ns2="http://www.flipkart.com/affiliate">
    <allOffersList>
        <availability>LIVE</availability>
        <category>automotive</category>
        <description>From Formula1</description>
        <endTime>2015-11-30T00:00:00+05:30</endTime>
        <imageUrls>
            <resolutionType>default</resolutionType>
            <url>http://img.fkcdn.com/image/scratch-remover-wax/a/h/v/formula-1-227-scratch-out-original-imae3728msy6fh4v.jpeg</url>
        </imageUrls>
        <imageUrls>
            <resolutionType>low</resolutionType>
            <url>https://rukminim1.flixcart.com/image/200/200/scratch-remover-wax/a/h/v/formula-1-227-scratch-out-original-imae3728msy6fh4v.jpeg?q=90</url>
        </imageUrls>
        <imageUrls>
            <resolutionType>mid</resolutionType>
            <url>https://rukminim1.flixcart.com/image/400/400/scratch-remover-wax/a/h/v/formula-1-227-scratch-out-original-imae3728msy6fh4v.jpeg?q=90</url>
        </imageUrls>
        <imageUrls>
            <resolutionType>high</resolutionType>
            <url>https://rukminim1.flixcart.com/image/800/800/scratch-remover-wax/a/h/v/formula-1-227-scratch-out-original-imae3728msy6fh4v.jpeg?q=90</url>
        </imageUrls>
       <startTime>2015-11-18T00:00:00+05:30</startTime>
       <title>Up to 30% off</title>
       <url>http://dl.flipkart.com/dl/automotive/accessories-spare-parts/car-bike-care/pr?p%5B%5D=facets.brand%255B%255D%3DFormula%2B1&p%5B%5D=facets.brand%255B%255D%3DFormula1&sid=0hx%2Cbwd%2Cbyn&filterNone=true&affid=keshav
       </url>
    </allOffersList>
</ns2:AllOfferFeed>


Deals of the Day (DOTD) Offer API

Description - This API allows you to get the details on the deals of the day.

Request and Response Details

☰ SHOW | HIDE

Header format: curl -H "Fk-Affiliate-Id:<Affiliate Tracking ID>" -H "Fk-Affiliate-Token:<Affiliate API Token>" "<API URL>"

URL:

  • JSON: https://affiliate-api.flipkart.net/affiliate/offers/v1/dotd/json
  • XML: https://affiliate-api.flipkart.net/affiliate/offers/v1/dotd/xml

Request Parameters:

There are no request parameters.

Response Parameters:

API Datatype (Attribute/Variable) Description
title Offer title
description Offer description
url Offer URL
imageUrls List of Image URLs with resolutionType corresponding to the deal or offer
resolutionType Image resolution. Possible values: * default: Corresponds to highest resolution image * low: Corresponds to image size 200x200 px * mid: Corresponds to image size 400x400 px * high: Corresponds to image size 800x800 px
availability Availability of products with offer as LIVE (In-stock) or OOS (Out-of-stock)


Example

Sample JSON Response

☰ SHOW | HIDE
{
    "dotdList": [
    {
        "title": "Just Rs. 249",
        "description": "Bluetooth selfie sticks",
        "url": "http://dl.flipkart.com/dl/camera-accessories/smile-n-click~brand/pr?p%5B%5D=facets.price_range%255B%255D%3DBelow%2BRs.%2B1000&sid=jek%2C6l2&filterNone=true&offer=ns%3A10e40dc418&affid=keshav",
        "imageUrls": [
        {
            "url": "http://img.fkcdn.com/image/selfie-stick/z/u/7/h-s203-smile-n-click-original-imaeagh9yg8k2t8z.jpeg",
            "resolutionType": "default"
        },
        {
            "url": "https://rukminim1.flixcart.com/image/200/200/selfie-stick/z/u/7/h-s203-smile-n-click-original-imaeagh9yg8k2t8z.jpeg?q=90",
            "resolutionType": "low"
        },
        {
            "url": "https://rukminim1.flixcart.com/image/400/400/selfie-stick/z/u/7/h-s203-smile-n-click-original-imaeagh9yg8k2t8z.jpeg?q=90",
            "resolutionType": "mid"
        },
        {
            "url": "https://rukminim1.flixcart.com/image/800/800/selfie-stick/z/u/7/h-s203-smile-n-click-original-imaeagh9yg8k2t8z.jpeg?q=90",
            "resolutionType": "high"
        }
        ],
        "availability": "LIVE"
    }
    ]
}


Sample XML Response

☰ SHOW | HIDE
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:DOTDFeed xmlns:ns2="http://www.flipkart.com/affiliate">
<dotdList>
    <description>Bluetooth selfie sticks</description>
    <imageUrls>
        <resolutionType>default</resolutionType>
        <url>http://img.fkcdn.com/image/selfie-stick/z/u/7/h-s203-smile-n-click-original-imaeagh9yg8k2t8z.jpeg</url>
    </imageUrls>
    <imageUrls>
        <resolutionType>low</resolutionType>
        <url>https://rukminim1.flixcart.com/image/200/200/selfie-stick/z/u/7/h-s203-smile-n-click-original-imaeagh9yg8k2t8z.jpeg?q=90</url>
    </imageUrls>
    <imageUrls>
        <resolutionType>mid</resolutionType>
        <url>https://rukminim1.flixcart.com/image/400/400/selfie-stick/z/u/7/h-s203-smile-n-click-original-imaeagh9yg8k2t8z.jpeg?q=90</url>
    </imageUrls>
    <imageUrls>
        <resolutionType>high</resolutionType>
        <url>https://rukminim1.flixcart.com/image/800/800/selfie-stick/z/u/7/h-s203-smile-n-click-original-imaeagh9yg8k2t8z.jpeg?q=90</url>
    </imageUrls>
    <title>Just Rs. 249</title>
    <url>http://dl.flipkart.com/dl/camera-accessories/smile-n-click~brand/pr?p%5B%5D=facets.price_range%255B%255D%3DBelow%2BRs.%2B1000&sid=jek%2C6l2&filterNone=true&offer=ns%3A10e40dc418&affid=keshav</url>
</dotdList>
</ns2:DOTDFeed>