All e-way bill and e-invoice API calls

Get a consolidated e-way bill

POST /v1/ewaybill/consolidated/details

Short answer

Send the 10-digit consolidated e-way bill number and get the trip sheet and every e-way bill on it: vehicle, places, status and each bill's validity.

Cost: 1 credit per call that reaches the government network, including one that finds nothing. A request that never reaches it (missing fields, no credits) is free.

Every call accepts "test_mode": true and returns a sample in the live shape, free. Set up your API credentials before the first real call.

Who can read it

Only the generator of the consolidated e-way bill can read it. Anyone else gets "Could not retrieve data".

After a regeneration

When a consolidated e-way bill is regenerated, the old trip sheet is not edited. It is left with status CNL (cancelled) and a new number is issued. Reading the old number shows CNL, and the new number is in the regenerate response.

Request fields

FieldTypeRequiredMeaning
gstinstringYesThe GSTIN you act as, with API access set up.
gstin_usernamestringYesThe e-way bill API username for that GSTIN. Never stored.
passwordstringYesThe matching API password. Never stored.
consolidated_ewaybill_nostringYesThe 10-digit consolidated e-way bill number.
test_modebooleanNotrue returns a sample in the live shape: free, nothing is filed.

Send your API key in the x-api-key header. Government API credentials are used for the one call and never stored.

Example

The request below runs in test mode, so it is free and files nothing. Remove test_mode for a real call.

curl -X POST "https://www.gstinapi.in/v1/ewaybill/consolidated/details" \
  -H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{ "gstin": "24AAAAA0000A1Z5", "gstin_username": "YOUR_EWB_API_USER", "password": "YOUR_EWB_API_PASSWORD", "consolidated_ewaybill_no": "6664724106", "test_mode": true }'

Response

{
  "success": true,
  "details": {
    "tripSheetNo": 6664724106,
    "fromPlace": "SURAT",
    "vehicleNo": "GJ05AB1234",
    "status": "ACT",
    "tripSheetEwbBills": [
      { "ewbNo": 351000000123, "docNo": "INV-1001", "status": "ACT" },
      { "ewbNo": 351000000456, "docNo": "INV-1002", "status": "ACT" }
    ]
  },
  "billed_to": "paid",
  "credits_remaining": 199
}

Errors you can expect

CodeMessageWhat to do
325Could not retrieve dataNo consolidated e-way bill is available to your GSTIN under that number. It is charged like a match.

All e-way bill API error codes

Questions

Is the response in snake_case?
No. The details object keeps the government network's own field names, passed through unchanged.

Related calls

Create a free accountFull API reference

Not affiliated with the Government of India. Rules are the government network's own and can change; if a page here looks out of date, tell us.