Sign in

v1

latestOpenAPI 3.0.12026-07-263591116.9 KB
EwayBill

Create Eway Bill

post/v2/ewaybill/{doc_hash_id}

Path parameters

doc_hash_idstring required

The hash id of the document

Request body

supply_type'Outward' | 'Inward' required

Indicates whether the supply is outward (from the sender) or inward (to the sender)

sub_supply_type'Supply' | 'Export' | 'Job Work' | 'SKD/CKD/Lots' | 'Recipient Not Known' | 'For Own Use' | 'Job Work Returns' | 'Sales Returns' | 'Exhibition or fairs' | 'Line Sales' | 'Others' required

Specifies the nature of supply, such as sale, transfer, or job work.

transporter_doc_datestring required

The date on which the transporter issued the document(DD-MM-YYYY)

vehicle_type'Regular' | 'Over Dimensional Cargo'

Specifies whether the vehicle is regular or special (e.g., over-dimensional cargo).

transaction_type'Regular' | 'Bill To - Ship To' | 'Bill From - Dispatch From' | 'Combination of 2 and 3'

Defines the type of transaction, such as regular, bill-to-ship-to, or bill-from-dispatch-from.

transport_mode'Road' | 'Rail' | 'Air' | 'Ship or Ship Cum Road/Rail' required

Mode of transportation used (e.g., road, rail, air, or ship)

ship_to_gstinstring

GSTIN of the consignee, or 'URP' if unregistered. Mandatory when transaction_type is 'Bill To - Ship To' or 'Combination of 2 and 3'.

sub_supply_type_descriptionstring

Additional description of the sub-supply type.

transporter_idstring

A unique identification number assigned to the transporter.

transporter_namestring

The name of the transporter handling the shipment.

vehicle_numberstring

The registration number of the vehicle carrying the goods.

transporter_doc_numberstring

A reference number of the document issued by the transporter.

Example request

{
  "supply_type": "Outward",
  "sub_supply_type": "Supply",
  "transporter_doc_date": "05-03-2025",
  "dispatch_from": {
    "addr_id": -1,
    "address_line1": "123 Street",
    "address_line2": "Apt 4B",
    "city": "City Name",
    "state": "State Name",
    "country": "Country Name",
    "pincode": "123456"
  },
  "dispatch_to": {
    "addr_id": -1,
    "address_line1": "123 Street",
    "address_line2": "Apt 4B",
    "city": "City Name",
    "state": "State Name",
    "country": "Country Name",
    "pincode": "123456"
  },
  "vehicle_type": "Regular",
  "transaction_type": "Regular",
  "transport_mode": "Road",
  "ship_to_gstin": "29ABCDE1234F1Z5",
  "sub_supply_type_description": "Supply of goods",
  "transporter_id": "123456",
  "transporter_name": "Transporter Name",
  "vehicle_number": "KA01AB1234",
  "transporter_doc_number": "123456"
}

Response

Success

successboolean

Success

messagestring

Message

Example response

{
  "success": true,
  "message": "Eway Bill created successfully"
}