How to Start
- Go to Credentials > Use Sandbox Keys Click here
- Go to Credentials > Use Production Keys ( Top-up or Renew GST APIs)
- Start using Perione e-Way Bill Client ID & Client Secret ID Credentials for your Sandbox Testing
- e-Way Bill API Integration Demo, Click here
API Documentation
- e-Way Bill Help Document Click Here
- Error Codes Click Here
- SSL Certificate Click Here
- Master List Click Here
- e-Way Bill Documentation Download
GET Authentication API
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| username * required | User Name | (query) | string | |
| password * required | Password | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code:
Server Response
POST Generate Eway Bill
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN Number | (header) | string |
Request Body (JSON) * required
Curl
Request URL
Status Code:
Server Response
POST Update PART-B/Vehicle Number
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Request Body (JSON) * required
Curl
Request URL
Status Code
Server Response
POST Generate Consolidated Ewaybill
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Request Body (JSON) * required
Curl
Request URL
Status Code
Server Response
POST Cancel E-Way bill
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Request Body (JSON) * required
Curl
Request URL
Status Code
Server Response
POST Reject EwayBill
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Request Body (JSON) * required
Curl
Request URL
Status Code
Server Response
POST Update Transporter
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Request Body (JSON) * required
Curl
Request URL
Status Code
Server Response
POST Extend Validity of E-Way Bill
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Request Body (JSON) * required
Curl
Request URL
Status Code
Server Response
POST Regenerate Consolidated E-Way Bill - Api
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Request Body (JSON) * required
Curl
Request URL
Status Code
Server Response
GET Get EwayBill Details
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ewbNo * required | ewbNo | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get EWay bill for transporter by Date
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| date * required | E-way bill generated Date(dd/MM/YYYY) | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get EwayBills For Transporter By State
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| stateCode * required | State Code of E-way bill generator | (query) | string | |
| date * required | E-way bill generated Date(dd/MM/YYYY) | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get EwayBills For Transporter By Gstin
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| Gen_gstin * required | GSTIN of E-way bill generator | (query) | string | |
| date * required | E-way bill generated Date(dd/MM/YYYY) | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get EwayBill Report By Transporter Assigned Date
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| date * required | E-way bill generated Date(dd/MM/YYYY) | (query) | string | |
| stateCode * required | State Code of E-way bill generator | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get Eway Bills By Date
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| date * required | EWB Generated Date | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get Eway Bills Rejected By Others
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| date * required | E-way bill generated Date(dd/MM/YYYY) | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get Eway bills by parties
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| date * required | E-way bill generated Date(dd/MM/YYYY) | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get Consolidated e-way bill
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| tripSheetNo * required | Consolidated E-way bill number | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get EwayBill by Consigner
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| docType * required | Document Type | (query) | string | |
| docNo * required | Document Number | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get Error List
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN Number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get GSTIN Details
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| GSTIN * required | GSTIN number for which the details are required | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN Number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET GET Transin details
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| trn_no * required | Transporter GSTIN or Transin for which the details are required | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN Number | (header) | string |
Curl
Request URL
Status Code
Server Response
GET Get HSN Details
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| hsncode * required | hsncode for which the details are required | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN Number | (header) | string |
Curl
Request URL
Status Code
Server Response
POST Initiate Multi Vehicle Movement
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN Number | (header) | string |
Curl
Request URL
Status Code
Server Response
POST Add Multi Vehicles
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN Number | (header) | string |
Curl
Request URL
Status Code
Server Response
POST Change Multi Vehicles
| Name | Value | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| email * required | User Email | (query) | string | |
| ip_address * required | IP Address | (header) | string | |
| client_id * required | Client ID | (header) | string | |
| client_secret * required | Client Secret | (header) | string | |
| gstin * required | GSTIN Number | (header) | string |