GST E-Way Bill API
GST E-Way Bill (EWB) is an electronic permit required for transporting goods worth more than INR 50,000 under GST. Use this API to generate, update, extend, cancel, and manage e-way bills programmatically—enabling automated compliance workflows for goods movement across consignor, consignee, and transporter roles.Shared session
Use the same access token for e-Invoice and E-Way Bill APIs.
Generate and manage EWB
Generate, fetch, cancel, or extend e-way bills. Update Part B vehicle details and transporter assignments.
Consolidated and multi-vehicle
Group multiple e-way bills carried in one vehicle, or split one e-way bill’s consignment across multiple vehicles.
Consignee actions
View e-way bills generated against your GSTIN by other parties, and reject incorrect bills.
Prerequisites
Before using the E-Way Bill API:- API credentials: Create API credentials on the E-Way Bill portal. See Create API credentials.
- Sandbox JWT token: Authenticate with Sandbox to get an access token.
- E-Way Bill session: Authenticate with the E-Way Bill portal to get an EWB access token.
How it works
1
Create API credentials
Register API credentials on the E-Way Bill portal to enable programmatic access. See Create API credentials.
2
Authenticate for E-Way Bill access
Use the E-Way Bill Authentication endpoint with your portal username, password, and GSTIN to get an access token.
3
Generate E-Way Bill
Create an e-way bill with Part-A data (invoice details, HSN codes, values) and optionally include transporter and vehicle details.
4
Update logistics details
Update Part-B vehicle details when the truck is assigned, or change the transporter using the update APIs.
5
Track and verify
Fetch e-way bills by EWB number, date range, or document data. Verify bill status across consignor, consignee, and transporter views.
6
Handle transporter and consignee actions
Transporters can manage assigned e-way bills. Consignees can reject incorrect e-way bills generated by other parties against their GSTIN.
7
Advanced movement and troubleshooting
Create consolidated e-way bills for multiple shipments. Use multi-vehicle movement for partial deliveries. Check the error list for troubleshooting.
Quick links
Quick access to common E-Way Bill starting points:Generate E-Way Bill session
Authenticate with the E-Way Bill portal and get an access token for API operations.
Generate E-Way Bill
Create a new e-way bill with invoice and transporter details.
API categories
Authentication
Authenticate with the E-Way Bill portal to start a session.
Consignor APIs
Generate, update, cancel, and extend e-way bills as the goods supplier.
Consignee APIs
View and reject e-way bills as the goods receiver.
Transporter APIs
List, update, and extend e-way bills as the logistics provider.
Consolidated EWB
Create and manage consolidated e-way bills for multiple consignments.
Common APIs
Fetch e-way bills, search GSTIN, HSN codes, and get error lists.
Authentication
Authenticate with the E-Way Bill portal to start a session:Consignor APIs
APIs for the goods supplier (consignor) to generate and manage e-way bills:Consolidated e-way bill (Consignor)
Multi-vehicle movement (Consignor)
Consignee APIs
APIs for consignees to view e-way bills generated against their GSTIN by other parties and reject incorrect bills:Transporter APIs
APIs for logistics providers (transporters) to manage e-way bills:Consolidated e-way bill (Transporter)
Multi-vehicle movement (Transporter)
Common APIs
Shared endpoints for fetching e-way bills, searching master data, and troubleshooting:Master data and error codes
E-Way Bill master data
Find supply, document, transport, vehicle, unit, cancellation, and validity-extension codes for E-Way Bill requests.
E-Way Bill error codes
Find standalone E-Way Bill errors returned in
error.errorCodes, including authentication, validation, and goods-movement errors.Common use cases
Use the GST E-Way Bill API when you need to:- Generate e-way bills for outbound shipments when an invoice is created in an ERP (manufacturing or wholesale dispatch)
- Update Part-B vehicle details when the truck is assigned late or the vehicle changes mid-transit
- Extend e-way bill validity when delays occur due to breakdown, rerouting, weather, or roadblocks based on remaining distance
- Create a consolidated e-way bill for a transporter carrying multiple consignments in one vehicle for faster checkpoint verification
- Use multi-vehicle movement when one e-way bill’s goods are moved in parts across multiple vehicles (partial deliveries or hub transfers)
- Allow consignees to reject an incorrect e-way bill (wrong GSTIN or invoice mapping) and keep records auditable
Frequently asked questions
What is a GST e-way bill (EWB) and why is it needed?
What is a GST e-way bill (EWB) and why is it needed?
GST E-Way Bill (EWB) is an electronic permit required for transporting goods worth more than INR 50,000 under the GST regime. The e-way bill system tracks goods movement across state and intra-state borders, ensuring tax compliance and reducing tax evasion. Both the consignor (supplier) and transporter must generate or carry a valid e-way bill during transit.
How does GST E-Way Bill API authentication work?
How does GST E-Way Bill API authentication work?
GST E-Way Bill API authentication requires two steps. First, authenticate with Sandbox to get a JWT access token. Then, use the E-Way Bill Authentication endpoint with your E-Way Bill portal username, password, and GSTIN to get an EWB access token. This token is used for all subsequent e-way bill operations. See the Generate E-Way Bill session recipe for a complete walkthrough.
Which APIs should a consignor use to generate and manage an e-way bill?
Which APIs should a consignor use to generate and manage an e-way bill?
Consignors (goods suppliers) use the Generate E-Way Bill endpoint to create e-way bills with Part-A invoice data. After generation, consignors can Update Vehicle Details to add Part-B data, Update Transporter to change logistics provider, Extend Validity for delays, or Cancel E-Way Bill if needed.
How can a transporter update vehicle details or extend validity?
How can a transporter update vehicle details or extend validity?
Transporters can update vehicle details using the Update Vehicle Details endpoint when a vehicle changes mid-transit. To extend validity due to transit delays, transporters use the Extend Validity endpoint with the remaining distance. Transporters can also list all assigned e-way bills using Get E-Way Bills By Date and State.
How do consolidated e-way bills work and when should I use them?
How do consolidated e-way bills work and when should I use them?
A consolidated e-way bill (CEWB) groups multiple e-way bills carried in one vehicle. Use the Consolidate E-Way Bill endpoint to create a CEWB and Get Consolidated Bill to fetch details.
What is multi-vehicle movement and when is it required?
What is multi-vehicle movement and when is it required?
Multi-vehicle movement applies when goods covered by a single e-way bill are transported using multiple vehicles—for example, in partial deliveries or hub-to-hub transfers. Use Initiate Multi-Vehicle Movement to start multi-vehicle mode, then Add Vehicle for each additional vehicle in the shipment chain.
How do I troubleshoot E-Way Bill API errors?
How do I troubleshoot E-Way Bill API errors?
Find E-Way Bill business errors in E-Way Bill error codes, or retrieve supported codes and descriptions with Get Error List. For general API error handling patterns and HTTP status codes, see the Errors guide. Common issues include invalid GSTIN format, expired sessions, and missing Part-B data.
How do I select NIC1 or NIC2?
How do I select NIC1 or NIC2?
See NIC1 and NIC2 routing for
x-source, x-proxy, and existing-session examples.