Create e-way bill

Generates an e-way bill for an existing document, identified by its hash_id. Requires the transport details: supply type, transport mode, dispatch addresses, and transporter document date. Your account must be connected to the e-way bill portal; portal rejections are returned as PORTAL_ERROR_{code}. By default this points to the government sandbox portal.

POST /v2/ewaybill/{doc_hash_id}

Create e-way bill

cURL

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/ewaybill/{doc_hash_id} \
  --header 'Authorization: Bearer <token>' \
  --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"
  },
  "transport_mode": "Road"
}
'

200

{
  "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 an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Path Parameters

doc_hash_id · string · required

The hash id of the document

Body

application/json

supply_type · enum<string> · required

Supply Type

Available options: Outward, Inward

Example:

"Outward"

sub_supply_type · enum<string> · required

Sub Supply Type

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

DD-MM-YYYY

Example:

"05-03-2025"

dispatch_from · object · required

Dispatch From Address

Show child attributes

dispatch_to · object · required

Dispatch To Address

Show child attributes

transport_mode · enum<string> · required

Transport Mode

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

Example:

"Road"

vehicle_type · enum<string>

Vehicle Type

Available options: Regular, Over Dimensional Cargo

Example:

"Regular"

transaction_type · enum<string>

Transaction Type

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

Example:

"Regular"

ship_to_gstin · string

Ship To GSTIN of the consignee, or 'URP' if unregistered. Required for 'Bill To - Ship To' and 'Combination of 2 and 3' transaction types.

Example:

"29ABCDE1234F1Z5"

sub_supply_type_description · string

Sub Supply Type Description

Example:

"Supply of goods"

transporter_id · string

Transporter ID

Example:

"123456"

transporter_name · string

Transporter Name

Example:

"Transporter Name"

vehicle_number · string

Vehicle Number

Example:

"KA01AB1234"

transporter_doc_number · string

Transporter Document Number

Example:

"123456"

Response

200

application/json

Success

success · boolean

Success

Example:

true

message · string

Message

Example:

"Eway Bill created successfully"