Generate E-Way Bill by IRN

Generate an E-Way Bill for an e-Invoice by passing the IRN and transportation details.

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

cURL

200 EWB generated (road)

curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/e-invoice/tax-payer/invoice/{irn}/e-way-bill \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "Irn": "20ba3c6f4945944c9c928369fb3047c6985302b17eaefc42eb8183caa99fde6b",
  "Distance": 5,
  "TransMode": "1",
  "TransId": "12AWGPV7107B1Z1",
  "TransName": "trans name",
  "TransDocDt": "01/01/2024",
  "TransDocNo": "TRAN/DOC/11",
  "VehNo": "KA12ER1234",
  "VehType": "R"
}
'

200

200 EWB generated (road)

{
  "code": 200,
  "data": {
    "Data": {
      "EwbDt": "2024-02-22 17:23:00",
      "EwbNo": 171010315489,
      "EwbValidTill": "2024-02-23 23:59:00"
    },
    "ErrorDetails": null,
    "InfoDtls": null,
    "Status": 1
  },
  "timestamp": 1763446641000,
  "transaction_id": "9c7edb84-888a-4117-b743-1ab7fd687e45"
}

Request body schema

View request body 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

Body

application/json

Irn · string · required

Invoice Reference Number

Required string length: 64

Distance · integer<int32> · required

Distance between source and destination PIN codes. Pass 0 to auto calculate

Required range: 0 <= x <= 4000

TransId · string

Transporter number/GSTIN

Required string length: 15

Pattern: ([0-9]{2}[0-9A-Z]{13})

TransName · string

Transporter name

Required string length: 3 - 100

Pattern: ^([^\"])*$

TransMode · enum<string>

Mode of transport. Possible values: 1 - Road, 2 - Rail, 3 - Air, 4 - Ship

Available options: 1, 2, 3, 4

Required string length: 1

Pattern: ^([1-4]{1})?$

TransDocNo · string

Transport Document Number

Required string length: 1 - 15

Pattern: ^([a-zA-Z0-9/-]{1,15})$

TransDocDt · string

Transport Document Date

Required string length: 10

Pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-/]*$

VehNo · string

Vehicle Number

Required string length: 4 - 20

Pattern: ^([A-Z|a-z|0-9]{4,20})$

VehType · enum<string>

Vehicle type. Possible values: O - ODC, R - Regular

Available options: O, R

Required string length: 1

Pattern: ^([O|R]{1})$

ExpShipDtls · object

Show child attributes

DispDtls · object

Show child attributes

Response

200 - application/json

4002 EWB already generated / 2302 Status of IRN is not active / 200 EWB generated (road) / 4009 EWB cannot be generated for Services / 200 Distance auto-calculated / 5002 Invalid distance / 4038 Distance too high / 4012 Transport document number missing / 4039 Vehicle cannot be regular in ship mode / 4020 Invalid vehicle type / 200 EWB generated (ship)

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:

"21f0d4c6-678b-473c-84f4-3c8849a08f1f"

data · object · required

Show child attributes