GST E-Way Bill API
GST E-Way Bill (EWB) is an electronic permit used for tracking the movement of goods under GST. Use this API to authenticate with the E-Way Bill system and generate, fetch, update, extend, cancel, consolidate, and manage multi-vehicle movement of e-way bills programmatically. The GST E-Way Bill API enables automated compliance workflows for goods movement and lets you create and update e-way bills (Part-A/Part-B), track shipments across stakeholders (consignor, consignee, transporter), and maintain audit-ready logistics records.Generate and fetch EWB
Generate e-way bills with Part-A data, items, and transporter details. Fetch bills by date, document data, or EWB number.
Update Part-B and transporter
Update vehicle details (Part-B) or change transporter assignment after generating the e-way bill.
Transporter operations
Transporters can list assigned e-way bills, update vehicle details, and extend validity when delays occur.
Consolidated and multi-vehicle
Create consolidated e-way bills for multiple consignments in one vehicle. Manage multi-vehicle movement for partial deliveries.
Consignee actions
Consignees can view assigned e-way bills and reject incorrect bills for audit compliance.
Master data and troubleshooting
Search GSTIN, transporter IDs, HSN codes, and retrieve error lists for debugging.
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.
Header routing: Use the
x-source header to specify the E-Way Bill server: primary (default), secondary, or tertiary. This helps with load balancing and failover.How it works
Create API credentials
Register API credentials on the E-Way Bill portal to enable programmatic access. See Create API credentials.
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.
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.
Update logistics details
Update Part-B vehicle details when the truck is assigned, or change the transporter using the update APIs.
Track and verify
Fetch e-way bills by EWB number, date range, or document data. Verify bill status across consignor, consignee, and transporter views.
Handle transporter and consignee actions
Transporters can view and manage assigned bills. Consignees can reject incorrect e-way bills to maintain audit compliance.
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:| API | Method | Path |
|---|---|---|
| E-Way Bill Authentication | POST | /gst/compliance/e-way-bill/tax-payer/authenticate |
Consignor APIs
APIs for the goods supplier (consignor) to generate and manage e-way bills:| API | Method | Path |
|---|---|---|
| Generate E-Way Bill | POST | /gst/compliance/e-way-bill/consignor/bill |
| Get E-Way Bills By Date | GET | /gst/compliance/e-way-bill/consignor/bills |
| Get E-Way Bills By Document Data | GET | /gst/compliance/e-way-bill/consignor/bill |
| Cancel E-Way Bill | POST | /gst/compliance/e-way-bill/consignor/bill/{ewb_no}/cancel |
| Extend Validity | POST | /gst/compliance/e-way-bill/consignor/bill/{ewb_no}/extend |
| Update Vehicle Details (Part B) | PUT | /gst/compliance/e-way-bill/consignor/bill/{ewb_no}/vehicle |
| Update Transporter | PUT | /gst/compliance/e-way-bill/consignor/bill/{ewb_no}/transporter |
Consolidated e-way bill (Consignor)
| API | Method | Path |
|---|---|---|
| Consolidate E-Way Bill | POST | /gst/compliance/e-way-bill/consignor/consolidated-bill |
| Get Consolidated Bill | GET | /gst/compliance/e-way-bill/consignor/consolidated-bill/{consolidated_ewb_no} |
| Regenerate Consolidated Bill | POST | /gst/compliance/e-way-bill/consignor/consolidated-bill/{consolidated_ewb_no}/regenerate |
Multi-vehicle movement (Consignor)
| API | Method | Path |
|---|---|---|
| Initiate Multi-Vehicle Movement | POST | /gst/compliance/e-way-bill/consignor/bill/{ewb_no}/multi-vehicle |
| Add Vehicle | POST | /gst/compliance/e-way-bill/consignor/bill/{ewb_no}/multi-vehicle/vehicle |
| Update Vehicle | PUT | /gst/compliance/e-way-bill/consignor/bill/{ewb_no}/multi-vehicle/vehicle |
Consignee APIs
APIs for the goods receiver (consignee) to view and manage assigned e-way bills:| API | Method | Path |
|---|---|---|
| Get E-Way Bills By Date | GET | /gst/compliance/e-way-bill/consignee/bills |
| Reject E-Way Bill | POST | /gst/compliance/e-way-bill/consignee/bill/{ewb_no}/reject |
Transporter APIs
APIs for logistics providers (transporters) to manage e-way bills:| API | Method | Path |
|---|---|---|
| Get E-Way Bills By Date and State | GET | /gst/compliance/e-way-bill/transporter/bills |
| List E-Way Bills By Generator | GET | /gst/compliance/e-way-bill/transporter/bills/by-generator |
| Extend Validity | POST | /gst/compliance/e-way-bill/transporter/bill/{ewb_no}/extend |
| Update Vehicle Details | PUT | /gst/compliance/e-way-bill/transporter/bill/{ewb_no}/vehicle |
| Update Transporter | PUT | /gst/compliance/e-way-bill/transporter/bill/{ewb_no}/transporter |
Consolidated e-way bill (Transporter)
| API | Method | Path |
|---|---|---|
| Consolidate E-Way Bill | POST | /gst/compliance/e-way-bill/transporter/consolidated-bill |
| Get Consolidated Bill | GET | /gst/compliance/e-way-bill/transporter/consolidated-bill/{consolidated_ewb_no} |
| Regenerate Consolidated Bill | POST | /gst/compliance/e-way-bill/transporter/consolidated-bill/{consolidated_ewb_no}/regenerate |
Multi-vehicle movement (Transporter)
| API | Method | Path |
|---|---|---|
| Initiate Multi-Vehicle Movement | POST | /gst/compliance/e-way-bill/transporter/bill/{ewb_no}/multi-vehicle |
| Add Vehicle | POST | /gst/compliance/e-way-bill/transporter/bill/{ewb_no}/multi-vehicle/vehicle |
| Update Vehicle | PUT | /gst/compliance/e-way-bill/transporter/bill/{ewb_no}/multi-vehicle/vehicle |
Common APIs
Shared endpoints for fetching e-way bills, searching master data, and troubleshooting:| API | Method | Path |
|---|---|---|
| Get E-Way Bill | GET | /gst/compliance/e-way-bill/tax-payer/bill/{ewb_no} |
| Get Error List | GET | /gst/compliance/e-way-bill/tax-payer/error-list |
| Get HSN Details | GET | /gst/compliance/e-way-bill/tax-payer/hsn |
| Search GSTIN | POST | /gst/compliance/e-way-bill/tax-payer/gstin/search |
| Search Transporter Id | POST | /gst/compliance/e-way-bill/tax-payer/transin/search |
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?
Consolidated E-Way Bill (CEWB) combines multiple e-way bills into a single document when a transporter carries goods from multiple consignors in one vehicle. CEWB is useful for logistics providers transporting multiple consignments to simplify checkpoint verification. 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 is required when goods covered by a single e-way bill are transported using multiple vehicles. For example, 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?
E-Way Bill API errors can be debugged using the Get Error List endpoint, which returns all error codes and descriptions from the E-Way Bill portal. 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.
What is the x-source header and when should I use primary/secondary/tertiary?
What is the x-source header and when should I use primary/secondary/tertiary?
The
x-source header specifies which E-Way Bill server to route requests to: primary (default), secondary, or tertiary. This header enables load balancing and failover when one server is unavailable or slow. Use primary for normal operations. Switch to secondary or tertiary if you experience timeouts or the primary server is under maintenance. Include this header in all E-Way Bill API requests.