Overview

Sequence Diagram

 

The format and details of a Multi Vehicle Movement Initiation 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
action MULTIVEHMOVINT
Encrypt (Base64(Request JSON),sek) Encrypted Initiate Multi Vehicle JSON string

Response Payload

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

Sample JSON (Request)

{
"ewbNo": 131001111287,
"reasonCode": "1",
"reasonRem": "vehicle broke down",
"fromPlace": "BANGALORE",
"fromState": 29,
"toPlace": "Chennai",
"toState": 33,
"transMode": "1",
"totalQuantity": 33,
"unitCode": "NOS"
}

Sample JSON (Response)

{
"ewbNo":"131001111287",
"groupNo":"1",
"createdDate":"05/06/2018 02:04: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"
   },
  "reasonCode": {
   "type": "string",
   "maxLength": 1,
   "minLength": 1,
   "description":"Reason Code"
  },
  "reasonRem": {
   "type":"string",
   "maxLength": 50,
   "description":"Remarks"
  },
  "fromPlace": {
   "type":"string",
   "maxLength": 50,
   "description":"From Place"
  },
  "fromState": {
   "type": "integer",
   "maximum": 99,
   "description":"From State"
  },
  "toPlace": {
   "type":"string",
   "maxLength": 50,
   "description":"To Place"
  },
  "toState": {
   "type":"integer",
   "maximum": 99,
   "description":"From State"
  },
  "transMode": {
   "type":"integer",
   "enum": ["1", "2","3","4"],
   "description": "Mode of transport (Road-1, Rail-2, Air-3, Ship-4) "
  },
  "totalQuantity": {
   "type": "number",
   "description": "Total Quantity"
  },
  "unitCode": {
   "type": "string",
   "maxLength": 3,
   "minLength": 3,
   "description": "Unit Code"
  }
  },
  "required": [
   "ewbNo",
   "fromPlace",
   "fromState",
   "toPlace",
   "toState",
   "reasonCode",
   "reasonRem",
   "transMode",
   "totalQuantity",
   "unitCode"
  ]
  }

Data Structure

Parameter Name Type Description Values Sample Data Allowed character

ewbNo

Number(12)

E-way bill Generated

131000026768

Numbers

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

toPlace

Number(2)

Reason for Vehicle Updation

Vehicle details updated

Alpha-numeric

totalQuantity

Number

Total Quantity

Numbers

unitCode

Text(3)

Unit Code

NOS

Alpha

transMode

Number(1)

Mode of Transport

Refer Code list

1

Numbers

ewbNo

Number(12)

E-way bill Generated

Values

131000026768

Numbers

fromPlace

Text(50)

Place of Consignor

BANGALORE SOUTH

Alpha-numeric

fromState

Number(2)

State of Consignorr

Refer Code list

29

Numbers

reasonCode

Number(1)

Reason code for vehicle updation

Refer Code list

2

Numbers

toPlace

Text(50)

Place of Consinee

BANGALORE SOUTH

Alpha-numeric

toState

Number(2)

State of Consinee

Refer Code list

29

Numbers

reasonRem

Text(50)

Reason for Vehicle Updation

Vehicle details updated

Alpha-numeric

totalQuantity

Number

Total Quantity

Numbers

unitCode

Text(3)

Unit Code

NOS

Alpha

transMode

Number(1)

Mode of Transport

Refer Code list

1

Numbers

Validations

  1. Eway bill should be active and valid.
  2. Valid reasonCode, state code and unitCode to be sent.
  3. totalQuantity should not be more than the quantity mentioned in eway bill for the first initiation
  4. After one group movement of consignment in multiple vehicles is initiated, requests for next group movement will consider the totalQuantity of previous group.
  5. If same JSON is passed without any change, new group will not be created.