Report APIs Reference¶

The Report APIs allow registered affiliates to get reports of:

All affiliate-driven orders
All affiiate-driven Flipkart mobile app installations

Orders Report API¶

Description - This API allows you to get reports of all orders for a given date range and status.

Request and Response Details¶

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/report/orders/detail/json
XML: https://affiliate-api.flipkart.net/affiliate/report/orders/detail/xml

Request Parameters:

startDate and endDate: Date range for which you want the order report, in YYYY-MM-DD format
status: Order status. Possible values - tentative, approved, cancelled, disapproved
offset: Used for pagination. For the first request, the offset value is 0.

Response Parameters:

API Datatype (Attribute/Variable)	Description
`price`	Price of the order item in INR
`category`	The broader category the product falls under
`title`	Name of order item
`productId`	Product ID in the the Flipkart system
`quantity`	Total number of items in the order
`sales`	Price multiplied by quantity in INR
`status`	Order status. Possible values - `tentative`, `approved`, `cancelled`, and `disapproved`
`affiliateOrderItemId`	`orderId` in the Flipkart system
`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

Example¶

JSON Sample

Request

https://affiliate-api.flipkart.net/affiliate/report/orders/detail/json?startDate=2015-10-22&endDate=2015-11-22&status=approved&offset=0

Response

{
    "orderList": [
    {
        "price": 248,
        "category": "books",
        "title": "Golden Moments (English)",
        "productId": "9780751541397",
        "quantity": 1,
        "sales": {
            "amount": 248,
            "currency": "INR"
            },
        "status": "failed",
        "affiliateOrderItemId": "12345",
        "orderDate": "02-09-2014",
        "commissionRate": 10,
        "tentativeCommission": {
            "amount": 24.8,
            "currency": "INR"
        },
        "affExtParam1": "test",
        "affExtParam2": "",
        "salesChannel": "WEBSITE",
        "customerType": "NEW"
    }],
    "previous": "",
    "next": "",
    "first": "https://affiliate-api.flipkart.net/affiliate/report/orders/detail/json?startDate=2014-09-01&endDate=2014-10-02&status=cancelled&offset=0",
    "last": "https://affiliate-api.flipkart.net/affiliate/report/orders/detail/json?startDate=2014-09-01&endDate=2014-10-02&status=cancelled&offset=0"
}

XML Sample

Request

https://affiliate-api.flipkart.net/affiliate/report/orders/detail/xml?startDate=2015-10-22&endDate=2015-11-22&status=approved&offset=0

Response

 <?xml version="1.0" encoding="UTF-8"?>
 <ns2:OrderReportFeed xmlns:ns2="http://www.flipkart.com/affiliate">
 <first>https://affiliate-api.flipkart.net/affiliate/report/orders/detail/xml?startDate=2014-09-01&amp;endDate=2014-10-02&amp;status=cancelled&amp;offset=0</first>
 <previous />
 <next />
 <last>https://affiliate-api.flipkart.net/affiliate/report/orders/detail/xml?startDate=2014-09-01&amp;endDate=2014-10-02&amp;status=cancelled&amp;offset=0</last>
 <orderList>
     <order>
         <affExtParam1>test</affExtParam1>
         <affExtParam2 />
         <affiliateOrderItemId>12345</affiliateOrderItemId>
         <category>books</category>
         <commissionRate>10.0</commissionRate>
         <customerType>NEW</customerType>
         <orderDate>02-09-2014</orderDate>
         <price>248.0</price>
         <productId>9780751541397</productId>
         <quantity>1</quantity>
         <sales>
             <amount>248.0</amount>
             <currency>INR</currency>
         </sales>
         <salesChannel>WEBSITE</salesChannel>
         <status>failed</status>
         <tentativeCommission>
             <amount>24.8</amount>
             <currency>INR</currency>
         </tentativeCommission>
         <title>Golden Moments (English)</title>
   </order>
</orderList>
</ns2:OrderReportFeed>

App Install Report API¶

Description - This API allows you to get all Flipkart mobile app installations for a given date range and status.

Request and Response Details¶

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/v1/appInstall/json
XML: https://affiliate-api.flipkart.net/affiliate/v1/appInstall/xml

Request Parameters:

The Request format is https://affiliate-api.flipkart.net/affiliate/v1/appInstall/<Format>?startDate=<START_DATE>&endDate=<END_DATE>&status=<STATUS> where:

startDate and endDate: Date range for which you want the all the app installs, in YYYY-MM-DD format
status: App installation status. Possible values - tentative, ``approved, disapproved

Response Parameters:

API Datatype (Attribute/Variable)	Description
`date`	Date of app install in YYYY-MM-DD format
`os`	Type of mobile OS
`clickType`	Type of app install campaign
`title`	Type of OS and install campaign
`affExtParam1`	Affiliate tracking parameters. Additional `subId` value passed
`installCount`	Number of installations
`commissionPerInstall`	Commision rate in INR
`totalCommission`	Total commission amount in INR

Example¶

JSON Sample

Request

https://affiliate-api.flipkart.net/affiliate/v1/appInstall/json?startDate=2015-10-22&endDate=2015-11-22&status=approved

Response

{
    "appInstalls": [
    {
        "date": "2015-07-25"
        "os": "Android",
        "clickType": "FALLBACK",
        "title": "App Install Android Fallback",
        "affExtParam1": "",
        "installCount": 4,
        "commissionPerInstall": 35,
        "totalCommission": 140
    }
    ]
}

XML Sample

Request

https://affiliate-api.flipkart.net/affiliate/v1/appInstall/xml?startDate=2015-10-22&endDate=2015-11-22&status=approved

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:AppInstallFeed xmlns:ns2="http://www.flipkart.com/affiliate">
    <appInstalls>
        <affExtParam1>mp:WRge54xO7Da2</affExtParam1>
        <clickType>FALLBACK</clickType>
        <commissionPerInstall>40.0</commissionPerInstall>
        <date>2015-10-22</date>
        <installCount>1</installCount>
        <os>Android</os>
        <title>App Install Android Fallback</title>
        <totalCommission>40.0</totalCommission>
    </appInstalls>
</ns2:AppInstallFeed>