Get E-Way Bill by IRN

Fetch the E-Way Bill created by passing the invoice registration number (IRN).

GET /gst/compliance/e-invoice/tax-payer/invoice/{irn}/e-way-bill

Get E-Way Bill by IRN

cURL

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

import requests

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

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

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

print(response.text)

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

fetch('https://api.sandbox.co.in/gst/compliance/e-invoice/tax-payer/invoice/{irn}/e-way-bill', 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-invoice/tax-payer/invoice/{irn}/e-way-bill",
  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: <authorization>",
    "x-api-key: <x-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-invoice/tax-payer/invoice/{irn}/e-way-bill"

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

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("x-api-key", "<x-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-invoice/tax-payer/invoice/{irn}/e-way-bill")
  .header("authorization", "<authorization>")
  .header("x-api-key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

200 Get EWB

{
  "code": 200,
  "data": {
    "Data": {
      "EwbDt": "2023-03-30 17:46:00",
      "EwbNo": 601010206231,
      "EwbValidTill": "2023-03-31 23:59:00",
      "GenGstin": "24AAAPI3182M002",
      "Status": "ACT"
    },
    "ErrorDetails": null,
    "InfoDtls": null,
    "Status": 1
  },
  "timestamp": 1763446641000,
  "transaction_id": "9266ba6d-6f2a-4d67-9ec1-9229b2c612e5"
}

Response schema

For successful responses, this resource describes the NIC payload at data.Data.

View JSON schema

Headers

authorization · string · required

E-Invoice access token. For token-generation steps, refer to the Generate E-Invoice Session recipe, then pass the token in the authorization header.

x-source · enum<string> · default: primary

Specifies the source to access, either primary (NIC 1) or secondary (NIC 2)

Available options: primary, secondary

Example:

"primary"

x-proxy · enum<string>

Enables criss-cross operations by routing requests through the specified source (e.g., access primary via secondary if primary is unavailable)

Available options: primary, secondary

Example:

"secondary"

x-api-version · string · default: 1.0.0

API version

x-api-key · string · required

API key for identification

Path Parameters

irn · string · required

Response

200 - application/json

200 Get EWB / 4005 EWB not found

Option 1

Option 2

A successful NIC response or a NIC business-error response. Both variants use HTTP 200.

code · enum<integer> · required

HTTP-compatible Sandbox response code.

Available options: 200

Example:

200

timestamp · integer<int64> · required

Unix timestamp in milliseconds.

Example:

1763446641000

transaction_id · string · required

Request transaction identifier.

Example:

"9266ba6d-6f2a-4d67-9ec1-9229b2c612e5"

data · object · required

Show child attributes