API – Get E-Waybill

This API is used to get details of e-waybill for a given EWaybill number.

#URL

GET https://app.octagst.com/api/einvoice/getewaybill?gstin={value}&ewbNo={value}

#Query Parameters

Name	Description	Type	Value
gstin	It specifies GSTIN of requester	Mandatory
ewbNo	It specifies EWaybill number	Mandatory

#Success Response

Response payload will contains the success status along with e-Waybill details.

{
  "Success": true,
  "Response": {
    "ewbNo": 131001298692,
    "ewayBillDate": "26/09/2018 02:40:00",
    "genMode": "API",
    "userGstin": "29AKLPM8755F1Z2",
    "supplyType": "O",
    "subSupplyType": "1",
    "docType": "INV",
    "docNo": "7007-8",
    "docDate": "10/09/2018",
    "fromGstin": "29AKLPM8755F1Z2",
    "fromTrdName": "welton",
    "fromAddr1": "4556",
    "fromAddr2": "hulimavu",
    "fromPlace": "bannargatta",
    "fromPincode": 560090,
    "fromStateCode": 29,
    "toGstin": "02EHFPS5910D2Z0",
    "toTrdName": "test2",
    "toAddr1": "Shree Nilaya",
    "toAddr2": "Dasarahosahalli",
    "toPlace": "Beml Nagar",
    "toPincode": 560090,
    "toStateCode": 29,
    "totalValue": 56099.0,
    "totInvValue": 68358.0,
    "cgstValue": 1.0,
    "sgstValue": 1.0,
    "igstValue": 0.0,
    "cessValue": 400.56,
    "transporterId": null,
    "transporterName": null,
    "status": "ACT",
    "actualDist": 2500,
    "noValidDays": 25,
    "validUpto": "27/09/2018 17:59:00",
    "extendedTimes": 0,
    "rejectStatus": "N",
    "actFromStateCode": 29,
    "actToStateCode": 29,
    "vehicleType": "R",
    "transactionType": 4,
    "otherValue": -10.0,
    "cessNonAdvolValue": 400.0,
    "itemList": [
      {
        "itemNo": 1,
        "productId": 0,
        "productName": "CEMENT",
        "productDesc": null,
        "hsnCode": 25210010,
        "quantity": 2.0,
        "qtyUnit": "BOX",
        "cgstRate": 0.05,
        "sgstRate": 0.05,
        "igstRate": 0.0,
        "cessRate": 3.0,
        "cessNonAdvol": 0,
        "taxableAmount": 56.0
      },
      {
        "itemNo": 2,
        "productId": 0,
        "productName": "steel",
        "productDesc": "steel rods",
        "hsnCode": 2402,
        "quantity": 4.0,
        "qtyUnit": "NOS",
        "cgstRate": 10.0,
        "sgstRate": 10.0,
        "igstRate": 0.0,
        "cessRate": 3.0,
        "cessNonAdvol": 0.0,
        "taxableAmount": 0.0
      }
    ],
    "VehiclListDetails": [
      {
        "updMode": "API",
        "vehicleNo": "PQR1234",
        "fromPlace": "Bengaluru",
        "fromState": 29,
        "tripshtNo": 1810002031,
        "userGSTINTransin": "29AKLPM8755F1Z2",
        "enteredDate": "26/09/2018 02:40:00",
        "transMode": "1 ",
        "transDocNo": "1234",
        "transDocDate": "03/05/2018",
        "groupNo": "1"
      },
      {
        "updMode": "API",
        "vehicleNo": "PQR1234",
        "fromPlace": "Bengaluru",
        "fromState": 29,
        "tripshtNo": 1110002030,
        "userGSTINTransin": "29AKLPM8755F1Z2",
        "enteredDate": "26/09/2018 02:40:00",
        "transMode": "1",
        "transDocNo": "1234",
        "transDocDate": "03/05/2018",
        "vehicleType": "",
        "groupNo": "0"
      },
      {
        "updMode": "API",
        "vehicleNo": "KA25AB3456",
        "fromPlace": "BANGALORE SOUTH",
        "fromState": 29,
        "tripshtNo": 1510002029,
        "userGSTINTransin": "29AKLPM8755F1Z2",
        "enteredDate": "26/09/2018 02:40:00",
        "transMode": "1",
        "transDocNo": "1234",
        "transDocDate": "12/10/2017",
        "vehicleType": "",
        "groupNo": "0"
      },
      {
        "updMode": "API",
        "vehicleNo": "KA25AB3456",
        "fromPlace": "BANGALORE SOUTH",
        "fromState": 29,
        "tripshtNo": 1810002028,
        "userGSTINTransin": "29AKLPM8755F1Z2",
        "enteredDate": "26/09/2018 02:40:00",
        "transMode": "1 ",
        "transDocNo": "1234",
        "transDocDate": "12/10/2017",
        "vehicleType": "",
        "groupNo": "0"
      },
      {
        "updMode": "API",
        "vehicleNo": "RJ191G5024",
        "fromPlace": "bannargatta",
        "fromState": 29,
        "tripshtNo": 0,
        "userGSTINTransin": "29AKLPM8755F1Z2",
        "enteredDate": "26/09/2018 02:40:00",
        "transMode": "1 ",
        "transDocNo": "12345",
        "transDocDate": null,
        "vehicleType": "R",
        "groupNo": "0"
      }
    ]
  }
}

#Failure Response

If API request fails for some reason, response payload will contain the failure status and a list of errors.

{
  "Success": false,
  "Errors": [
    {
      "Code": "ERR_CODE_1",
      "Message": "ERR MESSAGE 1"
    },
    {
      "Code": "ERR_CODE_n",
      "Message": "ERR MESSAGE n"
    }
  ]
}