.. _return-label:

GET /v2/returns
------------

**Description** - The Get Returns API provides details of an order item returned by the buyer or undelivered by the courier, and the reason for return. The first call to the API returns max 25 results. Calling the URL returned in the "nextUrl" field of the response gets the subsequent pages of the search result.

Request and Response Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. container:: toggle

    .. container:: header

        **☰ SHOW | HIDE**
    
    **URL:** ``http://api.flipkart.net/sellers/v2/returns?source={source_mode}&modifiedAfter={modified_after}``
    ``&modifiedBefore={modified_before}&createdAfter={created_after}&createdBefore={created_before}``
    ``&locationId={locationId}``

    **Request Header Parameters**

    +------------------+------------+------------+----------------------------------------+
    |Parameter         |Type        |Requirement | Description                            |
    +==================+============+============+========================================+
    |``source``        |String      |Mandatory   |Source of the returns. Possible values: |
    |                  |            |            |``customer_return``, ``courier_return`` |
    +------------------+------------+------------+----------------------------------------+
    |``modifiedAfter`` |ISO String  |Optional    |Get the returns details for orders      |
    |                  |            |            |modified after the date specified       |
    +------------------+------------+------------+----------------------------------------+
    |``modifiedBefore``|ISO String  |Optional    |Get the returns details for orders      |
    |                  |            |            |modified before the date specified      |
    +------------------+------------+------------+----------------------------------------+
    |``createdAfter``  |ISO String  |Optional    |Get the returns details for orders      |
    |                  |            |            |created after the date specified        |
    +------------------+------------+------------+----------------------------------------+
    |``createdBefore`` |ISO String  |Optional    |Get the returns details for orders      |
    |                  |            |            |created before the date specified       |
    +------------------+------------+------------+----------------------------------------+
    |``locationId``    | String     |Optional    |Get the returns details for orders      |
    |                  |            |            |which belongs to sellers specified      |
    |                  |            |            |location                                |
    +------------------+------------+------------+----------------------------------------+
    |``returnIds``     | String     |Optional    |Get the returns details for returns     |
    |                  |            |            |which belongs to sellers with given     |
    |                  |            |            |return ids                              |
    +------------------+------------+------------+----------------------------------------+
    |``trackingIds``   | String     |Optional    |Get the returns details for returns     |
    |                  |            |            |which belongs to sellers with given     |
    |                  |            |            |tracking ids                            |
    +------------------+------------+------------+----------------------------------------+


|

`Try it out! <https://sandbox-api.flipkart.net/swagger/#/Returns%20V2/getReturns>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

|