Overview

Sequence Diagram

 

The format and details of adding vehicle to 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
action MULTIVEHADD
Encrypt (Base64(Request JSON),sek) Encrypted add vehicle to 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 add vehicle to Multi Vehicle JSON string, The response will have eway bill number and group no. and vehicle added date if it is successfully generated. Otherwise the response will have error codes.

Sample JSON (Request)

{
"ewbNo": 131001111287,
"groupNo": "1",
"vehicleNo": "PQR1234",
"transDocNo": "1234",
"transDocDate": "12/10/2017",
"quantity": 15
}

Sample JSON (Response)

{
"ewbNo":"131001111287",
"groupNo":"1",
"vehAddedDate":"05/06/2018 02:08: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": "string",
"description": "Group Number"
},
"vehicleNo": {
"type": "string",
"minLength": 7,
"maxLength": 15,
"description": "Vehicle Number"
},
"transDocNo": {
"type": "string",
"maxLength": 15,
"description": "Transport Document Number"
},
"transDocDate": {
"type": "string",
"pattern": "[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]",
"description": "Transport Document Date"
},
"quantity": {
"type": "number",
"description": "Quantity"
}
},
"required": [
"ewbNo",
"groupNo",
"vehicleNo",
"transDocNo",
"transDocDate",
"quantity"
]
}

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

vehicleNo

Text(15)

Vehicle number

KA12TR1234

Alpha-numeric

transDocNo

Text(15)

Transporter Document number

12-86/3

Alphanumeric, -, /

transDocDate

Text

Transporter Document Date

dd/mm/yyyy format

12/09/2017

quantity

Number

Quantity

Numbers

Validations

  1. Eway bill should be active and valid
  2. Initiation for multi vehicle movement should have been done and the group no. should exist
  3. Valid vehicleNo should be there
  4. Valid transDocNo and transDocDate as per the allowed format.
  5. If transMode is 1 while initiating, vehicleNo is mandatory, else transDocNo is mandatory
  6. Quantity should not be more than the total quantity mentioned in the multi vehicle initiation request
  7. The sum of all quantity mentioned in the previous vehicles of the same group should not be more than the total quantity mentioned during multi vehicle initiation request