Get Consolidate EWB PDF

Given a consolidate ewb number (trip-sheet number), this API will generate PDF for the Consolidate E-way bill, as opposed to its basic counterpart. It is an asynchronous API, hence will give a task ID in response.

Given a task ID, you could fetch the task status using Status API. In order to download the result, you would need to use Download API.

API Route

Route

/enriched/eway/{flynn-version}/{ewb_provider}/eway-bills/download-cewb-pdf/{trip_sheet_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)
trip_sheet_number	trip_sheet_number for which PDF should be generated	string

Headers

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

Request

There is no request body for this API.

Response

200:

Successful response will an async task-id. Using this task-id you will be able to fetch the status of the request.

Sample Response Body

{
  "status": "1",
  "data": {
    "task-id": "62cd1c61-1f10-4b50-a40d-333753802050"
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}

Download API Response:

Download API response will have a zip with PDF response file and json file.

Sample Json Response Body

{
  "status": "1",
  "data": {
    "tripSheetNo": 3810008110,
    "fromPlace": "BANGALORE SOUTH",
    "fromState": "29",
    "vehicleNo": "KA12AB1234",
    "transMode": "1  ",
    "transDocNo": "1234567",
    "transDocDate": "08/12/2023",
    "userGstin": "03AAAPI3182M002",
    "enteredDate": "08/12/2023 10:55:00 AM",
    "status": "ACT",
    "tripSheetEwbBills": [
      {
        "ewbNo": 211010037878,
        "ewbDate": "08/12/2023 10:55:00 AM",
        "userGstin": "27AAAPI3182M002",
        "docNo": "17020130768539WV",
        "docDate": "08/12/2023",
        "fromGstin": "27AAAPI3182M002",
        "fromTradeName": "welton",
        "toGstin": "19AAAPI3182M007",
        "toTradeName": "sthuthya",
        "totInvValue": 11556371,
        "status": "ACT",
        "validUpto": "18/12/2023 11:59:00 PM",
        "toPlace": "Bidhangarh",
        "toPincode": "700066",
        "actToStateCode": "19"
      },
      {
        "ewbNo": 281010037879,
        "ewbDate": "08/12/2023 10:55:00 AM",
        "userGstin": "27AAAPI3182M002",
        "docNo": "1702013076859ZPK",
        "docDate": "08/12/2023",
        "fromGstin": "27AAAPI3182M002",
        "fromTradeName": "welton",
        "toGstin": "19AAAPI3182M007",
        "toTradeName": "sthuthya",
        "totInvValue": 11556371,
        "status": "ACT",
        "validUpto": "18/12/2023 11:59:00 PM",
        "toPlace": "Bijoygarh",
        "toPincode": "700032",
        "actToStateCode": "19"
      }
    ]
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}

502:

When the Consolidate Eway-bill isn’t found.

Sample Response Body

{
  "status": "0",
  "data": null,
  "error": {
    "message": "err-ewb-returned-error",
    "type": "Ewb",
    "args": {
      "details": [
        {
          "ErrorCode": "325",
          "ErrorMessage": null
        }
      ]
    }
  },
  "info": null,
  "additionalInfo": null,
  "alert": null
}

Notes

Below URL is deprecated now. Instead of it please use New URL.
/enriched/ewb/{flynn-version}/eway-bills/download-cewb-pdf/{trip_sheet_number}