.. _getReverseOTC-label:

GET /v3/shipments/otc/{locationId}?requestType={requestType}
---------------------------------------------------------

**Description** - This API gives shipments' OTCs based on given location and request type. (Note : This API will be available soon.)

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

.. container:: toggle

    .. container:: header

        **☰ SHOW | HIDE**

    **URL:** ``https://api.flipkart.net/sellers/v3/shipments/otc/{locationId}?requestType={requestType}``

    **Request Header Parameters**

    +-----------------+-------------+------------------------------------------------+
    | Path Parameter  | Requirement | Description                                    |
    +=================+=============+================================================+
    | ``locationId``  | Mandatory   | Id which refers to seller's dispatch location  |
    +-----------------+-------------+------------------------------------------------+

    **Response Body Parameters**

    +----------------------------+------------+----------------------------------------------------------------+
    | Parameter/Attribute        | Type       | Description                                                    |
    +============================+============+================================================================+
    | ``otcs``                   | List       | OTCs                                                           |
    +----------------------------+------------+----------------------------------------------------------------+
    | ``otcs.status``            | String     | Request status for the OTC type                                |
    +----------------------------+------------+----------------------------------------------------------------+
    | ``otcs``. ``requestType``  | String     | OTC type.                                                      |
    |                            |            | Possible values-                                               |
    |                            |            | ``RETURN`` - OTCs for Return Type                              |
    +----------------------------+------------+----------------------------------------------------------------+
    | ``otcs``. ``otc``          | List<OTC>  | List of requested OTCs                                         |
    +----------------------------+------------+----------------------------------------------------------------+
    | ``otcs``. ``otc``. ``type``| String     | Shipment                                                       |
    |                            |            | Possible Values-                                               |
    |                            |            | ``LARGE`` - Shipment Large type                                |
    |                            |            | ``NON_LARGE`` - Non Large type                                 |
    +----------------------------+------------+----------------------------------------------------------------+
    | ``otcs``. ``otc``. ``code``| String     | A One Time Code, that is to be shared with pickup executive,   |
    |                            |            | at the time of handing over / receiving the shipments.         |
    +----------------------------+------------+----------------------------------------------------------------+
    | ``otcs``. ``otc``.         |  String    | Vendor name                                                    |
    | ``vendor``                 |            |                                                                |
    +----------------------------+------------+----------------------------------------------------------------+

    **Possible Error Response Codes**

    ================================  =========================
    Error Codes                       Reason for Error
    ================================  =========================
    ``OTC_NOT_GENERATED``             This occurs when the tripsheet and OTC is not generated.
    ``OTC_UNAVAILABLE``               If the location is not onboarded for OTC
    ``DEPENDENT_SYSTEM_CALL_FAILED``  This error occurs if an internal system fails.
    ================================  =========================

|

`Try it out! <https://sandbox-api.flipkart.net/swagger/#/Shipment%20V3/requestOTC>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

|