Overview

This API takes in the gstin of the Requester(Taxpayer or Transporter) and E-Way bill number to give the details of the E-Way bill.

Endpoint

HTTP Method	Resource
`Get`	/ewb/tax-payer/seller/bills/{ewb_no}

Request

Follow the below guidelines to pass the below parameters to call the API.

Headers

Param	Type	Description	Example
x-api-key	`string`	An API key is a public key to identify users when calling any Sandbox API.	key_live_ZUQT5UEf4......
Authorization	`string`	JWT Authorization token which is generated using E-Way Bill Authentication API.	eyJhsebihGyUf......

Path Parameters

Param	Type	Description	Example
ewb_no	`string`	E-way bill number	131001298692

Once the values are added, Your curl will look something like this

curl --request GET \
     --url https://api.sandbox.co.in/ewb/tax-payer/seller/bills/131001298692 \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0'

Response

Param	Type	Description	Examples
ewbNo	`num`	E-way bill Generated	131000026768
ewayBillDate	`string`	E-Way bill date	26/09/2018 02:40:00 PM
genMode	`string`	Mode of generation of E-Way Bill Possible Value - `API` : Application Programming Interface`Exc`: Bulk Upload `SMS`: SMS Facility `APP`: Mobile APP `WEB`: Web-based system	API
userGstin	`string`	GSTIN of the user
supplyType	`string`	Supply whether it is outward/inward. Possible value - `I` : Inward `O` : Outward	O
subSupplyType	`string`	Sub types of Supply Possible value - `1` : Supply `2` : Import `3` : Export `4` : Job Work `5` : For own use `6` : Job Work Returns `7` : Sales Return `8` : Others `9` : SKD/CKD/Lots `10` : Line Sales `11` : Recipient not known `12` : Exhibition or Fairs	Import
docType	`string`	Document Type Possible value - `INV` : Tax Invoice `BIL` : Bill of Supply `BOE` : Bill of Entry `CHL` : Delivery Challan `OTH` : Others	Delivery Challan
docNo	`string`	Document No	12
docDate	`string`	Document Date	12/09/2017
fromGstin	`string`	GSTIN of the Consignor	29AAAAA0300L1Z8
fromTrdName	`string`	LegalName of consignor	ABHYUDHYA CO OP BANK
fromAddr1	`string`	Address of consignor - Line 1	Shambhai Fortune
fromAddr2	`string`	Address of consignor - Line 2	Behind KSRTC Bus Stop
fromPlace	`string`	Place of consignor	Bengaluru
fromPincode	`num`	Pin code of consignor	576101
fromStateCode	`num`	State of consignor Possible value - `1` : JAMMU AND KASHMIR `2` : HIMACHAL PRADESH `3` : PUNJAB `4` : CHANDIGARH `5` : UTTARAKHAND `6` : HARYANA `7` : DELHI `8` : RAJASTHAN `9` : UTTAR PRADESH `10` : BIHAR `11` : SIKKIM `12` : ARUNACHAL PRADESH `13` : NAGALAND `14` : MANIPUR `15` : MIZORAM `16` : TRIPURA `17` : MEGHALAYA `18` : ASSAM `19` : WEST BENGAL `20` : JHARKHAND `21` : ORRISA `22` : CHATTISGARH `23` : MADHYA PRADESH `24` : GUJARAT `26` : DADAR AND NAGAR HAVELI & DAMAN AND DIU `27` : MAHARASHTRA `29` : KARNATAKA `30` : GOA `31` : LAKSHADWEEP `32` : KERELA `33` : TAMIL NADU `34` : PUDUCHERRY `35` : ANDAMAN AND NICOBAR `36` : TELENGANA `37` : ANDHRA PRADESH `38` : LADAKH `97` : OTHER TERRITORY `99` : OTHER COUNTRY	KARNATAKA
actFromStateCode	`num`	State of Supply Possible value - `1` : JAMMU AND KASHMIR `2` : HIMACHAL PRADESH `3` : PUNJAB `4` : CHANDIGARH `5` : UTTARAKHAND `6` : HARYANA `7` : DELHI `8` : RAJASTHAN `9` : UTTAR PRADESH `10` : BIHAR `11` : SIKKIM `12` : ARUNACHAL PRADESH `13` : NAGALAND `14` : MANIPUR `15` : MIZORAM `16` : TRIPURA `17` : MEGHALAYA `18` : ASSAM `19` : WEST BENGAL `20` : JHARKHAND `21` : ORRISA `22` : CHATTISGARH `23` : MADHYA PRADESH `24` : GUJARAT `26` : DADAR AND NAGAR HAVELI & DAMAN AND DIU `27` : MAHARASHTRA `29` : KARNATAKA `30` : GOA `31` : LAKSHADWEEP `32` : KERELA `33` : TAMIL NADU `34` : PUDUCHERRY `35` : ANDAMAN AND NICOBAR `36` : TELENGANA `37` : ANDHRA PRADESH `38` : LADAKH `97` : OTHER TERRITORY `99` : OTHER COUNTRY	CHANDIGARH
toGstin	`string`	GSTIN of consignee	29ACGPI2251K1ZJ
toTrdname	`string`	Legal name of consignee	INDER CHHAJER
toAddr1	`string`	Address of consignee - Line 1	PRIYADARSHANI LAYOUT
toAddr2	`string`	Address of consignee- Line 2	MUDALAYAPALYA
toPlace	`string`	Place of consignee	Bengaluru
toPincode	`num`	Pincode of the consignee	560072
toStateCode	`num`	State of Supply Possible value - `1` : JAMMU AND KASHMIR `2` : HIMACHAL PRADESH `3` : PUNJAB `4` : CHANDIGARH `5` : UTTARAKHAND `6` : HARYANA `7` : DELHI `8` : RAJASTHAN `9` : UTTAR PRADESH `10` : BIHAR `11` : SIKKIM `12` : ARUNACHAL PRADESH `13` : NAGALAND `14` : MANIPUR `15` : MIZORAM `16` : TRIPURA `17` : MEGHALAYA `18` : ASSAM `19` : WEST BENGAL `20` : JHARKHAND `21` : ORRISA `22` : CHATTISGARH `23` : MADHYA PRADESH `24` : GUJARAT `26` : DADAR AND NAGAR HAVELI & DAMAN AND DIU `27` : MAHARASHTRA `29` : KARNATAKA `30` : GOA `31` : LAKSHADWEEP `32` : KERELA `33` : TAMIL NADU `34` : PUDUCHERRY `35` : ANDAMAN AND NICOBAR `36` : TELENGANA `37` : ANDHRA PRADESH `38` : LADAKH `97` : OTHER TERRITORY `99` : OTHER COUNTRY
totalValue	`num`	Sum of Taxable value	2000
totInvValue	`num`	Total Invoice Value
cgstValue	`num`	CGST Amount	0
sgstValue	`num`	SGST Amount	0
igstValue	`num`	IGST Amount	240
cessValue	`num`	CESS Amount	20
cessNonAdvolValue	`num`	CESS Non Advol Amount	20
otherValue	`num`	Other Charges if any	0.01
actToStateCode	`num`	State of Supply Possible value - `1` : JAMMU AND KASHMIR `2` : HIMACHAL PRADESH `3` : PUNJAB `4` : CHANDIGARH `5` : UTTARAKHAND `6` : HARYANA `7` : DELHI `8` : RAJASTHAN `9` : UTTAR PRADESH `10` : BIHAR `11` : SIKKIM `12` : ARUNACHAL PRADESH `13` : NAGALAND `14` : MANIPUR `15` : MIZORAM `16` : TRIPURA `17` : MEGHALAYA `18` : ASSAM `19` : WEST BENGAL `20` : JHARKHAND `21` : ORRISA `22` : CHATTISGARH `23` : MADHYA PRADESH `24` : GUJARAT `26` : DADAR AND NAGAR HAVELI & DAMAN AND DIU `27` : MAHARASHTRA `29` : KARNATAKA `30` : GOA `31` : LAKSHADWEEP `32` : KERELA `33` : TAMIL NADU `34` : PUDUCHERRY `35` : ANDAMAN AND NICOBAR `36` : TELENGANA `37` : ANDHRA PRADESH `38` : LADAKH `97` : OTHER TERRITORY `99` : OTHER COUNTRY
fromPlace	`string`	Place of consignor	BANGLORE SOUTH
fromState	`num`	State of Consignor Possible value - `1` : JAMMU AND KASHMIR `2` : HIMACHAL PRADESH `3` : PUNJAB `4` : CHANDIGARH `5` : UTTARAKHAND `6` : HARYANA `7` : DELHI `8` : RAJASTHAN `9` : UTTAR PRADESH `10` : BIHAR `11` : SIKKIM `12` : ARUNACHAL PRADESH `13` : NAGALAND `14` : MANIPUR `15` : MIZORAM `16` : TRIPURA `17` : MEGHALAYA `18` : ASSAM `19` : WEST BENGAL `20` : JHARKHAND `21` : ORRISA `22` : CHATTISGARH `23` : MADHYA PRADESH `24` : GUJARAT `26` : DADAR AND NAGAR HAVELI & DAMAN AND DIU `27` : MAHARASHTRA `29` : KARNATAKA `30` : GOA `31` : LAKSHADWEEP `32` : KERELA `33` : TAMIL NADU `34` : PUDUCHERRY `35` : ANDAMAN AND NICOBAR `36` : TELENGANA `37` : ANDHRA PRADESH `38` : LADAKH `97` : OTHER TERRITORY `99` : OTHER COUNTRY	29
remainingDistance	`num`	remainingDistance	50
transDocNo	`string`	transDocNo	TrnDoc123
transDocDate	`string`	Transporter Document Date	12/09/2017
extnRemarks	`num`	extnRemarks Possible value - `1` : Natural Calamity `2` : Law and Order Situation `4` : Transshipment `5` : Accident `99` : Others	1
transMode	`num`	Mode of Transport Possible value - `1` : Road `2` : Rail `3` : Air `4` : Ship `5` : inTransit	1
extnRsnCode	`num`	extnRsnCode	1
fromPincode	`num`	fromPincode	560090
consignmentStatus	`string`	consignmentStatus Possible value - `M` : inMovement `T` : inTransit	T
transitType	`string`	transitType	R
addressLine1	`string`	addressLine1	Bengaluru
addressLine2	`string`	addressLine2	Bengaluru
addressLine3	`string`	addressLine3	Bengaluru
transporterName	`string`	Name of the Transporter	-
vehicleType	`char`	Type of Vehicle Possible value - `R` : Regular `O` : ODC(Over Dimensional Cargo)	R
validUpto	`string`	Refers to valid date of E-way Bill	26/09/2018 12.00:00 PM
noValidDays	`num`	Number of Valid Days	1
rejectStatus	`char`	Status of Rejection of E-Way Bill	N
actualDist	`num`	Total distance between two transportation points	100
transactionType	`num`	Type of transaction Possible value - `1` : Regular `2` : Bill To - Ship To `3` : Bill From - Dispatch From `4` : Combination of 2 and 3	1
transporterId	`string`	Transporter Id	29BQSPA3829E1Z0
extendedTimes	`num`	Number of Times extended	0
status	`string`	E-Way Bill Status Possbile Values - `ACT`: Active `CNL`: Cancelled `DIS`: Discarded	Active
itemList	`array`	Array of Objects containing Product Details	Look below
vehicleListDetails	`array`	Array of Objects containing Vehicle Details	Look below

itemList

Param	Type	Description	Example
itemNo	`num`	Index number of the item	1
productName	`string`	Name of the Product	Steel
productId	`num`	Id of the Product	0
productDesc	`string`	Description of the Product	5 mm Rod
hsnCode	`num`	HSN Code of the Product	10101
quantity	`num`	Quantity of Product in Numbers	200
qtyUnit	`string`	Unit of the Product, like Liter,Kg etc Possible value - `BAG` : BAGS `BAL` : BALE `BDL` : BUNDLES `BKL` : BUCKLES `BOU` : BILLION OF UNITS `BOX` : BOX `BTL` : BOTTLES `BUN` : BUNCHES `CAN` : CANS `CBM` : CUBIC METERS `CCM` : CUBIC CENTIMETERS `CMS` : CENTI METERS `CTN` : CARTONS `DOZ` : DOZENS `DRM` : DRUMS `GGK` : GREAT GROSS `GMS` : GRAMMES `GRS` : GROSS `GYD` : GROSS YARDS `KGS` : KILOGRAMS `KLR` : KILOLITRE `KME` : KILOMETRE `LTR` : LITRES `MTR` : METERS `MLT` : MILILITRE `MTS` : METRIC TON `NOS` : NUMBERS `OTH` : OTHERS `PAC` : PACKS `PCS` : PIECES `PRS` : PAIRS `QTL` : QUINTAL `ROL` : ROLLS `SET` : SETS `SQF` : SQUARE FEET `SQM` : SQUARE METERS `SQY` : SQUARE YARDS `TBS` : TABLETS `TGM` : TEN GROSS `THD` : THOUSANDS `TON` : TONNES `TUB` : TUBES `UGS` : US GALLONS `UNT` : UNITS `YDS` : YARDS	QTS
taxableAmount	`num`	Taxable Amount	100000
cgstRate	`num`	CGST Rate	9
sgstRate	`num`	SGST Rate	9
igstRate	`num`	IGST Rate	18
cessRate	`num`	CESS Rate	0
cessNonadvol	`num`	Cess Non-Advolerum	0

vehicleListDetails

Param	Type	Description	Example
updMode	`num`	Mode of updation of E-Way Bill Possible Value - `API` : Application Programming Interface `Exc`: Bulk Upload `SMS`: SMS Facility `APP`: Mobile APP `WEB`: Web-based system	API
vehicleNo	`string`	Number of the Vehicle	PQR1234
fromPlace	`string`	Place of Consignor	Bengaluru
fromState	`string`	State of Consignor Possible value - `1` : JAMMU AND KASHMIR `2` : HIMACHAL PRADESH `3` : PUNJAB `4` : CHANDIGARH `5` : UTTARAKHAND `6` : HARYANA `7` : DELHI `8` : RAJASTHAN `9` : UTTAR PRADESH `10` : BIHAR `11` : SIKKIM `12` : ARUNACHAL PRADESH `13` : NAGALAND `14` : MANIPUR `15` : MIZORAM `16` : TRIPURA `17` : MEGHALAYA `18` : ASSAM `19` : WEST BENGAL `20` : JHARKHAND `21` : ORRISA `22` : CHATTISGARH `23` : MADHYA PRADESH `24` : GUJARAT `26` : DADAR AND NAGAR HAVELI & DAMAN AND DIU `27` : MAHARASHTRA `29` : KARNATAKA `30` : GOA `31` : LAKSHADWEEP `32` : KERELA `33` : TAMIL NADU `34` : PUDUCHERRY `35` : ANDAMAN AND NICOBAR `36` : TELENGANA `37` : ANDHRA PRADESH `38` : LADAKH `97` : OTHER TERRITORY `99` : OTHER COUNTRY	29
tripshtNo	`num`	HSN Code of the Product	10101
userGSTINTransin	`string`	User GSTIN	29AAAAA0300L1Z8
enteredDate	`string`	Entered Date of the Transporter	26/09/2018 02:40:00 PM
transMode	`num`	Mode of Transport Possible value - `1` : Road `2` : Rail `3` : Air `4` : Ship `5` : inTransit	1
transDocNo	`string`	Transporter Document number	12-86/3
transDocDate	`string`	Transporter Document Date	12/09/2017
groupNo	`num`	Group Number	1

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since Generate E-Way Bill is a Paid API, a wallet charge of INR 0.25 + GST will take place.

Versioning

This API is currently in major version 1.0. Refer to our versioning policies here