Overview

Sequence Diagram

 

The format and details of updating vehicle in Multi Vehicle Movement API request is depicted in following table.

URL <URL>/ewayapi/

Content-Type

application/json

Method

POST

Request Header

Attributes Description

client-id

Client-id to be provided by E-WAY BILL SYSTEM

client-secret

Secret to be provided by E-WAY BILL SYSTEM

Gstin

GSTIN of Requester(Tax payer or Transporter)

Authtoken

Authentication token returned by the E-way bill system

Request Payload

Attributes Description Values
action MULTIVEHUPD
Encrypt (Base64(Request JSON),sek) Encrypted update vehicle details in Multi Vehicle Movement JSON string

Response Payload

Attributes Description Value
status Status of request 0 – for Failure ;1 – for Success
Encrypt(Base64(Response JSON),sek) Response of update vehicle details in Multi Vehicle Movement JSON string, The response will have e way bill number and group no. and vehicle updated date if it is successfully generated. Otherwise the response will have error codes.

Sample JSON (Request)

{
  "ewbNo": 111000609282,
  "groupNo": 1,
  "oldvehicleNo": "PQR1234",
  "newVehicleNo": " PQR1234",
  "oldTranNo":"ABC123",
  "newTranNo": "PQR123",
  "fromPlace": "Lucknow",
  "fromState": 09,
  "reasonCode": "1",
  "reasonRem": "vehicle broke down"
}

Sample JSON (Response)

{
   "ewbNo":"131001111287",
   "groupNo":"1",
   "vehUpdDate":"05/06/2018 02:55:00 PM"
}

JSON Schema

Schema for Initiate multi vehicle movement

  {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "properties": {
    "ewbNo": {
     "type": "number",
     "maxLength": 12,
     "minLength": 12,
     "description": "Ewaybill Number"
    },
    "groupNo": {
     "type": "number",
     "description": "Group Number"
    },
    "oldvehicleNo": {
     "type": "string",
     "minLength": 7,
     "maxLength": 15,
     "description": "Old Vehicle Number"
    },
    "newVehicleNo": {
     "type": "string",
     "minLength": 7,
     "maxLength": 15,
     "description": "New Vehicle Number"
     },
    "oldTranNo": {
     "type": "string",
     "maxLength": 15,
      "description": "Old Tran Number"
    },
    "newTranNo": {
     "type": "string",
     "maxLength": 15,
     "description": "New Tran Number"
     },
    "fromPlace": {
     "type": "string",
     "maxLength": 50,
     "description": "From Place"
    },
    "fromState": {
     "type": "integer",
     "maximum": 99,
     "description": "From State"
    },
    "reasonCode": {
     "type": "string",
      "maxLength": 1,
     "minLength": 1,
     "description": "Reason Code"
    },
    "reasonRem": {
     "type": "string",
     "maxLength": 50,
     "description": "Remarks"
    }
   },
    "required": [
     "ewbNo",
     "groupNo",
     "oldvehicleNo",
     "newVehicleNo",
     "oldTranNo",
     "newTranNo",
     "fromPlace",
     "fromState",
     "reasonCode",
     "reasonRem"
   ]
 }

Data Structure

Parameter Name Type Description Values Sample Data Allowed character

ewbNo

Number(12)

E-way bill Generated

131000026768

Numbers

groupNo

Number (1)

Group Number

Numbers

oldvehicleNo

Text(15)

Vehicle number

KA12TR1234

Alpha-numeric

newVehicleNo

Text(15)

Vehicle number

KA12TR1234

Alpha-numeric

oldTranNo

Text(15)

Old Tran Number

Alphanumeric, -, /

newTranNo

Text(15)

New Tran Number

Alphanumeric, -, /

fromPlace

Text(50)

Place of Consignor

BANGALORE SOUTH

Alpha-numeric

fromState

Number(2)

State of Consignor

Refer Code list

29

Numbers

reasonCode

Number(1)

Reason code for vehicle updation

Refer Code list

2

Numbers

reasonRem

Text(50)

Reason for Vehicle Updation

Vehicle details updated

Alpha-numeric

Validations

  1. Eway bill should be active and valid
  2. GroupNo should be mapped to eway bill and should exists for that e-way bill
  3. OldvehcileNo or oldTranNo should exists for the same e-waybill and group in the system
  4. Valid vehicle number and reason codes