.. _getForms-label:

GET /v3/shipments/{shipmentIds}/forms
-----------------------------------------

**Description** - This api gives forms associated with the given shipment ids .

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

.. container:: toggle

    .. container:: header

        **☰ SHOW | HIDE**

    **URL:** ``https://api.flipkart.net/sellers/v3/shipments/{shipmentIds}/forms``

    **Request Header Parameters**

    +-----------------+-------------+----------------------+
    | Parameter       | Requirement | Description          |
    +========================+============+================+
    | ``shipmentIds`` | Mandatory   | List of shipment ids |
    +-----------------+-------------+----------------------+

    **Response Body Parameters**

    +---------------------+---------+------------------------------------------------------------------------------------+
    | Parameter/Attribute | Type    | Description                                                                        |
    +=====================+=========+====================================================================================+
    | ``shipmentId``      | String  | Primary identifier for a specific shipment.                                        |
    +---------------------+---------+------------------------------------------------------------------------------------+
    | ``forms.name``      | String  | Name of the for associated with the shipment.                                      |
    +---------------------+---------+------------------------------------------------------------------------------------+
    | ``forms. link``     | String  | Link to the Government portal for where particular form can be generated.          |
    +---------------------+---------+------------------------------------------------------------------------------------+
    | ``forms.automated`` | boolean | True or False indicating Flipkart generated form for the mentioned form.           |
    +---------------------+---------+------------------------------------------------------------------------------------+
    | ``forms.status``    | String  | "Indicates status of form generation. Status can be one of the below (Not created, |
    |                     |         | In-progress,Completed and Failed                                                   |
    +---------------------+---------+------------------------------------------------------------------------------------+

    **Validations** ::

        shipmentIds: should be valid shipment ids for this seller
        Maximum 100 shipment Ids per request.

    **Possible Error Response Codes**

    ================================  =========================
    Error Codes                       Reason for Error
    ================================  =========================
    ``DEPENDENT_SYSTEM_CALL_FAILED``  Error in getting forms for the shipment
    ``UNPROCESSABLE_ENTITY``          When invalid request is received i.e, when more than processable shipments are received.
    ================================  =========================

|

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

|