Get E-Waybill Download Status

This API can be used to pull the status of the E-way bills generated by 3rd party against your GSTIN. The API can pull data from the workflow ID provided.

Request URL

GET: {{HOST}}/einv/async_action/{{workflow_id}}/otherparty_ewb_download_status

Request Headers

JSON

x-cleartax-auth-token: {{USER_AUTH_TOKEN}}
gstin:{{gstin_number}}

PARAMETER	PARAM TYPE	TYPE	DESCRIPTION
X-Cleartax-Auth-Token	Header	String	Mandatory. The auth token generated from ClearTax user id and password. Know how.
gstin	Header	String	Mandatory. GSTIN number for the user
workflow_id	Path	String	Mandatory. The workflow ID which is captured from EWB by others response.

Sample Request

NA

Sample Response

JSON Response - SUCCESS

{
    "workflow_id": "61fb6de92b86d943ddf7c25c",
    "status": "PROCESSED",
    "message": "Your E-way bill data was successfully downloaded for 4 Days. Total E-way bills downloaded: 4.",
    "error_message": null,
    "total": 4,
    "failed": 0,
    "success": 4
}

JSON Response - FAILURE

{
    "error_code": "500",
    "error_message": "Something went wrong. Please retry after some time. Contact cleartax support ([e-mail]) if issue persists.",
    "error_source": "CLEARTAX"
}