Flipkart Marketplace Seller APIs¶

To generate access tokens using the client_credentials flow, below API should be used. You can write code in language of your choice to make a REST call or use curl to get the access tokens.

GET /oauth-service/oauth/token?grant_type=client_credentials&scope=Seller_Api,Default

This API is authenticated using Basic Access Authentication mechanism and so the required Authorization header is expected. credentials to be used in header is base64 encoding of your appId and appSecret separated by a colon (:).

e.g. if your registered application appId is my-appId-1 and appSecret is my-app-secret-1, the credential to be used for Basic authentication would be the base64 encoding of my-appId-1:my-app-secret-1

Examples

• Postman

  

  Using Postman is one of the easiest way to generate an access token and manually test and get a hang of the APIs. This screenshot of Postman can be referred to for building the request. As can be seen here, the appId and appSecret can directly be used as the Username and Password after selecting Basic Auth as the Authorization Type. Postman will take care of doing the base64 encoding and setting appropriate headers.

• Java

  If you are using Java, you can use the access token generation code which is bundled with the API client provided by us. Refer to API Integration section below for more details.

  Alternatively, here is a sample Java code which you can embed in your application to generate access tokens.

  import java.util.Base64;
  
  import kong.unirest.Unirest;
  import kong.unirest.json.JSONException;
  import kong.unirest.json.JSONObject;
  
  public final class MyFkApp {
  
      private static final String CLIENT_ID = "__CLIENT_ID__";          // Replace with your application id or client id
      private static final String CLIENT_SECRET = "__CLIENT_SECRET__";  // Replace with your application secret or client secret
  
      private MyFkApp() {
      }
  
      public static void main(String[] args) {
  
  
          String base64EncodedString = Base64.getEncoder().encodeToString((CLIENT_ID + ":" + CLIENT_SECRET).getBytes());
  
          JSONObject respoJsonObject = Unirest.get("https://sandbox-api.flipkart.net/oauth-service/oauth/token?grant_type=client_credentials&scope=Seller_Api")
                  .header("Authorization", "Basic " + base64EncodedString)
                  .asJson()
                  .getBody()
                  .getObject();
  
          String accessToken = "";
          String error = "";
  
          try {
              accessToken = respoJsonObject.getString("access_token");
              System.out.println("Access Token : " + accessToken);
          } catch (JSONException jse) {
              error = respoJsonObject.getString("error_description");
              System.out.println("Error occurred ! Error description : " + error);
          }
      }
  }
  

  Note

  You need to add a dependency on unirest-java for the above code to run. Kindly refer to unirest-java documentation for more info.

• Python

  import requests
  import base64
  
  url = "https://sandbox-api.flipkart.net/oauth-service/oauth/token"
  
  querystring = {"grant_type": "client_credentials", "scope": "Seller_Api"}
  
  client_id = "__CLIENT_ID__"             # Replace with your application id or client id
  client_secret = "__CLIENT_SECRET__"     # Replace with your application secret or client secret
  
  headers = {
      'Authorization': "Basic " + base64.b64encode(client_id + ":" + client_secret)
  }
  
  response_json = requests.request("GET", url, headers=headers, params=querystring).json()
  
  access_token = response_json["access_token"]
  print("Your access token is : " + access_token)
  

• C#

  using System;
  using Newtonsoft.Json;
  using Newtonsoft.Json.Serialization;
  using RestSharp;
  
  namespace fk_api_client_dotnet
  {
      class Program
      {
          static string clientId = "__CLIENT_ID__";           // Replace with your application id or client id
          static string clientSecret = "__CLIENT_SECRET__";   // Replace with your application secret or client secret
          static string credentials = Base64Encode(clientId + ":" + clientSecret);
  
          static void Main(string[] args)
          {
  
              var client = new RestClient("https://sandbox-api.flipkart.net/oauth-service/oauth/token?grant_type=client_credentials&scope=Seller_Api");
              var request = new RestRequest(Method.GET);
              request.AddHeader("Authorization", "Basic " + credentials);
              IRestResponse response = client.Execute(request);
  
              var _snakeSettings = new JsonSerializerSettings()
              {
                  ContractResolver = new UnderscorePropertyNamesContractResolver()
              };
  
              var accessTokenResponse = JsonConvert.DeserializeObject<AccessTokenResponse>(response.Content, _snakeSettings);
              Console.WriteLine("Your access token is : " + accessTokenResponse.accessToken);
          }
  
          public class UnderscorePropertyNamesContractResolver : DefaultContractResolver
          {
              public UnderscorePropertyNamesContractResolver()
              {
                  NamingStrategy = new SnakeCaseNamingStrategy();
              }
          }
  
          private static string Base64Encode(string plainText) {
              var plainTextBytes = System.Text.Encoding.UTF8.GetBytes(plainText);
              return System.Convert.ToBase64String(plainTextBytes);
          }
  
          public class AccessTokenResponse
          {
              public string accessToken { get; set;}
          }
      }
  }
  

  Note

  You need to add a dependency on RestSharp package for the above code to run. Kindly refer to RestSharp documentation for more info.

• curl

  curl -u <appid>:<app-secret> https://api.flipkart.net/oauth-service/oauth/token?grant_type=client_credentials&scope=Seller_Api
  

  Sample response

  {
    "access_token": "<token>",
    "token_type": "bearer",
    "expires_in": 3330779,
    "scope": "Seller_Api"
  }
  

1. Get the Seller’s Authorization

To begin an Authorization Code flow, your web application should first send the seller to the authorization URL.

Authorization URL

https://sandbox-api.flipkart.net/oauth-service/oauth/authorize?
client_id=<client-id>&
redirect_uri=<redirect-uri>&
response_type=code&
scope=Seller_Api&
state=<state>

Where,

• client-id: Your application’s Client ID. You can find this value in Seller APIs - Developer Admin portal
• redirect-uri: The URL to which Flipkart will redirect the browser after authorization has been granted by the seller. The Authorization Code will be available in the code URL parameter. This URL must be specified as a valid callback URL while creating application in Seller APIs - Developer Admin portal.
• state: An opaque value which your application should add to the initial request and that Flipkart also includes when redirecting back to the application. This value must be used by the application to prevent CSRF attacks. For more information, see authorization request .

Seller must login to the Flipkart Permission Registration page that appears using his/her login credentials.

Flipkart Permission Registration page

After successful login, seller would be presented with a Request for Authorization dialog. Upon clicking the Allow button, seller would be redirected to the redirect_uri, with authorization code and state as URL parameters.

Request for Authorization page

2. Exchange the Authorization Code for an Access Token

Now that you have an Authorization Code, you must exchange it for an Access Token that can be used to call the Flipkart Orders and Listing APIs. Using the Authorization Code (code) from the previous step, you will need to send it to the Token URL.

Token URL

https://sandbox-api.flipkart.net/oauth-service/oauth/token?
redirect_uri=<redirect-uri>&
grant_type=authorization_code&
state=<state>&
code=<code>

Sample Code

For sample code in Java, Python and C#, kindly refer to the Examples in Client Credentials Flow . You just need to replace the URL in the code with the Token URL.

curl

curl -u <appid>:<app-secret> https://sandbox-api.flipkart.net/oauth-service/oauth/token?redirect_uri=<redirect-uri>&grant_type=authorization_code&state=<state>&code=<code>

Sample response

{
  "access_token": "f638949a­c979­4172­b33c­23311a168647",
  "token_type": "bearer",
  "refresh_token": "860e03da­d58a­4988­9149-a4a7f365bba1",
  "expires_in": 5183999,
  "scope": "Seller_Api"
}