Basic E-way Bill APIs#

Basic E-way Bill APIs module provides a one-to-one mapping with the existing APIs in the E-way Bill system.

For a complete list of the APIs available in the module, check the official documentation.

APIs#

Headers#

Header Key Name	Description
Content-Type	It used to indicate the media type of the resource in the request for example: `application/json` for json document exchange
accept	It used to request the media type of the resource expected in the response for example: `application/json` for json document exchange
X-FLYNN-N-EWB-GSP-CODE	GSP Identifier: enum (“vay”)
X-FLYNN-N-EWB-GSTIN	GSTIN of the taxpayer
X-FLYNN-N-EWB-USERNAME	Portal username associated with taxpayer GSTIN for the GSP, Non-sensitive
X-FLYNN-N-EWB-PWD	Portal password associated with GSTIN and Username for the GSP, Non-Sensitive

Optionally if you want to encrypt the password you can use following headers instead of X-FLYNN-N-EWB-PWD

Header Key Name	Description
X-FLYNN-S-REK	Request Encryption Key - refer here optional, to be used when you want to encrypt the password
X-FLYNN-S-EWB-PWD	Portal password associated with GSTIN and Username for the GSP, Sensitive

With, addition to the headers described above also set all required headers to make an authenticated API call.

required headers for all EWB API calls

Content-Type
accept
X-FLYNN-N-ORG-ID
X-FLYNN-N-USER-TOKEN
X-FLYNN-N-EWB-GSP-CODE
X-FLYNN-N-EWB-GSTIN
X-FLYNN-N-EWB-USERNAME
X-FLYNN-S-EWB-PWD / X-FLYNN-N-EWB-PWD
X-FLYNN-S-REK (optional, use it in case if you wish to encrypt the password in the header)

Common Errors#

There could be multiple types of errors when interacting with basic e-way bill APIs. However, the structure of the error payload would remain same.

Note that in the given example, 382 is error code from E-way bill system.

Http Status Code: 502

{
  "error": {
    "message": "err-ewb-returned-error",
    "type": "Ewb",
    "args": {
      "status": "0",
      "error-text": "{\"errorCodes\":\"382\"}"
    }
  }
}

400 Bad Request

{
    "error": {
        "message": "err-invalid-data",
        "type": "ClientRequest",
        "args": {
            "errors": [
                "toGstin invalid URP gstin"
            ]
        }
    }
}

Common Errors for v3.0 API#

There could be multiple types of errors when interacting with basic e-way bill APIs. However, the structure of the error payload would remain same.

Note that in the given example, 382 is error code from E-way bill system.

Http Status Code: 502

{
"status": "0",
"data": null,
"error": {
    "message": "err-ewb-returned-error",
    "type": "Ewb",
    "args": {
        "details": [
            {
                "ErrorCode": "604",
                "ErrorMessage": null
            }
        ]
    }
},
"info": "",
"additionalInfo": null,
"alert": null
}

400 Bad Request

{
    "status": "0",
    "data": null,
    "error": {
        "message": "err-invalid-data",
        "type": "ClientRequest",
        "args": {
            "errors": [
                "toGstin invalid URP gstin"
            ]
        }
    },
    "info": null,
    "additionalInfo": null,
    "alert": null
}