Get EWB PDF#
Given a e-way bill number, this API will generate PDF for the E-way bill, as opposed to its basic counterpart. The output is a byte array of the response PDF file.
API Route#
Route
/enriched/eway/{flynn-version}/{ewb_provider}/eway-bills/download-pdf/{ewb_number}
- active ‘flynn-version’: v1.0
- method: GET
URL Parameters#
Name | Description | Type |
---|---|---|
flynn-version | version of the API for example, v1.0 |
string |
ewb_provider | Eway bill provider for example, ew1 |
enum(ew1, ew2) |
ewb_number | E-way bill number for which PDF should be generated | string |
Headers#
All headers as mentioned in the Enriched E-way bill API introduction.
Tip
The only valid values for the header keys Content-Type
and accept
must have either application/pdf
or application/json
.
Content-Type | Accept | Result |
---|---|---|
application/pdf | application/pdf | Will Give PDF |
application/json | application/json | Base64 string of PDF in Json |
Request#
There is no request body for this API.
Response#
200
:#
Successful response will have the PDF response file or json of Base64 string based on Content-Type and Accept.
Sample Json Response Body
{
"data": "JVBERi0xLjQKJfbk/N8KMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovVmVyc2lvbiAvMS40Ci9QYWdlcyAyIDAgUgo+PgplbmRvYmoKMiAwIG9iago8PAovVHlwZSAvUGFnZXMKL0tpZVnkfaneQYR0mSkMGVyQ29tcG9uZW50IDgKL1ByZWRpY3RvciAxNQovQ29sdW1ucyAxMTEKL0NvbG9ycyAzCj4+CmVuZG9iagp4cmVmCjAgMTMKMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAwMDE1IDAwMDAwIG4NCjAwMDAwMDAwNzggMDAwMDAgbg0KMDAwMDAwMDEzNSAwMDAwMCBuDQowMDAwMDAwMjU0IDAwMDAwIG4NCjAwMDAwMDIyMzAgMDAwMDAgbg0KMDAwMDAwMjMwMCAwMDAwMCBuDQowMDAwMDAyMzQyIDAwMDAwIG4NCjAwMDAwMDQzMDcgMDAwMDAgbg0KMDAwMDAwNTg5NiAwMDAwMCBuDQowMDAwMDA1OTkzIDAwMDAwIG4NCjAwMDAwMDYwOTYgMDAwMDAgbg0KMDAwMDAwNjE3NSAwMDAwMCBuDQp0cmFpbGVyCjw8Ci9Sb290IDEgMCBSCi9JRCBbPEFCOEM2NDZFQkUwQzAzMERGOTUzMTk2RThEOTAyQkZFPiA8QUI4QzY0NkVCRTBDMDMwREY5NTMxOTZFOEQ5MDJCRkU+XQovU2l6ZSAxMwo+PgpzdGFydHhyZWYKNjI1NAolJUVPRgo="
}
404
:#
When the Eway-bill isn’t found.
Sample Response Body
{
"error": {
"message": "err-resource-not-found",
"type": "ResourceNotFound",
"args": {
"ewb-number": "191001611857"
}
}
}
Notes#
Below URL is deprecated now. Instead of it please use New URL.
/enriched/ewb/{flynn-version}/eway-bills/download-pdf/{ewb_number}