(Deprecated) Extending Validity of E-Waybill
This API is deprecated. Please use the E-Waybill APIs from the unified set available here.
E-Waybill validity can be extended by updating the extension details. You can do this by getting the E-Waybill object using Get E-Waybill endpoint and then appending the required extension details to the object. Before calling the E-Waybill Extend API, you need to update the E-Waybill with the updated object.
Update extension details
E-Waybill can be updated by submitting a PUT
request to the E-Waybill API with the following request headers.
URL query string:
Request Parameters:
Parameters | Parameter Type | Type | Description |
taxable_entity_id | Path | String | Required. This is the unique ID associated with the GSTIN in your account. |
id | Path | String | Required. Unique Transaction ID. |
activity_type | Query | String | Required. EXTEND_VALIDITY |
Append the following key value pairs to the E-Waybill object received from Get E-Waybill API.
Key | Type | Description |
transport_doc_number | String | Required. Transport document number. |
vehicle_number | String | Required. Vehicle number. |
transporter_from_place | String | Required. Transporter's city. |
transporter_from_state | String | Required. Transporter's state. |
dispatch_from_state | String | Required. Indian state from where dispatched. |
remaining_distance | Number | Required. Remaining distance in kilometers |
extend_validity_reason | ENUM | Required. NATURAL_CALAMITY, LAW & ORDER, DUE_TO_TRANSHIPMENT, ACCIDENT, OTHERS |
extend_validity_remarks | String | Required. Remarks for extending validity. |
consignment_status | ENUM | Required. M,T [Movement,Transit] |
transit_type | ENUM | Required. on-road-"R", warehouse-"W", other="O" |
transport_mode | ENUM | Required. ROAD,TRAIN,SHIP,AIR |
from_pincode | String | Required. |
Sample Request:
Sample Payload
Sample Response:
Extend validity
E-Waybill validity can be extended by submitting a PUT
request to the E-Waybill API with the following request headers.
This request must to be sent within 8 hours before or 8 hours after the expiry of the E-Waybill.
URL query string:
Request Parameters:
Parameters | Parameter Type | Type | Description |
taxable_entity_id | Path | String | Required. This is the unique ID associated with the GSTIN in your account. |
- | Body | String | Required. ID of the document. |
Sample Request:
Sample Response:
Please note down the workflow_id
returned by this request. You can use this to poll the updated status with a GET request later.
Check Status
E-Waybill async action status can be polled by submitting a GET request to the E-Waybill API with the following request headers.
URL query string:
Request Parameters:
Parameters | Parameter Type | Type | Description |
taxable_entity_id | Path | String | Required. This is the unique ID associated with the GSTIN in your account. |
workflow_id | Path | String | Required. This is the unique ID associated with the async workflow. |
Sample Request:
Sample Response:
To know the new validity of E-Waybill, you can call the Get E-Waybill endpoint.
Last updated