Get E-Way Bill

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no} \
  --header 'authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}"

headers = {
    "authorization": "<api-key>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {authorization: '<api-key>', 'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<api-key>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}")
  .header("authorization", "<api-key>")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "data": {
    "data": {
      "VehiclListDetails": [
        {
          "enteredDate": "01/05/2024 07:00:00 PM",
          "fromPlace": "FRAZER TOWN",
          "fromState": 27,
          "groupNo": "0",
          "transDocDate": null,
          "transDocNo": "",
          "transMode": "1",
          "tripshtNo": 0,
          "updMode": "API",
          "userGSTINTransin": "27AAACQ3770E004",
          "vehicleNo": "PVC1234"
        }
      ],
      "actFromStateCode": 27,
      "actToStateCode": 29,
      "actualDist": 1000,
      "cessNonAdvolValue": 400,
      "cessValue": 400.56,
      "cgstValue": 0,
      "docDate": "15/12/2017",
      "docNo": "7001-8",
      "docType": "INV",
      "ewayBillDate": "01/05/2024 07:00:00 PM",
      "ewbNo": 291010077005,
      "extendedTimes": 0,
      "fromAddr1": "2ND CROSS NO 59  19  A",
      "fromAddr2": "GROUND FLOOR OSBORNE ROAD",
      "fromGstin": "29AAACQ3770E000",
      "fromPincode": 400027,
      "fromPlace": "FRAZER TOWN",
      "fromStateCode": 27,
      "fromTrdName": "welton",
      "genMode": "API",
      "igstValue": 300.67,
      "itemList": [
        {
          "cessNonAdvol": 0,
          "cessRate": 3,
          "cgstRate": 0,
          "hsnCode": 1001,
          "igstRate": 3,
          "itemNo": 1,
          "productDesc": "Wheat",
          "productId": 0,
          "productName": "Wheat",
          "qtyUnit": "BOX",
          "quantity": 4,
          "sgstRate": 0,
          "taxableAmount": 5609889
        }
      ],
      "noValidDays": 5,
      "otherValue": -100,
      "rejectStatus": "N",
      "sgstValue": 0,
      "status": "ACT",
      "subSupplyType": "1  ",
      "supplyType": "O",
      "toAddr1": "Shree Nilaya",
      "toAddr2": "Dasarahosahalli",
      "toGstin": "27AAACQ3770E000",
      "toPincode": 560090,
      "toPlace": "Beml Nagar",
      "toStateCode": 29,
      "toTrdName": "sthuthya",
      "totInvValue": 68358,
      "totalValue": 56099,
      "transactionType": 4,
      "transporterId": "27AAACQ3770E004",
      "transporterName": "Acme Industries Private Limited",
      "userGstin": "29AAACQ3770E000",
      "validUpto": "06/05/2024 11:59:00 PM",
      "vehicleType": "R"
    },
    "status": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "6dddbe8f-147f-4678-88b6-003f112854d7"
}

GET

gst

compliance

e-way-bill

tax-payer

bill

{ewb_no}

Get E-Way Bill

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no} \
  --header 'authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}"

headers = {
    "authorization": "<api-key>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {authorization: '<api-key>', 'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<api-key>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}")
  .header("authorization", "<api-key>")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "data": {
    "data": {
      "VehiclListDetails": [
        {
          "enteredDate": "01/05/2024 07:00:00 PM",
          "fromPlace": "FRAZER TOWN",
          "fromState": 27,
          "groupNo": "0",
          "transDocDate": null,
          "transDocNo": "",
          "transMode": "1",
          "tripshtNo": 0,
          "updMode": "API",
          "userGSTINTransin": "27AAACQ3770E004",
          "vehicleNo": "PVC1234"
        }
      ],
      "actFromStateCode": 27,
      "actToStateCode": 29,
      "actualDist": 1000,
      "cessNonAdvolValue": 400,
      "cessValue": 400.56,
      "cgstValue": 0,
      "docDate": "15/12/2017",
      "docNo": "7001-8",
      "docType": "INV",
      "ewayBillDate": "01/05/2024 07:00:00 PM",
      "ewbNo": 291010077005,
      "extendedTimes": 0,
      "fromAddr1": "2ND CROSS NO 59  19  A",
      "fromAddr2": "GROUND FLOOR OSBORNE ROAD",
      "fromGstin": "29AAACQ3770E000",
      "fromPincode": 400027,
      "fromPlace": "FRAZER TOWN",
      "fromStateCode": 27,
      "fromTrdName": "welton",
      "genMode": "API",
      "igstValue": 300.67,
      "itemList": [
        {
          "cessNonAdvol": 0,
          "cessRate": 3,
          "cgstRate": 0,
          "hsnCode": 1001,
          "igstRate": 3,
          "itemNo": 1,
          "productDesc": "Wheat",
          "productId": 0,
          "productName": "Wheat",
          "qtyUnit": "BOX",
          "quantity": 4,
          "sgstRate": 0,
          "taxableAmount": 5609889
        }
      ],
      "noValidDays": 5,
      "otherValue": -100,
      "rejectStatus": "N",
      "sgstValue": 0,
      "status": "ACT",
      "subSupplyType": "1  ",
      "supplyType": "O",
      "toAddr1": "Shree Nilaya",
      "toAddr2": "Dasarahosahalli",
      "toGstin": "27AAACQ3770E000",
      "toPincode": 560090,
      "toPlace": "Beml Nagar",
      "toStateCode": 29,
      "toTrdName": "sthuthya",
      "totInvValue": 68358,
      "totalValue": 56099,
      "transactionType": 4,
      "transporterId": "27AAACQ3770E004",
      "transporterName": "Acme Industries Private Limited",
      "userGstin": "29AAACQ3770E000",
      "validUpto": "06/05/2024 11:59:00 PM",
      "vehicleType": "R"
    },
    "status": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "6dddbe8f-147f-4678-88b6-003f112854d7"
}

NIC validations

View NIC validations

E-way bill number should be 12 digit and valid.
Requestor GSTIN has to be supplier GSTIN or recipient GSTIN or transporter GSTIN/TRANSIN in that e-way bill.
Get E Way Bill Response will have additional parameter transactionType indicating the Transaction type.

Response schema

For successful responses, this reference describes the NIC E-Way Bill payload at data.data.

View JSON schema

Authorizations

authorization

string

header

required

E-Way Bill taxpayer access token returned by Authenticate.

x-api-key

string

header

required

Sandbox API key from your Sandbox account.

Headers

x-source

enum<string>

default:primary

NIC server for the session used by this request. primary selects NIC1. secondary selects NIC2. Defaults to primary. See NIC1 and NIC2 routing.

Available options:

primary,

secondary

Example:

"primary"

x-proxy

enum<string>

NIC server that receives the request. If omitted, the request goes to the server selected by x-source. When specified, selects the other server. See NIC1 and NIC2 routing.

Available options:

primary,

secondary

Example:

"secondary"

x-api-version

string

default:1.0.0

API version

Path Parameters

ewb_no

string

required

Response

200 - application/json

200 EWB fetched / 357 EWB data not available / 200 Fetch rejected EWB

Option 1
Option 2

An E-Way Bill success or NIC business-failure response. Both variants use HTTP 200.

code

enum<integer>

required

NIC response code.

Available options:

200

timestamp

integer<int64>

required

Unix timestamp.

transaction_id

string

required

Request transaction identifier.

data

object

required

Show child attributes

Analytics

Compliance

Annexures

Get E-Way Bill

NIC validations

Response schema

View JSON schema

Authorizations

Headers

Path Parameters

Response