E-Way Bills

An e-Way Bill (EWB) is an electronic document generated on the GST portal for the movement of goods within or across states in India. e-Way Bills are required for transactions whose consignment value crosses the threshold defined by the GSTN. The e-Way Bills module in Zoho Inventory lets you generate, update, cancel, extend, and print EWBs for invoices, credit notes, delivery challans, and other supported transactions in the India edition.

Download E-Way Bills OpenAPI Document

End Points

POST

/ewaybills/{ewaybill_id}

GET

/ewaybills/{ewaybill_id}

DELETE

/ewaybills/{ewaybill_id}

POST

/ewaybills/{ewaybill_id}/cancel

POST

/ewaybills/{ewaybill_id}/sync

/ewaybills/{ewaybill_id}/vehicles

PUT

/ewaybills/{ewaybill_id}/vehicles/{vehicle_id}

PUT

/ewaybills/{ewaybill_id}/extendvalidity

POST

/ewaybills/{ewaybill_id}/multivehicle/initiate

POST

/ewaybills/{ewaybill_id}/multivehicle/{group_id}/vehicles

POST

/ewaybills/{ewaybill_id}/multivehicle/{group_id}/vehicles/{updated_vehicle_id}

POST

/ewaybills/transporters

GET

/ewaybills/transporters

PUT

/ewaybills/transporters/{transporter_id}

PUT

/ewaybills/{ewaybill_id}/transporters/{transporter_id}

POST

/ewaybills/address/dispatchfrom

GET

/ewaybills/address/dispatchfrom

DELETE

/ewaybills/address/dispatchfrom/{address_id}

/settings/ewaybills/enable

POST

/settings/ewaybills/disable

POST

/settings/ewaybills/deactivate

PUT

/settings/{tax_settings_id}/ewaybills

GET

/settings/{tax_settings_id}/ewaybills

POST

/settings/{tax_settings_id}/ewaybills/deactivate

Attribute

ewaybill_id

string

Unique identifier of the e-Way Bill.

entity_id

string

ID of the source transaction (invoice, credit note, or delivery challan) for which the e-Way Bill is generated.

entity_type

string

Type of the source transaction. Allowed Values: invoice, creditnote, deliverychallan.

entity_number

string

Reference number of the source transaction.

entity_date_formatted

string

Date of the source transaction, formatted per the organization preference.

entity_status

string

Status of the source transaction.

supplier_gstin

string

GSTIN of the supplier.

customer_name

string

Name of the customer.

customer_gstin

string

GSTIN of the customer.

ewaybill_number

string

12-digit e-Way Bill number issued by the GST portal.

eway_bill_number

string

Alias of ewaybill_number.

ewaybill_date

string

Date and time when the e-Way Bill was generated on the GST portal.

ewaybill_start_date

string

Date when the e-Way Bill validity starts.

ewaybill_start_date_formatted

string

Validity start date formatted per the organization preference.

ewaybill_expiry_date

string

Date and time when the e-Way Bill validity expires.

ewaybill_status

string

Status of the e-Way Bill. Allowed Values: draft, generated, cancelled, expired, excluded.

ewaybill_status_formatted

string

Display version of the e-Way Bill status.

ewaybill_type

string

Type of e-Way Bill. Allowed Values: general and gold.

validity_days

integer

Number of days for which the e-Way Bill is valid.

can_allow_print_ewaybill

boolean

Indicates whether the e-Way Bill can be printed.

can_allow_cancel_ewaybill

boolean

Indicates whether the e-Way Bill can still be cancelled (within 24 hours of generation and not verified during transit).

cancel_reason

string

Reason code chosen while cancelling the e-Way Bill.

cancel_reason_formatted

string

Display version of the cancellation reason.

cancel_remarks

string

Free-form remarks captured while cancelling the e-Way Bill. Max-length [50].

cancel_remarks_formatted

string

Display version of the cancellation remarks.

transporter_id

string

ID of the transporter associated with the e-Way Bill.

transporter_name

string

Name of the transporter. Max-length [255].

transporter_license

string

License number of the transporter. Max-length [100].

transporter_registration_id

string

GSTIN or transporter ID issued by the GST portal. Max-length [15].

sub_supply_type

string

Reason for the transportation of goods. Allowed Values: supply, export, job_work, sktd, recipient_not_known, for_own_use, exhibition_or_fairs, line_sales, others.

sub_supply_type_desc

string

Description for the sub-supply type when sub_supply_type is others. Max-length [20].

distance

integer

Approximate distance, in kilometres, between the dispatch and shipping addresses.

transportation_mode

string

Mode of transportation. Allowed Values: road, rail, air, ship.

transporter_document_number

string

Document number associated with the consignment (Lorry Receipt, Railway Receipt, Airway Bill, or Bill of Lading). Max-length [30].

transporter_document_date

string

Date of the transporter document. Format: yyyy-mm-dd.

vehicle_number

string

Registration number of the vehicle carrying the consignment. Max-length [20].

vehicle_type

string

Type of vehicle. Allowed Values: regular and over_dimensional_cargo.

vehicle_type_formatted

string

Display version of the vehicle type.

vehicle_permit_type

string

Permit type of the vehicle.

vehicle_permit_type_formatted

string

Display version of the vehicle permit type.

vehicle_permit_number

string

Permit number of the vehicle.

vehicle_model_year

integer

Year in which the vehicle was manufactured.

vehicle_reg_place

string

Place where the vehicle is registered.

vehicle_gross_weight

double

Gross weight of the vehicle, in metric tonnes.

insurer

string

Name of the insurance provider for the consignment.

insurance_policy_number

string

Policy number of the consignment insurance.

place_of_dispatch

string

State code from which the consignment is dispatched.

place_of_delivery

string

State code to which the consignment is delivered.

ship_to_state_code

string

State code of the shipping address. Used when the ship-to state differs from the customer billing state.

dispatch_from_address_id

string

ID of the dispatch-from address.

ship_to_address_id

string

ID of the shipping address.

entity_total

double

Total value of the source transaction.

is_vehicle_details_push_failed

boolean

Indicates whether the latest attempt to push vehicle details to the GST portal failed.

vehicle_details

array

List of vehicle entries linked to the e-Way Bill.

Show Sub-Attributes

transportation_mode

string

Mode of transportation. Allowed Values: road, rail, air, ship.

transportation_mode_formatted

string

transporter_document_number

string

transporter_document_date

string

vehicle_number

string

updated_time

string

operation_type

string

Operation that produced this vehicle entry. Allowed Values: create, update, multi_vehicle.

from_place

string

from_state

string

State code from which the vehicle starts.

from_state_formatted

string

reason

string

Reason for the vehicle change. Allowed Values: due_to_break_down, due_to_transhipment, first_time, others.

remarks

string

vehicle_type

string

vehicle_type_formatted

string

vehicle_permit_type

string

vehicle_permit_number

string

vehicle_model_year

integer

vehicle_reg_place

string

insurer

string

insurance_policy_number

string

vehicle_gross_weight

double

group_number

string

Group number when the vehicle is part of a multi-vehicle movement.

multivehicle_group_details

array

Multi-vehicle movement groups for the e-Way Bill.

Show Sub-Attributes

group_id

string

group_name

string

from_place

string

from_state

string

from_state_formatted

string

reason

string

to_place

string

to_state

string

to_state_formatted

string

remarks

string

group_number

string

group_number_formatted

string

total_quantity

double

transportation_mode

string

transportation_mode_formatted

string

operation_type

string

unit_id

string

unit

string

uqc

string

Unique Quantity Code as defined by the GST portal.

vehicle_details

array

Show Sub-Attributes

vehicle_id

string

transportation_mode

string

transportation_mode_formatted

string

transporter_document_number

string

transporter_document_date

string

vehicle_number

string

updated_time

string

operation_type

string

from_place

string

from_state

string

from_state_formatted

string

reason

string

remarks

string

vehicle_type

string

vehicle_type_formatted

string

quantity

double

group_number

string

group_number_formatted

string

is_cancelled

boolean

multivehicle_group_id

string

{
    "ewaybill_id": "460000000123456",
    "entity_id": "460000000098765",
    "entity_type": "invoice",
    "entity_number": "INV-00045",
    "entity_date_formatted": "15 Jan 2025",
    "entity_status": "sent",
    "supplier_gstin": "29ABCDE1234F1Z5",
    "customer_name": "Zylker Trading Co.",
    "customer_gstin": "27FGHIJ5678K1Z2",
    "ewaybill_number": "123456789012",
    "eway_bill_number": "123456789012",
    "ewaybill_date": "2025-01-15 10:30:00",
    "ewaybill_start_date": "2025-01-15",
    "ewaybill_start_date_formatted": "15 Jan 2025",
    "ewaybill_expiry_date": "2025-01-16 10:30:00",
    "ewaybill_status": "generated",
    "ewaybill_status_formatted": "Generated",
    "ewaybill_type": "general",
    "validity_days": 1,
    "can_allow_print_ewaybill": true,
    "can_allow_cancel_ewaybill": true,
    "cancel_reason": "duplicate",
    "cancel_reason_formatted": "Duplicate",
    "cancel_remarks": "Duplicate entry",
    "cancel_remarks_formatted": "Duplicate entry",
    "transporter_id": "460000000234567",
    "transporter_name": "Speedy Logistics",
    "transporter_license": "TL-998877",
    "transporter_registration_id": "12AAAAA0000A1Z5",
    "sub_supply_type": "supply",
    "sub_supply_type_desc": "Sample movement",
    "distance": 350,
    "transportation_mode": "road",
    "transporter_document_number": "LR-12345",
    "transporter_document_date": "2025-01-15",
    "vehicle_number": "KA01AB1234",
    "vehicle_type": "regular",
    "vehicle_type_formatted": "Regular",
    "vehicle_permit_type": "national",
    "vehicle_permit_type_formatted": "National",
    "vehicle_permit_number": "PMT-998877",
    "vehicle_model_year": 2022,
    "vehicle_reg_place": "Bengaluru",
    "vehicle_gross_weight": 12.5,
    "insurer": "Acme Insurance Ltd.",
    "insurance_policy_number": "POL-123456789",
    "place_of_dispatch": "29",
    "place_of_delivery": "27",
    "ship_to_state_code": "27",
    "dispatch_from_address_id": "460000000678901",
    "ship_to_address_id": "460000000678902",
    "entity_total": 50000,
    "is_vehicle_details_push_failed": false,
    "vehicle_details": [
        {
            "transportation_mode": "road",
            "transportation_mode_formatted": "Road",
            "transporter_document_number": "LR-12345",
            "transporter_document_date": "2025-01-15",
            "vehicle_number": "KA01AB1234",
            "updated_time": "2025-01-15 10:35:00",
            "operation_type": "create",
            "from_place": "Bengaluru",
            "from_state": "29",
            "from_state_formatted": "Karnataka",
            "reason": "first_time",
            "remarks": "Initial dispatch",
            "vehicle_type": "regular",
            "vehicle_type_formatted": "Regular",
            "vehicle_permit_type": "national",
            "vehicle_permit_number": "PMT-998877",
            "vehicle_model_year": 2022,
            "vehicle_reg_place": "Bengaluru",
            "insurer": "Acme Insurance Ltd.",
            "insurance_policy_number": "POL-123456789",
            "vehicle_gross_weight": 12.5,
            "group_number": "1"
        }
    ],
    "multivehicle_group_details": [
        {
            "group_id": "460000000456789",
            "group_name": "Group 1",
            "from_place": "Bengaluru",
            "from_state": "29",
            "from_state_formatted": "Karnataka",
            "reason": "first_time",
            "to_place": "Mumbai",
            "to_state": "27",
            "to_state_formatted": "Maharashtra",
            "remarks": "Split shipment",
            "group_number": "1",
            "group_number_formatted": "Group 1",
            "total_quantity": 5000,
            "transportation_mode": "road",
            "transportation_mode_formatted": "Road",
            "operation_type": "multi_vehicle",
            "unit_id": "460000000999111",
            "unit": "kg",
            "uqc": "KGS",
            "vehicle_details": [
                {
                    "vehicle_id": "460000000345678",
                    "transportation_mode": "road",
                    "transportation_mode_formatted": "Road",
                    "transporter_document_number": "LR-12345",
                    "transporter_document_date": "2025-01-15",
                    "vehicle_number": "KA01AB1234",
                    "updated_time": "2025-01-15 10:35:00",
                    "operation_type": "multi_vehicle",
                    "from_place": "Bengaluru",
                    "from_state": "29",
                    "from_state_formatted": "Karnataka",
                    "reason": "due_to_transhipment",
                    "remarks": "Mid-route swap",
                    "vehicle_type": "regular",
                    "vehicle_type_formatted": "Regular",
                    "quantity": 1000,
                    "group_number": "1",
                    "group_number_formatted": "Group 1",
                    "is_cancelled": false,
                    "multivehicle_group_id": "460000000456789"
                }
            ]
        }
    ]
}

Create an e-Way Bill for a transaction such as an invoice, credit note, or delivery challan. The transaction is identified by entity_id and entity_type. Set action to save_generate to generate the e-Way Bill on the GST portal in the same call. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

entity_id

string

(Required)

ID of the source transaction (invoice, credit note, or delivery challan) for which the e-Way Bill is generated.

entity_type

string

Type of the source transaction. Allowed Values: invoice, creditnote, deliverychallan.

branch_id

string

ID of the branch.

location_id

string

ID of the location.

ewaybill_number

string

12-digit e-Way Bill number issued by the GST portal. Required only when action is manually_generated. Max-length [15].

ewaybill_date

string

Date when the e-Way Bill was generated on the GST portal. Format: yyyy-mm-dd.

transporter_id

string

ID of the transporter associated with the e-Way Bill.

transportation_mode

string

Mode of transportation. Allowed Values: road, rail, air, ship.

transaction_type

string

Transaction type for the e-Way Bill. Allowed Values: regular, bill_to_ship_to, bill_from_dispatch_from, combination_of_2_and_3.

dispatch_from_address_id

string

ID of the dispatch-from address.

ship_to_address_id

string

ID of the shipping address.

sub_supply_type

string

Reason for the transportation of goods. Allowed Values: supply, export, job_work, sktd, recipient_not_known, for_own_use, exhibition_or_fairs, line_sales, others.

sub_supply_type_desc

string

Description for the sub-supply type when sub_supply_type is others. Max-length [20].

vehicle_number

string

Registration number of the vehicle. Max-length [20].

transporter_document_number

string

Document number associated with the consignment. Max-length [30].

transporter_document_date

string

Date of the transporter document. Format: yyyy-mm-dd.

ship_to_state_code

string

State code of the shipping address.

distance

integer

Approximate distance, in kilometres, between the dispatch and shipping addresses.

validity_days

integer

Number of days for which the e-Way Bill is valid.

vehicle_type

string

Type of vehicle. Allowed Values: regular and over_dimensional_cargo. Max-length [100].

vehicle_permit_type

string

Permit type of the vehicle. Max-length [100].

vehicle_permit_number

string

Permit number of the vehicle. Max-length [100].

vehicle_model_year

integer

Year in which the vehicle was manufactured.

vehicle_reg_place

string

Place where the vehicle is registered. Max-length [100].

vehicle_gross_weight

double

Gross weight of the vehicle, in metric tonnes.

insurer

string

Name of the insurance provider for the consignment. Max-length [100].

insurance_policy_number

string

Policy number of the consignment insurance. Max-length [150].

action

string

Action to be performed. Allowed Values: save, save_generate, manually_generated.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/ewaybills?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "entity_id": "460000000098765",
    "entity_type": "invoice",
    "branch_id": "460000001012345",
    "location_id": "460000001123456",
    "ewaybill_number": "123456789012",
    "ewaybill_date": "2025-01-15",
    "transporter_id": "460000000234567",
    "transportation_mode": "road",
    "transaction_type": "regular",
    "dispatch_from_address_id": "460000000678901",
    "ship_to_address_id": "460000000678902",
    "sub_supply_type": "supply",
    "sub_supply_type_desc": "Sample movement",
    "vehicle_number": "KA01AB1234",
    "transporter_document_number": "LR-12345",
    "transporter_document_date": "2025-01-15",
    "ship_to_state_code": "27",
    "distance": 350,
    "validity_days": 1,
    "vehicle_type": "regular",
    "vehicle_permit_type": "national",
    "vehicle_permit_number": "PMT-998877",
    "vehicle_model_year": 2022,
    "vehicle_reg_place": "Bengaluru",
    "vehicle_gross_weight": 12.5,
    "insurer": "Acme Insurance Ltd.",
    "insurance_policy_number": "POL-123456789",
    "action": "save_generate"
}

{
    "code": 0,
    "message": "The e-Way Bill details have been saved.",
    "ewaybill": {
        "ewaybill_id": "460000000123456",
        "entity_id": "460000000098765",
        "entity_type": "invoice",
        "entity_number": "INV-00045",
        "entity_date_formatted": "15 Jan 2025",
        "entity_status": "sent",
        "supplier_gstin": "29ABCDE1234F1Z5",
        "customer_name": "Zylker Trading Co.",
        "customer_gstin": "27FGHIJ5678K1Z2",
        "ewaybill_number": "123456789012",
        "eway_bill_number": "123456789012",
        "ewaybill_date": "2025-01-15 10:30:00",
        "ewaybill_start_date": "2025-01-15",
        "ewaybill_start_date_formatted": "15 Jan 2025",
        "ewaybill_expiry_date": "2025-01-16 10:30:00",
        "ewaybill_status": "generated",
        "ewaybill_status_formatted": "Generated",
        "ewaybill_type": "general",
        "validity_days": 1,
        "can_allow_print_ewaybill": true,
        "can_allow_cancel_ewaybill": true,
        "cancel_reason": "duplicate",
        "cancel_reason_formatted": "Duplicate",
        "cancel_remarks": "Duplicate entry",
        "cancel_remarks_formatted": "Duplicate entry",
        "transporter_id": "460000000234567",
        "transporter_name": "Speedy Logistics",
        "transporter_license": "TL-998877",
        "transporter_registration_id": "12AAAAA0000A1Z5",
        "sub_supply_type": "supply",
        "sub_supply_type_desc": "Sample movement",
        "distance": 350,
        "transportation_mode": "road",
        "transporter_document_number": "LR-12345",
        "transporter_document_date": "2025-01-15",
        "vehicle_number": "KA01AB1234",
        "vehicle_type": "regular",
        "vehicle_type_formatted": "Regular",
        "vehicle_permit_type": "national",
        "vehicle_permit_type_formatted": "National",
        "vehicle_permit_number": "PMT-998877",
        "vehicle_model_year": 2022,
        "vehicle_reg_place": "Bengaluru",
        "vehicle_gross_weight": 12.5,
        "insurer": "Acme Insurance Ltd.",
        "insurance_policy_number": "POL-123456789",
        "place_of_dispatch": "29",
        "place_of_delivery": "27",
        "ship_to_state_code": "27",
        "dispatch_from_address_id": "460000000678901",
        "ship_to_address_id": "460000000678902",
        "entity_total": 50000,
        "is_vehicle_details_push_failed": false,
        "vehicle_details": [
            {
                "transportation_mode": "road",
                "transportation_mode_formatted": "Road",
                "transporter_document_number": "LR-12345",
                "transporter_document_date": "2025-01-15",
                "vehicle_number": "KA01AB1234",
                "updated_time": "2025-01-15 10:35:00",
                "operation_type": "create",
                "from_place": "Bengaluru",
                "from_state": "29",
                "from_state_formatted": "Karnataka",
                "reason": "first_time",
                "remarks": "Initial dispatch",
                "vehicle_type": "regular",
                "vehicle_type_formatted": "Regular",
                "vehicle_permit_type": "national",
                "vehicle_permit_number": "PMT-998877",
                "vehicle_model_year": 2022,
                "vehicle_reg_place": "Bengaluru",
                "insurer": "Acme Insurance Ltd.",
                "insurance_policy_number": "POL-123456789",
                "vehicle_gross_weight": 12.5,
                "group_number": "1"
            }
        ],
        "multivehicle_group_details": [
            {
                "group_id": "460000000456789",
                "group_name": "Group 1",
                "from_place": "Bengaluru",
                "from_state": "29",
                "from_state_formatted": "Karnataka",
                "reason": "first_time",
                "to_place": "Mumbai",
                "to_state": "27",
                "to_state_formatted": "Maharashtra",
                "remarks": "Split shipment",
                "group_number": "1",
                "group_number_formatted": "Group 1",
                "total_quantity": 5000,
                "transportation_mode": "road",
                "transportation_mode_formatted": "Road",
                "operation_type": "multi_vehicle",
                "unit_id": "460000000999111",
                "unit": "kg",
                "uqc": "KGS",
                "vehicle_details": [
                    {
                        "vehicle_id": "460000000345678",
                        "transportation_mode": "road",
                        "transportation_mode_formatted": "Road",
                        "transporter_document_number": "LR-12345",
                        "transporter_document_date": "2025-01-15",
                        "vehicle_number": "KA01AB1234",
                        "updated_time": "2025-01-15 10:35:00",
                        "operation_type": "multi_vehicle",
                        "from_place": "Bengaluru",
                        "from_state": "29",
                        "from_state_formatted": "Karnataka",
                        "reason": "due_to_transhipment",
                        "remarks": "Mid-route swap",
                        "vehicle_type": "regular",
                        "vehicle_type_formatted": "Regular",
                        "quantity": 1000,
                        "group_number": "1",
                        "group_number_formatted": "Group 1",
                        "is_cancelled": false,
                        "multivehicle_group_id": "460000000456789"
                    }
                ]
            }
        ]
    }
}

Get the list of e-Way Bills generated for the organization. Filter by transaction type, status, date range, branch, or specific entity IDs. Available only in the India edition.
OAuth Scope : ZohoInventory.reports.READ

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

entity_type

string

(Required)

Type of transaction whose e-Way Bills are to be fetched. Allowed Values: invoice, creditnote, deliverychallan.

status

string

Status of the e-Way Bill. Allowed Values: draft, generated, cancelled, expired, excluded.

filter_by

string

Filter e-Way Bills by transaction date. Allowed Values: TransactionDate.ThisMonth, TransactionDate.ThisQuarter, TransactionDate.ThisYear, TransactionDate.PreviousMonth, TransactionDate.PreviousQuarter, TransactionDate.PreviousYear, TransactionDate.CustomDate.

sort_column

string

Column on which the list is sorted. Allowed Values: entity_date, expires_in, ewaybill_date, created_time.

sort_order

string

Order in which the list is sorted. Allowed Values: A (ascending) and D (descending).

entity_ids

string

Comma-separated list of transaction IDs whose e-Way Bills are to be fetched. Maximum of 200 IDs.

branch_id

string

ID of the branch.

location_id

string

ID of the location.

from_date

string

Start date of the date range. Format: yyyy-mm-dd.

to_date

string

End date of the date range. Format: yyyy-mm-dd.

export_format

string

When provided, exports the list in the specified format. Allowed Values: ewaybill.

page

integer

Page number to be fetched. Default value is 1.

per_page

integer

Number of records to be fetched per page. Default value is 10.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills?organization_id=10234695&entity_type=invoice"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills?organization_id=10234695&entity_type=invoice")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills?organization_id=10234695&entity_type=invoice', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v1/ewaybills?organization_id=10234695&entity_type=invoice", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills?organization_id=10234695&entity_type=invoice",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills?organization_id=10234695&entity_type=invoice' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "ewaybills": [
        {
            "ewaybill_id": "460000000123456",
            "entity_id": "460000000098765",
            "entity_type": "invoice",
            "ewaybill_type": "general",
            "entity_number": "INV-00045",
            "entity_date": "2025-01-15",
            "customer_name": "Zylker Trading Co.",
            "customer_gstin": "27FGHIJ5678K1Z2",
            "total": 50000,
            "ewaybill_number": "123456789012",
            "ewaybill_status": "generated",
            "ewaybill_status_formatted": "Generated",
            "ewaybill_date": "2025-01-15",
            "expires_in": "2025-01-16",
            "is_expired": false
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 10,
        "has_more_page": false,
        "report_name": "e-Way Bills",
        "applied_filter": "TransactionDate.ThisMonth",
        "sort_column": "ewaybill_date",
        "sort_order": "D"
    }
}

Update the details of an existing e-Way Bill. Use the action query parameter to control whether the changes are saved as a draft, generated on the GST portal, or marked as manually generated. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

action

string

Action to be performed when the e-Way Bill is updated. Allowed Values: save, save_generate, manually_generated.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v1/ewaybills/460000000123456?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "entity_id": "460000000098765",
    "entity_type": "invoice",
    "branch_id": "460000001012345",
    "location_id": "460000001123456",
    "ewaybill_number": "123456789012",
    "ewaybill_date": "2025-01-15",
    "transporter_id": "460000000234567",
    "transportation_mode": "road",
    "transaction_type": "regular",
    "dispatch_from_address_id": "460000000678901",
    "ship_to_address_id": "460000000678902",
    "sub_supply_type": "supply",
    "sub_supply_type_desc": "Sample movement",
    "vehicle_number": "KA01AB1234",
    "transporter_document_number": "LR-12345",
    "transporter_document_date": "2025-01-15",
    "ship_to_state_code": "27",
    "distance": 350,
    "validity_days": 1,
    "vehicle_type": "regular",
    "vehicle_permit_type": "national",
    "vehicle_permit_number": "PMT-998877",
    "vehicle_model_year": 2022,
    "vehicle_reg_place": "Bengaluru",
    "vehicle_gross_weight": 12.5,
    "insurer": "Acme Insurance Ltd.",
    "insurance_policy_number": "POL-123456789",
    "action": "save_generate"
}

{
    "code": 0,
    "message": "The e-Way Bill details have been saved.",
    "ewaybill": {
        "ewaybill_id": "460000000123456",
        "entity_id": "460000000098765",
        "entity_type": "invoice",
        "entity_number": "INV-00045",
        "entity_date_formatted": "15 Jan 2025",
        "entity_status": "sent",
        "supplier_gstin": "29ABCDE1234F1Z5",
        "customer_name": "Zylker Trading Co.",
        "customer_gstin": "27FGHIJ5678K1Z2",
        "ewaybill_number": "123456789012",
        "eway_bill_number": "123456789012",
        "ewaybill_date": "2025-01-15 10:30:00",
        "ewaybill_start_date": "2025-01-15",
        "ewaybill_start_date_formatted": "15 Jan 2025",
        "ewaybill_expiry_date": "2025-01-16 10:30:00",
        "ewaybill_status": "generated",
        "ewaybill_status_formatted": "Generated",
        "ewaybill_type": "general",
        "validity_days": 1,
        "can_allow_print_ewaybill": true,
        "can_allow_cancel_ewaybill": true,
        "cancel_reason": "duplicate",
        "cancel_reason_formatted": "Duplicate",
        "cancel_remarks": "Duplicate entry",
        "cancel_remarks_formatted": "Duplicate entry",
        "transporter_id": "460000000234567",
        "transporter_name": "Speedy Logistics",
        "transporter_license": "TL-998877",
        "transporter_registration_id": "12AAAAA0000A1Z5",
        "sub_supply_type": "supply",
        "sub_supply_type_desc": "Sample movement",
        "distance": 350,
        "transportation_mode": "road",
        "transporter_document_number": "LR-12345",
        "transporter_document_date": "2025-01-15",
        "vehicle_number": "KA01AB1234",
        "vehicle_type": "regular",
        "vehicle_type_formatted": "Regular",
        "vehicle_permit_type": "national",
        "vehicle_permit_type_formatted": "National",
        "vehicle_permit_number": "PMT-998877",
        "vehicle_model_year": 2022,
        "vehicle_reg_place": "Bengaluru",
        "vehicle_gross_weight": 12.5,
        "insurer": "Acme Insurance Ltd.",
        "insurance_policy_number": "POL-123456789",
        "place_of_dispatch": "29",
        "place_of_delivery": "27",
        "ship_to_state_code": "27",
        "dispatch_from_address_id": "460000000678901",
        "ship_to_address_id": "460000000678902",
        "entity_total": 50000,
        "is_vehicle_details_push_failed": false,
        "vehicle_details": [
            {
                "transportation_mode": "road",
                "transportation_mode_formatted": "Road",
                "transporter_document_number": "LR-12345",
                "transporter_document_date": "2025-01-15",
                "vehicle_number": "KA01AB1234",
                "updated_time": "2025-01-15 10:35:00",
                "operation_type": "create",
                "from_place": "Bengaluru",
                "from_state": "29",
                "from_state_formatted": "Karnataka",
                "reason": "first_time",
                "remarks": "Initial dispatch",
                "vehicle_type": "regular",
                "vehicle_type_formatted": "Regular",
                "vehicle_permit_type": "national",
                "vehicle_permit_number": "PMT-998877",
                "vehicle_model_year": 2022,
                "vehicle_reg_place": "Bengaluru",
                "insurer": "Acme Insurance Ltd.",
                "insurance_policy_number": "POL-123456789",
                "vehicle_gross_weight": 12.5,
                "group_number": "1"
            }
        ],
        "multivehicle_group_details": [
            {
                "group_id": "460000000456789",
                "group_name": "Group 1",
                "from_place": "Bengaluru",
                "from_state": "29",
                "from_state_formatted": "Karnataka",
                "reason": "first_time",
                "to_place": "Mumbai",
                "to_state": "27",
                "to_state_formatted": "Maharashtra",
                "remarks": "Split shipment",
                "group_number": "1",
                "group_number_formatted": "Group 1",
                "total_quantity": 5000,
                "transportation_mode": "road",
                "transportation_mode_formatted": "Road",
                "operation_type": "multi_vehicle",
                "unit_id": "460000000999111",
                "unit": "kg",
                "uqc": "KGS",
                "vehicle_details": [
                    {
                        "vehicle_id": "460000000345678",
                        "transportation_mode": "road",
                        "transportation_mode_formatted": "Road",
                        "transporter_document_number": "LR-12345",
                        "transporter_document_date": "2025-01-15",
                        "vehicle_number": "KA01AB1234",
                        "updated_time": "2025-01-15 10:35:00",
                        "operation_type": "multi_vehicle",
                        "from_place": "Bengaluru",
                        "from_state": "29",
                        "from_state_formatted": "Karnataka",
                        "reason": "due_to_transhipment",
                        "remarks": "Mid-route swap",
                        "vehicle_type": "regular",
                        "vehicle_type_formatted": "Regular",
                        "quantity": 1000,
                        "group_number": "1",
                        "group_number_formatted": "Group 1",
                        "is_cancelled": false,
                        "multivehicle_group_id": "460000000456789"
                    }
                ]
            }
        ]
    }
}

Get the details of an e-Way Bill, including transporter, vehicle, dispatch, and shipping information. Available only in the India edition.
OAuth Scope : ZohoInventory.invoices.READ

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

boolean

Set to true to retrieve the printable representation of the e-Way Bill. Allowed values true and false.

include

string

Include additional content in the response. Allowed Values: html.

template_type

string

Template format used to render the e-Way Bill. Allowed Values: simple and detailed.

print_with_document

boolean

Set to true to combine the e-Way Bill with the source document in the printable output. Allowed values true and false.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v1/ewaybills/460000000123456?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "ewaybill": {
        "ewaybill_id": "460000000123456",
        "entity_id": "460000000098765",
        "entity_type": "invoice",
        "entity_number": "INV-00045",
        "entity_date_formatted": "15 Jan 2025",
        "entity_status": "sent",
        "supplier_gstin": "29ABCDE1234F1Z5",
        "customer_name": "Zylker Trading Co.",
        "customer_gstin": "27FGHIJ5678K1Z2",
        "ewaybill_number": "123456789012",
        "eway_bill_number": "123456789012",
        "ewaybill_date": "2025-01-15 10:30:00",
        "ewaybill_start_date": "2025-01-15",
        "ewaybill_start_date_formatted": "15 Jan 2025",
        "ewaybill_expiry_date": "2025-01-16 10:30:00",
        "ewaybill_status": "generated",
        "ewaybill_status_formatted": "Generated",
        "ewaybill_type": "general",
        "validity_days": 1,
        "can_allow_print_ewaybill": true,
        "can_allow_cancel_ewaybill": true,
        "cancel_reason": "duplicate",
        "cancel_reason_formatted": "Duplicate",
        "cancel_remarks": "Duplicate entry",
        "cancel_remarks_formatted": "Duplicate entry",
        "transporter_id": "460000000234567",
        "transporter_name": "Speedy Logistics",
        "transporter_license": "TL-998877",
        "transporter_registration_id": "12AAAAA0000A1Z5",
        "sub_supply_type": "supply",
        "sub_supply_type_desc": "Sample movement",
        "distance": 350,
        "transportation_mode": "road",
        "transporter_document_number": "LR-12345",
        "transporter_document_date": "2025-01-15",
        "vehicle_number": "KA01AB1234",
        "vehicle_type": "regular",
        "vehicle_type_formatted": "Regular",
        "vehicle_permit_type": "national",
        "vehicle_permit_type_formatted": "National",
        "vehicle_permit_number": "PMT-998877",
        "vehicle_model_year": 2022,
        "vehicle_reg_place": "Bengaluru",
        "vehicle_gross_weight": 12.5,
        "insurer": "Acme Insurance Ltd.",
        "insurance_policy_number": "POL-123456789",
        "place_of_dispatch": "29",
        "place_of_delivery": "27",
        "ship_to_state_code": "27",
        "dispatch_from_address_id": "460000000678901",
        "ship_to_address_id": "460000000678902",
        "entity_total": 50000,
        "is_vehicle_details_push_failed": false,
        "vehicle_details": [
            {
                "transportation_mode": "road",
                "transportation_mode_formatted": "Road",
                "transporter_document_number": "LR-12345",
                "transporter_document_date": "2025-01-15",
                "vehicle_number": "KA01AB1234",
                "updated_time": "2025-01-15 10:35:00",
                "operation_type": "create",
                "from_place": "Bengaluru",
                "from_state": "29",
                "from_state_formatted": "Karnataka",
                "reason": "first_time",
                "remarks": "Initial dispatch",
                "vehicle_type": "regular",
                "vehicle_type_formatted": "Regular",
                "vehicle_permit_type": "national",
                "vehicle_permit_number": "PMT-998877",
                "vehicle_model_year": 2022,
                "vehicle_reg_place": "Bengaluru",
                "insurer": "Acme Insurance Ltd.",
                "insurance_policy_number": "POL-123456789",
                "vehicle_gross_weight": 12.5,
                "group_number": "1"
            }
        ],
        "multivehicle_group_details": [
            {
                "group_id": "460000000456789",
                "group_name": "Group 1",
                "from_place": "Bengaluru",
                "from_state": "29",
                "from_state_formatted": "Karnataka",
                "reason": "first_time",
                "to_place": "Mumbai",
                "to_state": "27",
                "to_state_formatted": "Maharashtra",
                "remarks": "Split shipment",
                "group_number": "1",
                "group_number_formatted": "Group 1",
                "total_quantity": 5000,
                "transportation_mode": "road",
                "transportation_mode_formatted": "Road",
                "operation_type": "multi_vehicle",
                "unit_id": "460000000999111",
                "unit": "kg",
                "uqc": "KGS",
                "vehicle_details": [
                    {
                        "vehicle_id": "460000000345678",
                        "transportation_mode": "road",
                        "transportation_mode_formatted": "Road",
                        "transporter_document_number": "LR-12345",
                        "transporter_document_date": "2025-01-15",
                        "vehicle_number": "KA01AB1234",
                        "updated_time": "2025-01-15 10:35:00",
                        "operation_type": "multi_vehicle",
                        "from_place": "Bengaluru",
                        "from_state": "29",
                        "from_state_formatted": "Karnataka",
                        "reason": "due_to_transhipment",
                        "remarks": "Mid-route swap",
                        "vehicle_type": "regular",
                        "vehicle_type_formatted": "Regular",
                        "quantity": 1000,
                        "group_number": "1",
                        "group_number_formatted": "Group 1",
                        "is_cancelled": false,
                        "multivehicle_group_id": "460000000456789"
                    }
                ]
            }
        ]
    }
}

Delete an e-Way Bill from the organization. Generated e-Way Bills cannot be deleted; cancel them on the GST portal first. Available only in the India edition.
OAuth Scope : ZohoInventory.estimates.DELETE

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/inventory/v1/ewaybills/460000000123456?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The e-Way Bill has been deleted."
}

Cancel a generated e-Way Bill on the GST portal. The e-Way Bill can be cancelled within 24 hours of generation, provided it has not been verified during transit. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

reason

string

(Required)

Reason code for cancelling the e-Way Bill. Allowed Values: duplicate, order_cancelled, data_entry_mistake, others.

remarks

string

Free-form remarks for the cancellation. Max-length [50].

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/cancel?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/cancel?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/cancel?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/ewaybills/460000000123456/cancel?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/cancel?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/cancel?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "reason": "duplicate",
    "remarks": "Duplicate entry"
}

{
    "code": 0,
    "message": "The e-Way Bill has been cancelled."
}

Pull the latest status of an e-Way Bill from the GST portal and update it in Zoho Inventory. Available only in the India edition.
OAuth Scope : ZohoInventory.reports.CREATE

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/sync?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/sync?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/sync?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v1/ewaybills/460000000123456/sync?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/sync?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/sync?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The e-Way Bill has been synced successfully."
}

Mark a set of transactions as not requiring an e-Way Bill so they are excluded from the e-Way Bills list. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

entity_ids

string

(Required)

Comma-separated list of transaction IDs to be excluded. Maximum of 50 IDs.

entity_type

string

(Required)

Type of transaction. Allowed Values: invoice, creditnote, deliverychallan.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/exclude?organization_id=10234695&entity_ids=460000000098765,460000000098766&entity_type=invoice"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/exclude?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/exclude?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v1/ewaybills/exclude?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/exclude?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/exclude?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The selected transactions have been excluded from e-Way Bill generation."
}

Move previously excluded transactions back into the list of transactions that require an e-Way Bill. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

entity_ids

string

(Required)

Comma-separated list of transaction IDs to be restored. Maximum of 50 IDs.

entity_type

string

(Required)

Type of transaction. Allowed Values: invoice, creditnote, deliverychallan.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/restore?organization_id=10234695&entity_ids=460000000098765,460000000098766&entity_type=invoice"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/restore?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/restore?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v1/ewaybills/restore?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/restore?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/restore?organization_id=10234695&entity_ids=460000000098765%2C460000000098766&entity_type=invoice' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The selected transactions have been restored for e-Way Bill generation."
}

Update the vehicle details of an e-Way Bill on the GST portal during transit (for example, when the vehicle is changed at a transhipment point). Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

vehicle_id

string

ID of the vehicle entry being modified.

vehicle_number

string

Registration number of the vehicle. Max-length [20].

vehicle_type

string

Type of vehicle. Allowed Values: regular and over_dimensional_cargo. Max-length [100].

transportation_mode

string

(Required)

Mode of transportation. Allowed Values: road, rail, air, ship.

from_place

string

(Required)

Place from which the vehicle is starting. Max-length [50].

from_state

string

(Required)

State code from which the vehicle is starting.

reason

string

(Required)

Reason for the vehicle update. Allowed Values: due_to_break_down, due_to_transhipment, first_time, others.

remarks

string

Remarks for the vehicle update. Max-length [50].

transporter_document_number

string

Document number associated with the consignment. Max-length [30].

transporter_document_date

string

Date of the transporter document. Format: yyyy-mm-dd.

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/vehicles?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/vehicles?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/vehicles?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/ewaybills/460000000123456/vehicles?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/vehicles?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/vehicles?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "vehicle_id": "460000000345678",
    "vehicle_number": "KA01AB1234",
    "vehicle_type": "regular",
    "transportation_mode": "road",
    "from_place": "Bengaluru",
    "from_state": "29",
    "reason": "first_time",
    "remarks": "Initial dispatch",
    "transporter_document_number": "LR-12345",
    "transporter_document_date": "2025-01-15"
}

{
    "code": 0,
    "message": "The vehicle details have been added to the e-Way Bill.",
    "vehicle_details": {
        "transportation_mode": "road",
        "transportation_mode_formatted": "Road",
        "transporter_document_number": "LR-12345",
        "transporter_document_date": "2025-01-15",
        "vehicle_number": "KA01AB1234",
        "updated_time": "2025-01-15 10:35:00",
        "operation_type": "create",
        "from_place": "Bengaluru",
        "from_state": "29",
        "from_state_formatted": "Karnataka",
        "reason": "first_time",
        "remarks": "Initial dispatch",
        "vehicle_type": "regular",
        "vehicle_type_formatted": "Regular",
        "vehicle_permit_type": "national",
        "vehicle_permit_number": "PMT-998877",
        "vehicle_model_year": 2022,
        "vehicle_reg_place": "Bengaluru",
        "insurer": "Acme Insurance Ltd.",
        "insurance_policy_number": "POL-123456789",
        "vehicle_gross_weight": 12.5,
        "group_number": "1"
    }
}

Update an existing vehicle entry in an e-Way Bill. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

vehicle_id

string

(Required)

Unique identifier of the vehicle entry.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/vehicles/460000000345678?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/vehicles/460000000345678?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/vehicles/460000000345678?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v1/ewaybills/460000000123456/vehicles/460000000345678?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/vehicles/460000000345678?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/vehicles/460000000345678?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "vehicle_id": "460000000345678",
    "vehicle_number": "KA01AB1234",
    "vehicle_type": "regular",
    "transportation_mode": "road",
    "from_place": "Bengaluru",
    "from_state": "29",
    "reason": "first_time",
    "remarks": "Initial dispatch",
    "transporter_document_number": "LR-12345",
    "transporter_document_date": "2025-01-15"
}

{
    "code": 0,
    "message": "The vehicle details have been updated.",
    "vehicle_details": {
        "transportation_mode": "road",
        "transportation_mode_formatted": "Road",
        "transporter_document_number": "LR-12345",
        "transporter_document_date": "2025-01-15",
        "vehicle_number": "KA01AB1234",
        "updated_time": "2025-01-15 10:35:00",
        "operation_type": "create",
        "from_place": "Bengaluru",
        "from_state": "29",
        "from_state_formatted": "Karnataka",
        "reason": "first_time",
        "remarks": "Initial dispatch",
        "vehicle_type": "regular",
        "vehicle_type_formatted": "Regular",
        "vehicle_permit_type": "national",
        "vehicle_permit_number": "PMT-998877",
        "vehicle_model_year": 2022,
        "vehicle_reg_place": "Bengaluru",
        "insurer": "Acme Insurance Ltd.",
        "insurance_policy_number": "POL-123456789",
        "vehicle_gross_weight": 12.5,
        "group_number": "1"
    }
}

Extend the validity of an e-Way Bill on the GST portal when goods cannot be transported within the original validity period. The extension can be requested between 8 hours before and 8 hours after the e-Way Bill expires. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.UPDATE

Arguments

current_place

string

Current place of the consignment. Max-length [50].

current_state

string

State code of the current location of the consignment.

current_pincode

string

PIN Code of the current location.

consignment_mode

string

Mode of consignment. Allowed Values: in_transit and in_movement.

vehicle_type

string

Type of vehicle. Allowed Values: regular and over_dimensional_cargo.

vehicle_number

string

Registration number of the vehicle. Max-length [20].

transporter_document_number

string

Document number associated with the consignment. Max-length [30].

transporter_document_date

string

Date of the transporter document. Format: yyyy-mm-dd.

remaining_distance

integer

Remaining distance to the destination, in kilometres.

address_line_1

string

Address line 1 of the current location. Max-length [200].

address_line_2

string

Address line 2 of the current location. Max-length [200].

address_line_3

string

Address line 3 of the current location. Max-length [200].

extend_reason

string

Reason for extending the validity. Allowed Values: natural_calamity, law_and_order, transhipment, accident, others.

extend_remarks

string

Free-form remarks for the validity extension. Max-length [50].

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

vehicle_id

string

ID of the vehicle for which the validity is to be extended.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/extendvalidity?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/extendvalidity?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/extendvalidity?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v1/ewaybills/460000000123456/extendvalidity?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/extendvalidity?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/extendvalidity?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "current_place": "Pune",
    "current_state": "27",
    "current_pincode": "411001",
    "consignment_mode": "in_movement",
    "vehicle_type": "regular",
    "vehicle_number": "KA01AB1234",
    "transporter_document_number": "LR-12345",
    "transporter_document_date": "2025-01-15",
    "remaining_distance": 200,
    "address_line_1": "12, MG Road",
    "address_line_2": "Near Central Park",
    "address_line_3": "Pune",
    "extend_reason": "transhipment",
    "extend_remarks": "Vehicle breakdown"
}

{
    "code": 0,
    "message": "The e-Way Bill validity has been extended."
}

Initiate a multi-vehicle movement for an e-Way Bill when the consignment is split across multiple vehicles between two consignment points. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

reason

string

(Required)

Reason for initiating the multi-vehicle movement. Allowed Values: due_to_break_down, due_to_transhipment, first_time, others.

remarks

string

Remarks for the multi-vehicle movement. Max-length [50].

from_place

string

(Required)

Place from which the consignment is split. Max-length [50].

from_state

string

(Required)

State code from which the consignment is split.

to_place

string

(Required)

Place at which the consignment is recombined. Max-length [50].

to_state

string

(Required)

State code at which the consignment is recombined.

transportation_mode

string

(Required)

Mode of transportation. Allowed Values: road, rail, air, ship.

total_quantity

double

Total quantity of the consignment.

unit_id

string

(Required)

ID of the unit of measurement.

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/initiate?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/initiate?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/initiate?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/ewaybills/460000000123456/multivehicle/initiate?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/multivehicle/initiate?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/initiate?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "reason": "due_to_transhipment",
    "remarks": "Split shipment for transhipment",
    "from_place": "Bengaluru",
    "from_state": "29",
    "to_place": "Mumbai",
    "to_state": "27",
    "transportation_mode": "road",
    "total_quantity": 5000,
    "unit_id": "460000000999111"
}

{
    "code": 0,
    "message": "The multi-vehicle movement has been initiated.",
    "multivehicle_group_details": [
        {
            "group_id": "460000000456789",
            "group_name": "Group 1",
            "from_place": "Bengaluru",
            "from_state": "29",
            "from_state_formatted": "Karnataka",
            "reason": "first_time",
            "to_place": "Mumbai",
            "to_state": "27",
            "to_state_formatted": "Maharashtra",
            "remarks": "Split shipment",
            "group_number": "1",
            "group_number_formatted": "Group 1",
            "total_quantity": 5000,
            "transportation_mode": "road",
            "transportation_mode_formatted": "Road",
            "operation_type": "multi_vehicle",
            "unit_id": "460000000999111",
            "unit": "kg",
            "uqc": "KGS",
            "vehicle_details": [
                {
                    "vehicle_id": "460000000345678",
                    "transportation_mode": "road",
                    "transportation_mode_formatted": "Road",
                    "transporter_document_number": "LR-12345",
                    "transporter_document_date": "2025-01-15",
                    "vehicle_number": "KA01AB1234",
                    "updated_time": "2025-01-15 10:35:00",
                    "operation_type": "multi_vehicle",
                    "from_place": "Bengaluru",
                    "from_state": "29",
                    "from_state_formatted": "Karnataka",
                    "reason": "due_to_transhipment",
                    "remarks": "Mid-route swap",
                    "vehicle_type": "regular",
                    "vehicle_type_formatted": "Regular",
                    "quantity": 1000,
                    "group_number": "1",
                    "group_number_formatted": "Group 1",
                    "is_cancelled": false,
                    "multivehicle_group_id": "460000000456789"
                }
            ]
        },
        {...},
        {...}
    ]
}

Add up to five vehicles to an existing multi-vehicle movement group of an e-Way Bill. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

vehicle_number

string

(Required)

Registration number of the vehicle. Max-length [20].

transporter_document_number

string

(Required)

Document number associated with the consignment. Max-length [30].

transporter_document_date

string

Date of the transporter document. Format: yyyy-mm-dd.

quantity

double

Quantity carried by this vehicle.

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

group_id

string

(Required)

Unique identifier of the multi-vehicle movement group.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

[
    {
        "vehicle_number": "KA01AB1234",
        "transporter_document_number": "LR-12345",
        "transporter_document_date": "2025-01-15",
        "quantity": 1000
    }
]

{
    "code": 0,
    "message": "The vehicles have been added to the multi-vehicle movement.",
    "vehicle_response_details": [
        {
            "vehicle_id": "460000000345678",
            "status": "success",
            "message": "Vehicle added."
        },
        {...},
        {...}
    ]
}

Replace an existing vehicle entry in a multi-vehicle movement group of an e-Way Bill. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

transporter_document_number

string

(Required)

Document number associated with the consignment. Max-length [30].

vehicle_number

string

(Required)

Registration number of the vehicle. Max-length [20].

reason

string

(Required)

Reason for changing the vehicle. Allowed Values: due_to_break_down, due_to_transhipment, first_time, others.

remarks

string

Remarks for the vehicle change. Max-length [50].

from_place

string

(Required)

Place from which the new vehicle is starting. Max-length [50].

from_state

string

(Required)

State code from which the new vehicle is starting.

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

group_id

string

(Required)

Unique identifier of the multi-vehicle movement group.

updated_vehicle_id

string

(Required)

Unique identifier of the vehicle to be replaced.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles/460000000567890?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles/460000000567890?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles/460000000567890?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles/460000000567890?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles/460000000567890?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/multivehicle/460000000456789/vehicles/460000000567890?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "transporter_document_number": "LR-12345",
    "vehicle_number": "KA01AB1234",
    "reason": "due_to_break_down",
    "remarks": "Replacement vehicle",
    "from_place": "Pune",
    "from_state": "27"
}

{
    "code": 0,
    "message": "The vehicle in the multi-vehicle movement has been updated.",
    "multivehicle_group_details": [
        {
            "group_id": "460000000456789",
            "group_name": "Group 1",
            "from_place": "Bengaluru",
            "from_state": "29",
            "from_state_formatted": "Karnataka",
            "reason": "first_time",
            "to_place": "Mumbai",
            "to_state": "27",
            "to_state_formatted": "Maharashtra",
            "remarks": "Split shipment",
            "group_number": "1",
            "group_number_formatted": "Group 1",
            "total_quantity": 5000,
            "transportation_mode": "road",
            "transportation_mode_formatted": "Road",
            "operation_type": "multi_vehicle",
            "unit_id": "460000000999111",
            "unit": "kg",
            "uqc": "KGS",
            "vehicle_details": [
                {
                    "vehicle_id": "460000000345678",
                    "transportation_mode": "road",
                    "transportation_mode_formatted": "Road",
                    "transporter_document_number": "LR-12345",
                    "transporter_document_date": "2025-01-15",
                    "vehicle_number": "KA01AB1234",
                    "updated_time": "2025-01-15 10:35:00",
                    "operation_type": "multi_vehicle",
                    "from_place": "Bengaluru",
                    "from_state": "29",
                    "from_state_formatted": "Karnataka",
                    "reason": "due_to_transhipment",
                    "remarks": "Mid-route swap",
                    "vehicle_type": "regular",
                    "vehicle_type_formatted": "Regular",
                    "quantity": 1000,
                    "group_number": "1",
                    "group_number_formatted": "Group 1",
                    "is_cancelled": false,
                    "multivehicle_group_id": "460000000456789"
                }
            ]
        },
        {...},
        {...}
    ]
}

Create a transporter that can be associated with e-Way Bills generated for the organization. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

transporter_name

string

(Required)

Name of the transporter. Max-length [255].

transporter_license

string

License number of the transporter. Max-length [100].

transporter_registration_id

string

(Required)

GSTIN or transporter ID issued by the GST portal. Max-length [15].

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/transporters?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/transporters?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/transporters?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/ewaybills/transporters?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/transporters?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/transporters?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "transporter_name": "Speedy Logistics",
    "transporter_license": "TL-998877",
    "transporter_registration_id": "12AAAAA0000A1Z5"
}

{
    "code": 0,
    "message": "The transporter has been added.",
    "transporter": {
        "transporter_id": "460000000234567",
        "transporter_name": "Speedy Logistics",
        "transporter_license": "TL-998877",
        "transporter_registration_id": "12AAAAA0000A1Z5"
    }
}

Get the list of transporters configured for the organization. Available only in the India edition.
OAuth Scope : ZohoInventory.invoices.READ

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

page

integer

Page number to be fetched. Default value is 1.

per_page

integer

Number of records to be fetched per page. Default value is 200.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/transporters?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/transporters?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/transporters?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v1/ewaybills/transporters?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/transporters?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/transporters?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "transporters": [
        {
            "transporter_id": "460000000234567",
            "transporter_name": "Speedy Logistics",
            "transporter_license": "TL-998877",
            "transporter_registration_id": "12AAAAA0000A1Z5"
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 10,
        "has_more_page": false,
        "report_name": "e-Way Bills",
        "applied_filter": "TransactionDate.ThisMonth",
        "sort_column": "ewaybill_date",
        "sort_order": "D"
    }
}

Update the details of an existing transporter. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

transporter_id

string

(Required)

Unique identifier of the transporter.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/transporters/460000000234567?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/transporters/460000000234567?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/transporters/460000000234567?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v1/ewaybills/transporters/460000000234567?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/transporters/460000000234567?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/transporters/460000000234567?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "transporter_name": "Speedy Logistics",
    "transporter_license": "TL-998877",
    "transporter_registration_id": "12AAAAA0000A1Z5"
}

{
    "code": 0,
    "message": "The transporter details have been updated.",
    "transporter": {
        "transporter_id": "460000000234567",
        "transporter_name": "Speedy Logistics",
        "transporter_license": "TL-998877",
        "transporter_registration_id": "12AAAAA0000A1Z5"
    }
}

Update the transporter associated with an e-Way Bill. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

ewaybill_id

string

(Required)

Unique identifier of the e-Way Bill.

transporter_id

string

(Required)

Unique identifier of the transporter.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/transporters/460000000234567?organization_id=10234695"
type: PUT
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/transporters/460000000234567?organization_id=10234695")
  .put(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/transporters/460000000234567?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("PUT", "/inventory/v1/ewaybills/460000000123456/transporters/460000000234567?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/460000000123456/transporters/460000000234567?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/460000000123456/transporters/460000000234567?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The transporter has been updated for the e-Way Bill.",
    "transporter": {
        "transporter_id": "460000000234567",
        "transporter_name": "Speedy Logistics",
        "transporter_license": "TL-998877",
        "transporter_registration_id": "12AAAAA0000A1Z5"
    }
}

Add a new dispatch-from address to be used while generating e-Way Bills. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

attention

string

company_name

string

address

string

(Required)

Address line. Max-length [500].

street2

string

Second address line. Max-length [500].

city

string

(Required)

state

string

state_code

string

(Required)

State code as defined by the GST portal.

zip

string

(Required)

PIN Code of the address.

country

string

country_code

string

phone

string

fax

string

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "attention": "Warehouse Manager",
    "company_name": "Zylker Inc.",
    "address": "12, MG Road",
    "street2": "Indiranagar",
    "city": "Bengaluru",
    "state": "Karnataka",
    "state_code": "29",
    "zip": "560001",
    "country": "India",
    "country_code": "IN",
    "phone": "+91 80 12345678",
    "fax": "+91 80 12345679"
}

{
    "code": 0,
    "message": "The dispatch-from address has been added.",
    "address": {
        "address_id": "460000000678901",
        "attention": "Warehouse Manager",
        "company_name": "Zylker Inc.",
        "address": "12, MG Road",
        "street2": "Indiranagar",
        "city": "Bengaluru",
        "state": "Karnataka",
        "state_code": "29",
        "zip": "560001",
        "country": "India",
        "country_code": "IN",
        "phone": "+91 80 12345678",
        "fax": "+91 80 12345679"
    }
}

Get the list of addresses from which goods can be dispatched while generating e-Way Bills. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.READ

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "addresses": [
        {
            "address_id": "460000000678901",
            "attention": "Warehouse Manager",
            "company_name": "Zylker Inc.",
            "address": "12, MG Road",
            "street2": "Indiranagar",
            "city": "Bengaluru",
            "state": "Karnataka",
            "state_code": "29",
            "zip": "560001",
            "country": "India",
            "country_code": "IN",
            "phone": "+91 80 12345678",
            "fax": "+91 80 12345679"
        },
        {...},
        {...}
    ]
}

Delete a dispatch-from address from the list of addresses available for e-Way Bill generation. Available only in the India edition.
OAuth Scope : ZohoInventory.estimates.DELETE

Path Parameters

address_id

string

(Required)

Unique identifier of the dispatch-from address.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom/460000000678901?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom/460000000678901?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom/460000000678901?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/inventory/v1/ewaybills/address/dispatchfrom/460000000678901?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/ewaybills/address/dispatchfrom/460000000678901?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/inventory/v1/ewaybills/address/dispatchfrom/460000000678901?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The dispatch-from address has been deleted."
}

Update the GST portal credentials used for generating e-Way Bills. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.UPDATE

Arguments

ewaybill_username

string

(Required)

GST portal username registered for e-Way Bill generation. Max-length [3000].

ewaybill_password

string

(Required)

GST portal password for the registered username. Max-length [3000].

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/settings/ewaybills?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/settings/ewaybills?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/settings/ewaybills?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v1/settings/ewaybills?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/settings/ewaybills?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v1/settings/ewaybills?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "ewaybill_username": "gstapi_user",
    "ewaybill_password": "StrongP@ssw0rd"
}

{
    "code": 0,
    "message": "The e-Way Bill credentials have been updated.",
    "ewaybill_settings": {
        "ewaybill_username": "gstapi_user",
        "tax_reg_no": "29ABCDE1234F1Z5",
        "is_active": true,
        "is_ewaybill_enabled": true,
        "ewb_preference": {
            "ewb_types": [
                {
                    "ewb_type": "general",
                    "threshold": 50000,
                    "is_enabled": true
                }
            ]
        }
    }
}

Get the e-Way Bill settings configured for the organization, including the credentials registered with the GST portal and the activation status. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.READ

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/settings/ewaybills?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/settings/ewaybills?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/settings/ewaybills?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v1/settings/ewaybills?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/settings/ewaybills?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v1/settings/ewaybills?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "ewaybill_settings": {
        "ewaybill_username": "gstapi_user",
        "tax_reg_no": "29ABCDE1234F1Z5",
        "is_active": true,
        "is_ewaybill_enabled": true,
        "ewb_preference": {
            "ewb_types": [
                {
                    "ewb_type": "general",
                    "threshold": 50000,
                    "is_enabled": true
                }
            ]
        }
    }
}

Enable the e-Way Bills tab for the organization. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/settings/ewaybills/enable?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/settings/ewaybills/enable?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/settings/ewaybills/enable?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v1/settings/ewaybills/enable?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/settings/ewaybills/enable?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/settings/ewaybills/enable?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The e-Way Bills module has been enabled successfully."
}

Disable the e-Way Bills tab for the organization. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/settings/ewaybills/disable?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/settings/ewaybills/disable?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/settings/ewaybills/disable?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v1/settings/ewaybills/disable?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/settings/ewaybills/disable?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/settings/ewaybills/disable?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The e-Way Bills module has been disabled successfully."
}

Deactivate the GST portal credentials registered for e-Way Bill generation. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/settings/ewaybills/deactivate?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/settings/ewaybills/deactivate?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/settings/ewaybills/deactivate?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v1/settings/ewaybills/deactivate?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/settings/ewaybills/deactivate?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/settings/ewaybills/deactivate?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The e-Way Bill integration has been deactivated successfully.",
    "ewaybill_settings": {
        "ewaybill_username": "gstapi_user",
        "tax_reg_no": "29ABCDE1234F1Z5",
        "is_active": true,
        "is_ewaybill_enabled": true,
        "ewb_preference": {
            "ewb_types": [
                {
                    "ewb_type": "general",
                    "threshold": 50000,
                    "is_enabled": true
                }
            ]
        }
    }
}

Update the GST portal credentials for the specified tax settings. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

tax_settings_id

string

(Required)

Unique identifier of the tax settings record for which the e-Way Bill credentials apply.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "ewaybill_username": "gstapi_user",
    "ewaybill_password": "StrongP@ssw0rd"
}

{
    "code": 0,
    "message": "The e-Way Bill credentials have been updated.",
    "ewaybill_settings": {
        "ewaybill_username": "gstapi_user",
        "tax_reg_no": "29ABCDE1234F1Z5",
        "is_active": true,
        "is_ewaybill_enabled": true,
        "ewb_preference": {
            "ewb_types": [
                {
                    "ewb_type": "general",
                    "threshold": 50000,
                    "is_enabled": true
                }
            ]
        }
    }
}

Get the GST portal credentials registered for the specified tax settings. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.READ

Path Parameters

tax_settings_id

string

(Required)

Unique identifier of the tax settings record for which the e-Way Bill credentials apply.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "ewaybill_settings": {
        "ewaybill_username": "gstapi_user",
        "tax_reg_no": "29ABCDE1234F1Z5",
        "is_active": true,
        "is_ewaybill_enabled": true,
        "ewb_preference": {
            "ewb_types": [
                {
                    "ewb_type": "general",
                    "threshold": 50000,
                    "is_enabled": true
                }
            ]
        }
    }
}

Deactivate the GST portal credentials registered under the specified tax settings record. Available only in the India edition.
OAuth Scope : ZohoInventory.settings.CREATE

Path Parameters

tax_settings_id

string

(Required)

Unique identifier of the tax settings record.

Query Parameters

organization_id

string

(Required)

ID of the organization. Note: This value is a set of numeric characters.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills/deactivate?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills/deactivate?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills/deactivate?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v1/settings/460000000789012/ewaybills/deactivate?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v1/settings/460000000789012/ewaybills/deactivate?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v1/settings/460000000789012/ewaybills/deactivate?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The e-Way Bill integration has been deactivated successfully.",
    "ewaybill_settings": {
        "ewaybill_username": "gstapi_user",
        "tax_reg_no": "29ABCDE1234F1Z5",
        "is_active": true,
        "is_ewaybill_enabled": true,
        "ewb_preference": {
            "ewb_types": [
                {
                    "ewb_type": "general",
                    "threshold": 50000,
                    "is_enabled": true
                }
            ]
        }
    }
}

Attribute

Create an e-Way Bill

Arguments

Query Parameters

List e-Way Bills

Query Parameters

Update an e-Way Bill

Path Parameters

Query Parameters

Retrieve an e-Way Bill

Path Parameters

Query Parameters

Delete an e-Way Bill

Path Parameters

Query Parameters

Cancel an e-Way Bill

Arguments

Path Parameters

Query Parameters

Sync an e-Way Bill

Path Parameters

Query Parameters

Exclude e-Way Bills

Query Parameters

Restore e-Way Bills

Query Parameters

Add a vehicle to an e-Way Bill

Arguments

Path Parameters

Query Parameters

Update a vehicle in an e-Way Bill

Path Parameters

Query Parameters

Extend the validity of an e-Way Bill

Arguments

Path Parameters

Query Parameters

Initiate a multi-vehicle movement

Arguments

Path Parameters

Query Parameters

Add vehicles to a multi-vehicle movement

Arguments

Path Parameters

Query Parameters

Change a vehicle in a multi-vehicle movement

Arguments

Path Parameters

Query Parameters

Create a transporter

Arguments

Query Parameters

List transporters

Query Parameters

Update a transporter

Path Parameters

Query Parameters

Update the transporter of an e-Way Bill

Path Parameters

Query Parameters

Create a dispatch-from address

Arguments

Query Parameters

List dispatch-from addresses

Query Parameters

Delete a dispatch-from address

Path Parameters

Query Parameters

Update e-Way Bill settings

Arguments

Query Parameters

Get e-Way Bill settings

Query Parameters

Enable e-Way Bills

Query Parameters

Disable e-Way Bills

Query Parameters

Deactivate e-Way Bill credentials

Query Parameters