Generate E-Waybill by IRN
You can use this API to generate the e-waybill using Invoice Registration Number (IRN).
Request URL
Request Headers
x-cleartax-auth-token
String
Mandatory. The access token generated for the workspace.
x-cleartax-product
String
Should always be "EInvoice" without the double quotes.
gstin
String
Users GSTIN
Content-Type
String
Mandatory. This will always be "application/json".
Request Parameters:
Parameters
Parameter Type
Type
Validation
Description
Irn
Body
String
minLength: 64
maxLength: 64
Mandatory. IRN generated for the invoice.
TransId
Body
String
minLength: 15
maxLength: 15
pattern: "([0-9]{2}[0-9A-Z]{13})"
Conditional. Transporter GSTIN or CEN (Common Enrollment Number)
TransName
Body
String
minLength: 3
maxLength: 100
pattern: "^([^\\\"])*$"
Optional. Name of the transporter
TransMode
Body
String
minLength: 1
maxLength: 1
enum: ["1", "2", "3", "4"]
Conditional. Mode of transport (Road-1, Rail-2, Air-3, Ship-4)
Distance
Body
Number
minimum: 1
maximum: 4000
Mandatory. Distance between source and destination PIN codes
TransDocNo
Body
String
minLength: 1
maxLength: 15
pattern: "^([a-zA-Z0-9\/-]{1,15})$"
Optional. Tranport Document Number
TransDocDt
Body
String
minLength: 10
maxLength: 10
pattern: "^[0-3][0-9]\/[0-1][0-9]\/[2][0][1-2][0-9]$"
Optional. Transport Document Date
VehNo
Body
String
minLength: 4
maxLength: 20
pattern: "^([A-Z|a-z|0-9]{4,20})$"
Conditional. Vehicle Number
VehType
Body
String
minLength: 1, maxLength: 1,
enum: ["O", "R"],
Conditional. Whether O-ODC or R-Regular
ExpShipDtls
Body
Object
Optional. ExpShipDtls Object.
DispDtls
Body
Object
Optional. Dispatch From Details Object
Export Shipping Details
In case of export of goods, if the E-Waybill has to be generated, then the address of port should have been passed as the shipping address during the generation of IRN.
If during the generation of IRN for export, the shipping address of India is not passed, then the shipping address of the port may be sent now and get the e-way bill generated.
Parameters
Type
Validation
Description
Addr1
string
minLength: 1
maxLength: 100
pattern: "^([^\\\"])*$"
Mandatory. Address1 of the entity to whom the supplies are shipped to. (Building/Flat no., Road/Street etc.)
Addr2
string
minLength: 3
maxLength: 100
pattern: "^([^\\\"])*$"
Optional. Address 2 of the entity to whom the supplies are shipped to. (Floor no., Name of the premises/building).
Loc
string
minLength: 3
maxLength: 100
pattern: "^([^\\\"])*$"
Mandatory. Place (City, Town, Village) entity to whom the supplies are shipped to.
Pin
number
minimum: 100000
maximum: 999999
Mandatory. Pincode
Stcd
string
minLength: 1
maxLength: 2
pattern: "^(?!0+$)([0-9]{1,2})$"
Dispatch From Details Object
If the dispatching address and/or shipping address have not been passed during the generation of IRN, then the respective addresses can be passed here.
Parameters
Type
Validation
Description
Nm
string
minLength: 3,
maxLength: 100,
pattern: "^([^\\\"])*$"
Mandatory. Name of the company from which the goods are dispatched
Addr1
string
minLength: 1
maxLength: 100
pattern: "^([^\\\"])*$"
Mandatory. Address 1 of the entity from which goods are dispatched. (Building/Flat No. Road/Street etc.)
Addr2
string
minLength: 3
maxLength: 100
pattern: "^([^\\\"])*$"
Optional. Address 2 of the entity from which goods are dispatched. (Floor no., Name of the premises/building)
Loc
string
minLength: 3
maxLength: 100
pattern: "^([^\\\"])*$"
Mandatory. Location
Pin
number
minimum: 100000
maximum: 999999
Mandatory. Pincode
Stcd
string
minLength: 1
maxLength: 2
pattern: "^(?!0+$)([0-9]{1,2})$"
Sample Request Body
Response Parameters
Parameter
Type
Description
EwbNo
String
e-waybill Number
EwbDt
String
e-waybill date
EwbValidTill
String
e-waybill validity
Remarks
String
Remarks, if any.
Sample Response
Last updated
Was this helpful?