Get E-Way Bill by document data

Get E-Way Bill By Document Data

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

import requests

url = "https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/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-way-bill/consignor/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-way-bill/consignor/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-way-bill/consignor/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-way-bill/consignor/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-way-bill/consignor/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": {
      "alert": null,
      "ewayBillDate": "13/05/2024 12:50:00 PM",
      "ewayBillNo": 231010079649,
      "validUpto": "18/05/2024 23:59:59 "
    },
    "status": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "1b6b96a2-1f93-4e29-b1af-2841824c1ffe"
}

GET

gst

compliance

e-way-bill

consignor

bill

Get E-Way Bill By Document Data

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

import requests

url = "https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/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-way-bill/consignor/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-way-bill/consignor/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-way-bill/consignor/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-way-bill/consignor/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-way-bill/consignor/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": {
      "alert": null,
      "ewayBillDate": "13/05/2024 12:50:00 PM",
      "ewayBillNo": 231010079649,
      "validUpto": "18/05/2024 23:59:59 "
    },
    "status": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "1b6b96a2-1f93-4e29-b1af-2841824c1ffe"
}

NIC validations

View NIC validations

This API treats the logged in user as the Generator GSTIN.
Only active E-Waybill will be considered in this API.

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-api-version

string

default:1.0.0

API version

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

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

Query Parameters

document_type

string

required

Document type. Possible values: INV

See E-Way Bill document types.

Example:

"INV"

document_number

string

required

Document number

Example:

"EWB-00001"

Response

200 - application/json

200 EWB fetched / 418 No data found

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 by document data

NIC validations

Response schema

View JSON schema

Authorizations

Headers

Query Parameters

Response

​NIC validations

​Response schema

View JSON schema

Authorizations

Headers

Query Parameters

Response

NIC validations

Response schema