Get E-way Bill by Consignor

This API provides the e-way bill details for a Document Type and Document number. If the environment is sandbox then e-invoice api will get hit and in case of production e-waybill api will get hit.

Route

/enriched/einv/{flynn-version}/{irp}/ewayapi/by-consigner?doc_type={document-type}&doc_number={document-number}

• active ‘flynn-version’: v3.0
• method: GET

URL Parameters

Name	Description	Type
flynn-version	version of the API for example, v3.0	string
irp	IRP Provider as per GST registration for e-invoicing	enum (ni1, ni2)

QUERY Parameters

Name	Description	Type
doc_type	document type (INV, BIL, BOE, CHL, CNT, OTH)	string
doc_number	document number	string

Headers

All headers as mentioned in the Enriched E-Invoice API introduction.

Response

200:

Sample Response Body

{
  "status": "1",
  "data": {
    "ewayBillNo": 611010167621,
    "ewayBillDate": "21/06/2022 05:39:00 PM",
    "validUpto": "23/06/2022 23:59:59 ",
    "alert": null
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}        

Enriched e-invoice errors are mentioned under common errors for v3.0 api.

Notes

IRP - nic is deprecated. Instead of it please use ni1 or ni2