GEgetswipe
EwayBill

Create e-way bill

Changed on

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}

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/ewaybill/{doc_hash_id}
  • Auth
    HTTP bearer

Request body

supply_type'Outward' | 'Inward' required

Supply Type

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

Sub Supply Type

transporter_doc_datestring required

DD-MM-YYYY

vehicle_type'Regular' | 'Over Dimensional Cargo'

Vehicle Type

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

Transaction Type

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

Transport Mode

ship_to_gstinstring

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

sub_supply_type_descriptionstring

Sub Supply Type Description

transporter_idstring

Transporter ID

transporter_namestring

Transporter Name

vehicle_numberstring

Vehicle Number

transporter_doc_numberstring

Transporter Document Number

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"
}

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      removed the enum value Korea North of the request property /////

    • breaking

      removed the enum value Korea North of the request property /////

    • breaking

      removed the enum value Korea South of the request property /////

    • breaking

      removed the enum value Korea South of the request property /////

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • warning

      deleted the path request parameter doc_hash_id

    • info

      api operation id v2_post_eway_bill removed and replaced with post_eway_bill

    • info

      added the new LADAKH(NEWLY ADDED) enum value to the request property /////

    • info

      added the new LADAKH(NEWLY ADDED) enum value to the request property /////

    • info

      added the new Republic of Korea (South Korea) enum value to the request property /////

    • info

      added the new Republic of Korea (South Korea) enum value to the request property /////