ReturnsV2Api

All URIs are relative to https://sandbox-api.flipkart.net/sellers , https://api.flipkart.net/sellers

Method	HTTP request	Description
approveSelfShipReturns	POST /v2/returns/approve	Approve self-ship returns
cancelSelfShipReturn	POST /v2/returns/cancel	Cancel self-ship return
getReturns	GET /v2/returns	Fetch returns
pickup	POST /v2/returns/pickup	Update self-ship returns pickup details
pickupAttempt	POST /v2/returns/pickupAttempt	Update self-ship returns pickup attempt
rejectSelfShipReturns	POST /v2/returns/reject	Reject self-ship returns
returnComplete	POST /v2/returns/complete	Update self-ship returns as complete

approveSelfShipReturns

ReturnsActionResponseV2 approveSelfShipReturns(body)

Approve self-ship returns

This operation is used to approve the self-ship returns.

Example

// Import classes:
package com.flipkart.api.seller.client.client_application;
import com.flipkart.api.seller.client.ApiClient;
import com.flipkart.api.seller.client.ApiException;
import com.flipkart.api.seller.client.Environment;
import com.flipkart.api.seller.client.UrlConfiguration;
import com.flipkart.api.seller.client.access_token_generation.AccessTokenGenerator;
import com.flipkart.api.seller.client.api.ReturnsV2Api;
import com.flipkart.api.seller.client.model.ReturnsActionResponseV2;
import com.flipkart.api.seller.client.model.ReturnsApproveRequest;


public class MyFlipkartApplication {

  public static void main(String[] args) {

    //Access Token Generation
    AccessTokenGenerator accessTokenGenerator = new AccessTokenGenerator();

    //choose environment SANDBOX or PROD
    String env = String.valueOf(Environment.SANDBOX);
    UrlConfiguration urlConfiguration = new UrlConfiguration(env);

    //Replace the below values with your client id and client secret here
    accessTokenGenerator.clientCredentials("__client_id__",
        "__client_secret__");
    String accessToken = AccessTokenGenerator.getClientCredentialsAccessToken();
    System.out.println("Your Access Token: " + accessToken);

    //client call
    ApiClient apiClient = new ApiClient();
    apiClient.setAccessToken(accessToken);

    ReturnsV2Api apiInstance = new ReturnsV2Api(apiClient);
    ReturnsApproveRequest body = new ReturnsApproveRequest(); // ReturnsApproveRequest
    try {
      ReturnsActionResponseV2 result = apiInstance.approveSelfShipReturns(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReturnsV2Api#approveSelfShipReturns");
      e.printStackTrace();
    }

  }
}

Parameters

Name	Type	Description	Notes
body	ReturnsApproveRequest		[optional]

Return type

ReturnsActionResponseV2

Authorization

Oauth2SelfAccess

HTTP request headers

Content-Type: application/json
Accept: application/json

cancelSelfShipReturn

ReturnsActionResponseV2 cancelSelfShipReturn(body)

Cancel self-ship return

This operation is used to cancel the self-ship return

Example

// Import classes:
package com.flipkart.api.seller.client.client_application;
import com.flipkart.api.seller.client.ApiClient;
import com.flipkart.api.seller.client.ApiException;
import com.flipkart.api.seller.client.Environment;
import com.flipkart.api.seller.client.UrlConfiguration;
import com.flipkart.api.seller.client.access_token_generation.AccessTokenGenerator;
import com.flipkart.api.seller.client.api.ReturnsV2Api;
import com.flipkart.api.seller.client.model.ReturnsActionResponseV2;
import com.flipkart.api.seller.client.model.SelfShipReturnCancellationRequest;


public class MyFlipkartApplication {

  public static void main(String[] args) {

    //Access Token Generation
    AccessTokenGenerator accessTokenGenerator = new AccessTokenGenerator();

    //choose environment SANDBOX or PROD
    String env = String.valueOf(Environment.SANDBOX);
    UrlConfiguration urlConfiguration = new UrlConfiguration(env);

    //Replace the below values with your client id and client secret here
    accessTokenGenerator.clientCredentials("__client_id__",
        "__client_secret__");
    String accessToken = AccessTokenGenerator.getClientCredentialsAccessToken();
    System.out.println("Your Access Token: " + accessToken);

    //client call
    ApiClient apiClient = new ApiClient();
    apiClient.setAccessToken(accessToken);

    ReturnsV2Api apiInstance = new ReturnsV2Api(apiClient);
    SelfShipReturnCancellationRequest body = new SelfShipReturnCancellationRequest(); // SelfShipReturnCancellationRequest |
    try {
      ReturnsActionResponseV2 result = apiInstance.cancelSelfShipReturn(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReturnsV2Api#cancelSelfShipReturn");
      e.printStackTrace();
    }

  }
}

Parameters

Name	Type	Description	Notes
body	SelfShipReturnCancellationRequest		[optional]

Return type

ReturnsActionResponseV2

Authorization

Oauth2SelfAccess

HTTP request headers

Content-Type: application/json
Accept: application/json

getReturns

ReturnsSearchResponseV2 getReturns(source, modifiedAfter, modifiedBefore, createdAfter, createdBefore, returnIds, trackingIds, locationId)

Fetch returns

This operation is used to fetch returns based on given return created / modified date ranges or specific `returnIds` or `trackingIds`

Example

// Import classes:
package com.flipkart.api.seller.client.client_application;
import com.flipkart.api.seller.client.ApiClient;
import com.flipkart.api.seller.client.ApiException;
import com.flipkart.api.seller.client.Environment;
import com.flipkart.api.seller.client.UrlConfiguration;
import com.flipkart.api.seller.client.access_token_generation.AccessTokenGenerator;
import com.flipkart.api.seller.client.api.ReturnsV2Api;
import com.flipkart.api.seller.client.model.ReturnsActionResponseV2;
import com.flipkart.api.seller.client.model.ReturnsSearchResponseV2;
import com.flipkart.api.seller.client.model.SelfShipReturnCancellationRequest;


public class MyFlipkartApplication {

  public static void main(String[] args) {

    //Access Token Generation
    AccessTokenGenerator accessTokenGenerator = new AccessTokenGenerator();

    //choose environment SANDBOX or PROD
    String env = String.valueOf(Environment.SANDBOX);
    UrlConfiguration urlConfiguration = new UrlConfiguration(env);

    //Replace the below values with your client id and client secret here
    accessTokenGenerator.clientCredentials("__client_id__",
        "__client_secret__");
    String accessToken = AccessTokenGenerator.getClientCredentialsAccessToken();
    System.out.println("Your Access Token: " + accessToken);

    //client call
    ApiClient apiClient = new ApiClient();
    apiClient.setAccessToken(accessToken);

    ReturnsV2Api apiInstance = new ReturnsV2Api(apiClient);
    String source = "source_example"; // String |
    String modifiedAfter = "modifiedAfter_example"; // String |
    String modifiedBefore = "modifiedBefore_example"; // String |
    String createdAfter = "createdAfter_example"; // String |
    String createdBefore = "createdBefore_example"; // String |
    String returnIds = "returnIds_example"; // String | Comma separated return ids. Max. 25 allowed.
    String trackingIds = "trackingIds_example"; // String | Comma separated tracking ids. Max. 25 allowed.
    String locationId = "locationId_example"; // String |
    try {
      ReturnsSearchResponseV2 result = apiInstance.getReturns(source, modifiedAfter, modifiedBefore, createdAfter, createdBefore, returnIds, trackingIds, locationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReturnsV2Api#getReturns");
      e.printStackTrace();
    }

  }
}

Parameters

Name	Type	Description	Notes
source	String		[optional]
modifiedAfter	String		[optional]
modifiedBefore	String		[optional]
createdAfter	String		[optional]
createdBefore	String		[optional]
returnIds	String	Comma separated return ids. Max. 25 allowed.	[optional]
trackingIds	String	Comma separated tracking ids. Max. 25 allowed.	[optional]
locationId	String		[optional]

Return type

ReturnsSearchResponseV2

Authorization

Oauth2SelfAccess

HTTP request headers

Content-Type: application/json
Accept: application/json

pickup

ReturnsActionResponseV2 pickup(body)

Update self-ship returns pickup details

This operation is used to update the pickup details of customer self-ship returns.

Example

// Import classes:
package com.flipkart.api.seller.client.client_application;
import com.flipkart.api.seller.client.ApiClient;
import com.flipkart.api.seller.client.ApiException;
import com.flipkart.api.seller.client.Environment;
import com.flipkart.api.seller.client.UrlConfiguration;
import com.flipkart.api.seller.client.access_token_generation.AccessTokenGenerator;
import com.flipkart.api.seller.client.api.ReturnsV2Api;
import com.flipkart.api.seller.client.model.ReturnsActionResponseV2;
import com.flipkart.api.seller.client.model.SelfShipReturnPickupRequests;


public class MyFlipkartApplication {

  public static void main(String[] args) {

    //Access Token Generation
    AccessTokenGenerator accessTokenGenerator = new AccessTokenGenerator();

    //choose environment SANDBOX or PROD
    String env = String.valueOf(Environment.SANDBOX);
    UrlConfiguration urlConfiguration = new UrlConfiguration(env);

    //Replace the below values with your client id and client secret here
    accessTokenGenerator.clientCredentials("__client_id__",
        "__client_secret__");
    String accessToken = AccessTokenGenerator.getClientCredentialsAccessToken();
    System.out.println("Your Access Token: " + accessToken);

    //client call
    ApiClient apiClient = new ApiClient();
    apiClient.setAccessToken(accessToken);

    ReturnsV2Api apiInstance = new ReturnsV2Api(apiClient);
    SelfShipReturnPickupRequests body = new SelfShipReturnPickupRequests(); // SelfShipReturnPickupRequests |
    try {
      ReturnsActionResponseV2 result = apiInstance.pickup(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReturnsV2Api#pickup");
      e.printStackTrace();
    }

  }
}

Parameters

Name	Type	Description	Notes
body	SelfShipReturnPickupRequests		[optional]

Return type

ReturnsActionResponseV2

Authorization

Oauth2SelfAccess

HTTP request headers

Content-Type: application/json
Accept: application/json

pickupAttempt

ReturnsActionResponseV2 pickupAttempt(body)

Update self-ship returns pickup attempt

This operation is used to update the failed pickup attempt of self-ship returns.

Example

// Import classes:
package com.flipkart.api.seller.client.client_application;
import com.flipkart.api.seller.client.ApiClient;
import com.flipkart.api.seller.client.ApiException;
import com.flipkart.api.seller.client.Environment;
import com.flipkart.api.seller.client.UrlConfiguration;
import com.flipkart.api.seller.client.access_token_generation.AccessTokenGenerator;
import com.flipkart.api.seller.client.api.ReturnsV2Api;
import com.flipkart.api.seller.client.model.ReturnsActionResponseV2;
import com.flipkart.api.seller.client.model.SelfShipReturnPickupAttemptRequests;

public class MyFlipkartApplication {

  public static void main(String[] args) {

    //Access Token Generation
    AccessTokenGenerator accessTokenGenerator = new AccessTokenGenerator();

    //choose environment SANDBOX or PROD
    String env = String.valueOf(Environment.SANDBOX);
    UrlConfiguration urlConfiguration = new UrlConfiguration(env);

    //Replace the below values with your client id and client secret here
    accessTokenGenerator.clientCredentials("__client_id__",
        "__client_secret__");
    String accessToken = AccessTokenGenerator.getClientCredentialsAccessToken();
    System.out.println("Your Access Token: " + accessToken);

    //client call
    ApiClient apiClient = new ApiClient();
    apiClient.setAccessToken(accessToken);

    ReturnsV2Api apiInstance = new ReturnsV2Api(apiClient);
    SelfShipReturnPickupAttemptRequests body = new SelfShipReturnPickupAttemptRequests(); // SelfShipReturnPickupAttemptRequests |
    try {
      ReturnsActionResponseV2 result = apiInstance.pickupAttempt(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReturnsV2Api#pickupAttempt");
      e.printStackTrace();
    }

  }
}

Parameters

Name	Type	Description	Notes
body	SelfShipReturnPickupAttemptRequests		[optional]

Return type

ReturnsActionResponseV2

Authorization

Oauth2SelfAccess

HTTP request headers

Content-Type: application/json
Accept: application/json

rejectSelfShipReturns

ReturnsActionResponseV2 rejectSelfShipReturns(body)

Reject self-ship returns

This operation is used to reject customer self-ship returns.

Example

// Import classes:
package com.flipkart.api.seller.client.client_application;
import com.flipkart.api.seller.client.ApiClient;
import com.flipkart.api.seller.client.ApiException;
import com.flipkart.api.seller.client.Environment;
import com.flipkart.api.seller.client.UrlConfiguration;
import com.flipkart.api.seller.client.access_token_generation.AccessTokenGenerator;
import com.flipkart.api.seller.client.api.ReturnsV2Api;
import com.flipkart.api.seller.client.model.ReturnsActionResponseV2;
import com.flipkart.api.seller.client.model.ReturnsRejectRequest;

public class MyFlipkartApplication {

  public static void main(String[] args) {

    //Access Token Generation
    AccessTokenGenerator accessTokenGenerator = new AccessTokenGenerator();

    //choose environment SANDBOX or PROD
    String env = String.valueOf(Environment.SANDBOX);
    UrlConfiguration urlConfiguration = new UrlConfiguration(env);

    //Replace the below values with your client id and client secret here
    accessTokenGenerator.clientCredentials("__client_id__",
        "__client_secret__");
    String accessToken = AccessTokenGenerator.getClientCredentialsAccessToken();
    System.out.println("Your Access Token: " + accessToken);

    //client call
    ApiClient apiClient = new ApiClient();
    apiClient.setAccessToken(accessToken);

    ReturnsV2Api apiInstance = new ReturnsV2Api(apiClient);
    ReturnsRejectRequest body = new ReturnsRejectRequest(); // ReturnsRejectRequest |
    try {
      ReturnsActionResponseV2 result = apiInstance.rejectSelfShipReturns(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReturnsV2Api#rejectSelfShipReturns");
      e.printStackTrace();
    }


  }
}

Parameters

Name	Type	Description	Notes
body	ReturnsRejectRequest		[optional]

Return type

ReturnsActionResponseV2

Authorization

Oauth2SelfAccess

HTTP request headers

Content-Type: application/json
Accept: application/json

returnComplete

ReturnsActionResponseV2 returnComplete(body)

Update self-ship returns as complete

This operation is used to mark the self-ship returns as complete.

Example

package com.flipkart.api.seller.client.client_application;
import com.flipkart.api.seller.client.ApiClient;
import com.flipkart.api.seller.client.ApiException;
import com.flipkart.api.seller.client.Environment;
import com.flipkart.api.seller.client.UrlConfiguration;
import com.flipkart.api.seller.client.access_token_generation.AccessTokenGenerator;
import com.flipkart.api.seller.client.api.ReturnsV2Api;
import com.flipkart.api.seller.client.model.ReturnsActionResponseV2;
import com.flipkart.api.seller.client.model.SelfShipReturnCompleteRequest;

public class MyFlipkartApplication {

  public static void main(String[] args) {

    //Access Token Generation
    AccessTokenGenerator accessTokenGenerator = new AccessTokenGenerator();

    //choose environment SANDBOX or PROD
    String env = String.valueOf(Environment.SANDBOX);
    UrlConfiguration urlConfiguration = new UrlConfiguration(env);

    //Replace the below values with your client id and client secret here
    accessTokenGenerator.clientCredentials("__client_id__",
        "__client_secret__");
    String accessToken = AccessTokenGenerator.getClientCredentialsAccessToken();
    System.out.println("Your Access Token: " + accessToken);

    //client call
    ApiClient apiClient = new ApiClient();
    apiClient.setAccessToken(accessToken);

    ReturnsV2Api apiInstance = new ReturnsV2Api(apiClient);
    SelfShipReturnCompleteRequest body = new SelfShipReturnCompleteRequest(); // SelfShipReturnCompleteRequest |
    try {
      ReturnsActionResponseV2 result = apiInstance.returnComplete(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ReturnsV2Api#returnComplete");
      e.printStackTrace();
    }


  }
}

Parameters

Name	Type	Description	Notes
body	SelfShipReturnCompleteRequest		[optional]

Return type

ReturnsActionResponseV2

Authorization

Oauth2SelfAccess

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

ReturnsV2Api.md

Latest commit

History

ReturnsV2Api.md

File metadata and controls

ReturnsV2Api

approveSelfShipReturns

Example

Parameters

Return type

Authorization

HTTP request headers

cancelSelfShipReturn

Example

Parameters

Return type

Authorization

HTTP request headers

getReturns

Example

Parameters

Return type

Authorization

HTTP request headers

pickup

Example

Parameters

Return type

Authorization

HTTP request headers

pickupAttempt

Example

Parameters

Return type

Authorization

HTTP request headers

rejectSelfShipReturns

Example

Parameters

Return type

Authorization

HTTP request headers

returnComplete

Example

Parameters

Return type

Authorization

HTTP request headers