Get E-Waybill PDF

You can use this endpoint to get a PDF version of an E-Waybill.

Request Method

GET

Request URL

{{HOST}}/einv/v2/eInvoice/ewaybill/print

Request Headers

PARAMTER	PARAM TYPE	TYPE	DESCRIPTION
X-Cleartax-Auth-Token	Header	String	Mandatory. The auth token generated from ClearTax user id and password.
gstin	Header	String	Mandatory. User GSTIN

Request Path Params

There are no path parameters for this API.

Request Query Params

Parameter	Data Type	Field Validations	Description
format	String	NA	Available values: PDF, ZIP. Default: zip

Request Body

Parameter	Data Type	TYPE	DESCRIPTION
ewb_numbers	Array	NA	E-WayBill Number
print_type	String	NA	Enum: BASIC, DETAILED

Response Status Codes

HTTP Status Code	Description
200	For a successfully processed request (may be a success or validation error).
401	If the user is not authenticated for the operation.
403	If the user is not authorized for the operation.
500	If there are any unhandled exceptions on the Clear side.

Response Schema

Parameter	Data Type	Field Validations	Description
errorCode	Number	NA	Error Code. If there is no error, then this field will not be present.
errorMessage	String	NA	Error message. If there is no error, then this field will not be present.
errorSource	String	NA	Error Source. If there is no error, then this field will not be present.

Sample Request and Response

Request

{
  "ewb_numbers": [
    151011726811
  ],
  "print_type": "DETAILED"
}

Response - Success:

HTTP Status Code: 200 OK

42KB

basic.pdf

pdf

Basic E-Waybill Print Sample

68KB

detailed.pdf

pdf

Detailed E-Waybill Print Sample

How to save the response as PDF in Postman.

Please use the "save to file" option under save response to view the file as PDF.

Response - Failure:

HTTP Status Code: 200 OK

{
    "error_code": "102",
    "error_message": "No documents with the selected Input are present in the Database;",
    "error_source": "CLEARTAX"
}

API Validations

Currently there are no known validations for this API.

API Constraints

1. Maximum up to 10 E-waybill numbers can be sent in one request.

2. EWB details should be present in ClearTax database