Get E-Way Bill by IRN

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

import requests

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

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-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: <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-invoice/tax-payer/invoice/{irn}/e-way-bill"

	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-invoice/tax-payer/invoice/{irn}/e-way-bill")
  .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-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"] = '<api-key>'
request["x-api-key"] = '<api-key>'

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

{
  "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"
}

GET

gst

compliance

e-invoice

tax-payer

invoice

{irn}

e-way-bill

Get E-Way Bill by IRN

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

import requests

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

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-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: <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-invoice/tax-payer/invoice/{irn}/e-way-bill"

	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-invoice/tax-payer/invoice/{irn}/e-way-bill")
  .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-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"] = '<api-key>'
request["x-api-key"] = '<api-key>'

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

{
  "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"
}

NIC validations

View NIC validations

If e-commerce wants to Get the RCM Invoice details, in the headers the supplier GSTIN value should be the Recipient GSTIN.

Response schema

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

View JSON schema

Authorizations

authorization

string

header

required

E-invoice 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

irn

string

required

Query Parameters

supplier_gstin

string

Supplier GSTIN when an e-commerce operator acts on behalf of the supplier. For reverse charge mechanism (RCM) invoices, this is the recipient GSTIN.

Response

200 - application/json

200 Get EWB / 4005 EWB not found

Successful E-Way Bill by IRN response
NIC e-Invoice business error

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

Analytics

Compliance

Annexures

Get E-Way Bill by IRN

NIC validations

Response schema

View JSON schema

Authorizations

Headers

Path Parameters

Query Parameters

Response

​NIC validations

​Response schema

View JSON schema

Authorizations

Headers

Path Parameters

Query Parameters

Response

NIC validations

Response schema