POST
/
v2
/
ewaybill
/
{doc_hash_id}
curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/ewaybill/{doc_hash_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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",
  "sub_supply_type_description": "Supply of goods",
  "transporter_id": "123456",
  "transporter_name": "Transporter Name",
  "vehicle_number": "KA01AB1234",
  "transporter_doc_number": "123456"
}'
{
  "success": true,
  "message": "Eway Bill created successfully"
}

To create an EwayBill first connect to EwayBill Portal.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

doc_hash_id
string
required

The hash id of the document

Body

application/json
supply_type
enum<string>
required

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

Available options:
Outward,
Inward
Example:

"Outward"

sub_supply_type
enum<string>
required

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

Available options:
Supply,
Export,
Job Work,
SKD/CKD/Lots,
Recipient Not Known,
For Own Use,
Job Work Returns,
Sales Returns,
Exhibition or fairs,
Line Sales,
Others
Example:

"Supply"

transporter_doc_date
string
required

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

Example:

"05-03-2025"

dispatch_from
object
required

Dispatch From Address

dispatch_to
object
required

Dispatch To Address

transport_mode
enum<string>
required

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

Available options:
Road,
Rail,
Air,
Ship or Ship Cum Road/Rail
Example:

"Road"

vehicle_type
enum<string>

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

Available options:
Regular,
Over Dimensional Cargo
Example:

"Regular"

transaction_type
enum<string>

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

Available options:
Regular,
Bill To - Ship To,
Bill From - Dispatch From,
Combination of 2 and 3
Example:

"Regular"

sub_supply_type_description
string

Additional description of the sub-supply type.

Example:

"Supply of goods"

transporter_id
string

A unique identification number assigned to the transporter.

Example:

"123456"

transporter_name
string

The name of the transporter handling the shipment.

Example:

"Transporter Name"

vehicle_number
string

The registration number of the vehicle carrying the goods.

Example:

"KA01AB1234"

transporter_doc_number
string

A reference number of the document issued by the transporter.

Example:

"123456"

Response

200
application/json
Success
success
boolean

Success

Example:

true

message
string

Message

Example:

"Eway Bill created successfully"