API Docs
/
No Results Found
Resources
Delivery Challans

Delivery Challans

A delivery challan is a document used to record the dispatch of goods to a customer without generating an invoice. It is typically used for goods sent on approval, job work, or for other non-sale purposes.

Supported Edition:

  • GLOBAL
  • INDIA

Download Delivery Challans OpenAPI Document
Download
Download Zoho Books OpenAPI Document
End Points
Create a delivery challan
List delivery challans
Update a delivery challan
Retrieve a delivery challan
Delete a delivery challan
Mark a delivery challan as open
Mark a delivery challan as delivered
Mark a delivery challan as returned
Mark a delivery challan as undelivered
Return delivery challans
Undo return of delivery challans
Add attachment to a delivery challan
Get a delivery challan attachment
Delete a delivery challan attachment
List delivery challan templates
Update a delivery challan template
Update shipping address

Attribute

deliverychallan_id
string
Unique identifier of the delivery challan.
deliverychallan_number
string
Delivery challan number.
date
string
Date of the delivery challan in YYYY-MM-DD format.
challan_type
string
Type of delivery challan.
reference_number
string
Reference number.
status
string
Status of the delivery challan.
customer_id
string
Unique identifier of the customer.
customer_name
string
Name of the customer.
currency_id
string
Unique identifier of the currency.
currency_code
string
Currency code.
currency_symbol
string
Currency symbol.
exchange_rate
number
Exchange rate for the currency.
is_discount_before_tax
boolean
Whether discount is applied before tax.
discount_type
string
Type of discount.
is_inclusive_tax
boolean
Whether prices are inclusive of tax.
discount
number
Discount applied.
place_of_supply
string
Place of supply (applicable for India edition).
gst_no
string
GST number (applicable for India edition).
gst_treatment
string
GST treatment (applicable for India edition).
tax_treatment
string
Tax treatment.
line_items
array
Show Sub-Attributes arrow
line_item_id
string
Unique identifier of the line item.
item_id
string
Unique identifier of the item.
name
string
Name of the item.
sku
string
SKU of the item.
description
string
Description of the line item.
item_order
integer
Display order of the line item.
rate
number
Rate of the item.
bcy_rate
number
Rate in base currency.
quantity
number
Quantity.
unit
string
Unit of measurement.
discount
number
Discount applied.
tax_id
string
Unique identifier of the tax.
tax_name
string
Name of the tax.
tax_type
string
Type of the tax.
tax_percentage
number
Tax percentage.
item_total
number
Total for this line item.
hsn_or_sac
string
HSN or SAC code (applicable for India edition).
tax_exemption_id
string
Unique identifier of the tax exemption.
tax_exemption_code
string
Tax exemption code.
warehouse_id
string
Unique identifier of the warehouse.
warehouse_name
string
Name of the warehouse.
quantity_invoiced
number
Quantity invoiced for this line item.
quantity_returned
number
Quantity returned for this line item.
line_item_taxes
array
Show Sub-Attributes arrow
tax_id
string
Unique identifier of the tax.
tax_name
string
Name of the tax.
tax_amount
number
Tax amount.
sub_total
number
Sub total of the delivery challan.
tax_total
number
Total tax amount.
total
number
Total amount of the delivery challan.
adjustment
number
Adjustment amount.
adjustment_description
string
Description for the adjustment.
shipping_address
object
Show Sub-Attributes arrow
address
string
Address line.
street2
string
Second address line.
city
string
City.
state
string
State.
zip
string
Postal or ZIP code.
country
string
Country.
fax
string
Fax number.
phone
string
Phone number.
attention
string
Attention.
notes
string
Customer notes for the delivery challan.
terms
string
Terms and conditions.
template_id
string
Unique identifier of the template.
template_name
string
Name of the template.
custom_fields
string
Custom fields associated with the delivery challan.
has_qty_returned
boolean
Indicates whether any quantity has been returned.
branch_id
string
Unique identifier of the branch.
branch_name
string
Name of the branch.
location_id
string
Unique identifier of the location.
location_name
string
Name of the location.
created_time
string
Time at which the delivery challan was created.
last_modified_time
string
Time at which the delivery challan was last modified.
created_by_id
string
Unique identifier of the user who created the delivery challan.

Example

{ "deliverychallan_id": "982000000567001", "deliverychallan_number": "DC-00001", "date": "2024-06-15", "challan_type": "job_work", "reference_number": "REF-DC-001", "status": "open", "customer_id": "982000000567001", "customer_name": "Bowman and Co", "currency_id": "982000000000190", "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "is_discount_before_tax": true, "discount_type": "entity_level", "is_inclusive_tax": false, "discount": 0, "place_of_supply": "string", "gst_no": "string", "gst_treatment": "string", "tax_treatment": "string", "line_items": [ { "line_item_id": "982000000567002", "item_id": "982000000030049", "name": "Hard Drive", "sku": "HD-1TB-001", "description": "1TB External Hard Drive", "item_order": 1, "rate": 2500, "bcy_rate": 2500, "quantity": 2, "unit": "Nos", "discount": 0, "tax_id": "982000000030010", "tax_name": "GST", "tax_type": "string", "tax_percentage": 9, "item_total": 5000, "hsn_or_sac": "string", "tax_exemption_id": "string", "tax_exemption_code": "string", "warehouse_id": "string", "warehouse_name": "string", "quantity_invoiced": 0, "quantity_returned": 0, "line_item_taxes": [ { "tax_id": "982000000030010", "tax_name": "GST", "tax_amount": 225 } ] } ], "sub_total": 5000, "tax_total": 450, "total": 5450, "adjustment": 0, "adjustment_description": "string", "shipping_address": { "address": "123 Main Street", "street2": "string", "city": "Chennai", "state": "Tamil Nadu", "zip": "600001", "country": "India", "fax": "string", "phone": "+91-44-12345678", "attention": "string" }, "notes": "Deliver to the reception desk", "terms": "string", "template_id": "982000000567030", "template_name": "Standard Template", "custom_fields": "string", "has_qty_returned": true, "branch_id": "982000000567040", "branch_name": "string", "location_id": "982000000567040", "location_name": "string", "created_time": "2024-06-15T10:30:00+0530", "last_modified_time": "2024-06-15T10:30:00+0530", "created_by_id": "982000000024001" }

Create a delivery challan

Create a new delivery challan for a customer. The customer ID is required.
OAuth Scope : ZohoBooks.deliverychallans.CREATE

Arguments

customer_id
string
(Required)
Unique identifier of the customer.
currency_id
string
Unique identifier of the currency.
deliverychallan_number
string
Delivery challan number. Max-length [50]
reference_number
string
Reference number. Max-length [50]
template_id
string
Unique identifier of the template.
date
string
Date of the delivery challan in YYYY-MM-DD format.
challan_type
string
Type of delivery challan. Max-length [200]
discount
string
Discount applied at the entity level.
is_discount_before_tax
boolean
Whether discount is applied before tax.
discount_type
string
Type of discount.
place_of_supply
string
Place of supply state code (applicable for India edition). Max-length [5]
exchange_rate
number
Exchange rate for the currency.
is_inclusive_tax
boolean
Whether prices are inclusive of tax.
gst_treatment
string
GST treatment (applicable for India edition).
tax_treatment
string
Tax treatment.
gst_no
string
GST number (applicable for India edition). Max-length [15]
line_items
array
Line items of the delivery challan.
Show Sub-Attributes arrow
item_id
string
Unique identifier of the item.
line_item_id
string
Unique identifier of the line item (for updates).
name
string
Name of the item. Max-length [200]
sku
string
SKU of the item. Max-length [200]
description
string
Description of the line item. Max-length [6000]
item_order
integer
Display order of the item.
rate
number
Rate of the item.
quantity
number
Quantity.
unit
string
Unit of measurement. Max-length [120]
discount
string
Discount for this line item.
tax_id
string
Unique identifier of the tax.
tax_exemption_id
string
Unique identifier of the tax exemption.
tax_exemption_code
string
Tax exemption code. Max-length [50]
hsn_or_sac
string
HSN or SAC code (applicable for India edition).
pricebook_id
string
Unique identifier of the price book.
warehouse_id
string
Unique identifier of the warehouse.
location_id
string
Unique identifier of the location.
notes
string
Customer notes. Max-length [5000]
terms
string
Terms and conditions. Max-length [10000]
adjustment
number
Adjustment amount.
adjustment_description
string
Adjustment description. Max-length [200]
tax_id
string
Unique identifier of the tax.
tax_authority_id
string
Unique identifier of the tax authority.
tax_exemption_id
string
Unique identifier of the tax exemption.
shipping_address_id
string
Unique identifier of the shipping address.
pricebook_id
string
Unique identifier of the price book.
branch_id
string
Unique identifier of the branch.
location_id
string
Unique identifier of the location.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
ignore_auto_number_generation
boolean
Ignore auto number generation for this delivery challan. Allowed values true and false.

Request Example

Click to copy
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/books/v3/deliverychallans?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/books/v3/deliverychallans?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/books/v3/deliverychallans?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", "/books/v3/deliverychallans?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": "/books/v3/deliverychallans?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/books/v3/deliverychallans?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "customer_id": "982000000567001", "currency_id": "982000000000190", "deliverychallan_number": "DC-00001", "reference_number": "REF-DC-001", "template_id": "982000000567030", "date": "2024-06-15", "challan_type": "job_work", "discount": "string", "is_discount_before_tax": true, "discount_type": "string", "place_of_supply": "strin", "exchange_rate": 1, "is_inclusive_tax": false, "gst_treatment": "string", "tax_treatment": "string", "gst_no": "string", "line_items": [ { "item_id": "982000000030049", "line_item_id": "string", "name": "Hard Drive", "sku": "string", "description": "1TB External Hard Drive", "item_order": 1, "rate": 2500, "quantity": 2, "unit": "Nos", "discount": "string", "tax_id": "982000000030010", "tax_exemption_id": "string", "tax_exemption_code": "string", "hsn_or_sac": "string", "pricebook_id": "string", "warehouse_id": "string", "location_id": "string" } ], "notes": "Deliver to the reception desk", "terms": "string", "adjustment": 0, "adjustment_description": "string", "tax_id": "string", "tax_authority_id": "string", "tax_exemption_id": "string", "shipping_address_id": "string", "pricebook_id": "string", "branch_id": "string", "location_id": "string" }

Response Example

{ "code": 0, "message": "The delivery challan has been created", "deliverychallan": { "deliverychallan_id": "982000000567001", "deliverychallan_number": "DC-00001", "date": "2024-06-15", "challan_type": "job_work", "reference_number": "REF-DC-001", "status": "open", "customer_id": "982000000567001", "customer_name": "Bowman and Co", "currency_id": "982000000000190", "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "is_discount_before_tax": true, "discount_type": "entity_level", "is_inclusive_tax": false, "discount": 0, "place_of_supply": "string", "gst_no": "string", "gst_treatment": "string", "tax_treatment": "string", "line_items": [ { "line_item_id": "982000000567002", "item_id": "982000000030049", "name": "Hard Drive", "sku": "HD-1TB-001", "description": "1TB External Hard Drive", "item_order": 1, "rate": 2500, "bcy_rate": 2500, "quantity": 2, "unit": "Nos", "discount": 0, "tax_id": "982000000030010", "tax_name": "GST", "tax_type": "string", "tax_percentage": 9, "item_total": 5000, "hsn_or_sac": "string", "tax_exemption_id": "string", "tax_exemption_code": "string", "warehouse_id": "string", "warehouse_name": "string", "quantity_invoiced": 0, "quantity_returned": 0, "line_item_taxes": [ { "tax_id": "982000000030010", "tax_name": "GST", "tax_amount": 225 } ] } ], "sub_total": 5000, "tax_total": 450, "total": 5450, "adjustment": 0, "adjustment_description": "string", "shipping_address": { "address": "123 Main Street", "street2": "string", "city": "Chennai", "state": "Tamil Nadu", "zip": "600001", "country": "India", "fax": "string", "phone": "+91-44-12345678", "attention": "string" }, "notes": "Deliver to the reception desk", "terms": "string", "template_id": "982000000567030", "template_name": "Standard Template", "custom_fields": "string", "has_qty_returned": true, "branch_id": "982000000567040", "branch_name": "string", "location_id": "982000000567040", "location_name": "string", "created_time": "2024-06-15T10:30:00+0530", "last_modified_time": "2024-06-15T10:30:00+0530", "created_by_id": "982000000024001" } }

List delivery challans

Retrieve a list of delivery challans with pagination. Filter by status, customer, date, and more.
OAuth Scope : ZohoBooks.deliverychallans.READ

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
sort_column
string
Specify the column to sort Delivery challans by. Allowed values customer_name, deliverychallan_number, total, date, created_time, last_modified_time.
sort_order
string
Sort order (A for Ascending, D for Descending). Allowed values A (ascending), D (descending).
filter_by
string
Filter delivery challans by status. Allowed values Status.All, Status.Draft, Status.Open, Status.Returned, Status.Delivered, Status.Invoiced, Status.PartiallyInvoiced.
search_text
string
Search delivery challans by challan number or customer name.
customer_id
string
Filter by ID of the Customer for whom the delivery challan is created.
status
string
Search Delivery challans by delivery challan status. Allowed values draft, open, void, fulfilled, invoiced, partially_invoiced.
page
integer
Page number to be fetched.
per_page
integer
Number of records to be fetched per page.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans?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/books/v3/deliverychallans?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/books/v3/deliverychallans?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", "/books/v3/deliverychallans?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": "/books/v3/deliverychallans?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/books/v3/deliverychallans?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "deliverychallans": [ { "deliverychallan_id": "982000000567001", "customer_name": "Bowman and Co", "customer_id": "982000000567001", "status": "open", "deliverychallan_number": "DC-00001", "reference_number": "string", "date": "2024-06-15", "currency_id": "982000000000190", "currency_code": "USD", "total": 5450, "bcy_total": 5450, "created_time": "2024-06-15T10:30:00+0530", "last_modified_time": "2024-06-15T10:30:00+0530", "has_attachment": false }, {...}, {...} ], "page_context": { "page": 1, "per_page": 10, "has_more_page": false, "report_name": "Delivery Challans", "applied_filter": "Status.All", "sort_column": "created_time", "sort_order": "D" } }

Update a delivery challan

Update an existing delivery challan.
OAuth Scope : ZohoBooks.deliverychallans.UPDATE

Arguments

customer_id
string
(Required)
Unique identifier of the customer.
currency_id
string
Unique identifier of the currency.
deliverychallan_number
string
Delivery challan number. Max-length [50]
reference_number
string
Reference number. Max-length [50]
template_id
string
Unique identifier of the template.
date
string
Date of the delivery challan in YYYY-MM-DD format.
challan_type
string
Type of delivery challan. Max-length [200]
discount
string
Discount applied at the entity level.
is_discount_before_tax
boolean
Whether discount is applied before tax.
discount_type
string
Type of discount.
place_of_supply
string
Place of supply state code (applicable for India edition). Max-length [5]
exchange_rate
number
Exchange rate for the currency.
is_inclusive_tax
boolean
Whether prices are inclusive of tax.
gst_treatment
string
GST treatment (applicable for India edition).
tax_treatment
string
Tax treatment.
gst_no
string
GST number (applicable for India edition). Max-length [15]
line_items
array
Line items of the delivery challan.
Show Sub-Attributes arrow
item_id
string
Unique identifier of the item.
line_item_id
string
Unique identifier of the line item (for updates).
name
string
Name of the item. Max-length [200]
sku
string
SKU of the item. Max-length [200]
description
string
Description of the line item. Max-length [6000]
item_order
integer
Display order of the item.
rate
number
Rate of the item.
quantity
number
Quantity.
unit
string
Unit of measurement. Max-length [120]
discount
string
Discount for this line item.
tax_id
string
Unique identifier of the tax.
tax_exemption_id
string
Unique identifier of the tax exemption.
tax_exemption_code
string
Tax exemption code. Max-length [50]
hsn_or_sac
string
HSN or SAC code (applicable for India edition).
pricebook_id
string
Unique identifier of the price book.
warehouse_id
string
Unique identifier of the warehouse.
location_id
string
Unique identifier of the location.
notes
string
Customer notes. Max-length [5000]
terms
string
Terms and conditions. Max-length [10000]
adjustment
number
Adjustment amount.
adjustment_description
string
Adjustment description. Max-length [200]
tax_id
string
Unique identifier of the tax.
tax_authority_id
string
Unique identifier of the tax authority.
tax_exemption_id
string
Unique identifier of the tax exemption.
shipping_address_id
string
Unique identifier of the shipping address.
pricebook_id
string
Unique identifier of the price book.
branch_id
string
Unique identifier of the branch.
location_id
string
Unique identifier of the location.

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
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/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?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", "/books/v3/deliverychallans/982000000567001?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": "/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "customer_id": "982000000567001", "currency_id": "982000000000190", "deliverychallan_number": "DC-00001", "reference_number": "REF-DC-001", "template_id": "982000000567030", "date": "2024-06-15", "challan_type": "job_work", "discount": "string", "is_discount_before_tax": true, "discount_type": "string", "place_of_supply": "strin", "exchange_rate": 1, "is_inclusive_tax": false, "gst_treatment": "string", "tax_treatment": "string", "gst_no": "string", "line_items": [ { "item_id": "982000000030049", "line_item_id": "string", "name": "Hard Drive", "sku": "string", "description": "1TB External Hard Drive", "item_order": 1, "rate": 2500, "quantity": 2, "unit": "Nos", "discount": "string", "tax_id": "982000000030010", "tax_exemption_id": "string", "tax_exemption_code": "string", "hsn_or_sac": "string", "pricebook_id": "string", "warehouse_id": "string", "location_id": "string" } ], "notes": "Deliver to the reception desk", "terms": "string", "adjustment": 0, "adjustment_description": "string", "tax_id": "string", "tax_authority_id": "string", "tax_exemption_id": "string", "shipping_address_id": "string", "pricebook_id": "string", "branch_id": "string", "location_id": "string" }

Response Example

{ "code": 0, "message": "The delivery challan has been updated", "deliverychallan": { "deliverychallan_id": "982000000567001", "deliverychallan_number": "DC-00001", "date": "2024-06-15", "challan_type": "job_work", "reference_number": "REF-DC-001", "status": "open", "customer_id": "982000000567001", "customer_name": "Bowman and Co", "currency_id": "982000000000190", "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "is_discount_before_tax": true, "discount_type": "entity_level", "is_inclusive_tax": false, "discount": 0, "place_of_supply": "string", "gst_no": "string", "gst_treatment": "string", "tax_treatment": "string", "line_items": [ { "line_item_id": "982000000567002", "item_id": "982000000030049", "name": "Hard Drive", "sku": "HD-1TB-001", "description": "1TB External Hard Drive", "item_order": 1, "rate": 2500, "bcy_rate": 2500, "quantity": 2, "unit": "Nos", "discount": 0, "tax_id": "982000000030010", "tax_name": "GST", "tax_type": "string", "tax_percentage": 9, "item_total": 5000, "hsn_or_sac": "string", "tax_exemption_id": "string", "tax_exemption_code": "string", "warehouse_id": "string", "warehouse_name": "string", "quantity_invoiced": 0, "quantity_returned": 0, "line_item_taxes": [ { "tax_id": "982000000030010", "tax_name": "GST", "tax_amount": 225 } ] } ], "sub_total": 5000, "tax_total": 450, "total": 5450, "adjustment": 0, "adjustment_description": "string", "shipping_address": { "address": "123 Main Street", "street2": "string", "city": "Chennai", "state": "Tamil Nadu", "zip": "600001", "country": "India", "fax": "string", "phone": "+91-44-12345678", "attention": "string" }, "notes": "Deliver to the reception desk", "terms": "string", "template_id": "982000000567030", "template_name": "Standard Template", "custom_fields": "string", "has_qty_returned": true, "branch_id": "982000000567040", "branch_name": "string", "location_id": "982000000567040", "location_name": "string", "created_time": "2024-06-15T10:30:00+0530", "last_modified_time": "2024-06-15T10:30:00+0530", "created_by_id": "982000000024001" } }

Retrieve a delivery challan

Retrieve the details of an existing delivery challan.
OAuth Scope : ZohoBooks.deliverychallans.READ

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
print
boolean
Print the delivery challan in PDF format. Allowed values true and false.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?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", "/books/v3/deliverychallans/982000000567001?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": "/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "deliverychallan": { "deliverychallan_id": "982000000567001", "deliverychallan_number": "DC-00001", "date": "2024-06-15", "challan_type": "job_work", "reference_number": "REF-DC-001", "status": "open", "customer_id": "982000000567001", "customer_name": "Bowman and Co", "currency_id": "982000000000190", "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "is_discount_before_tax": true, "discount_type": "entity_level", "is_inclusive_tax": false, "discount": 0, "place_of_supply": "string", "gst_no": "string", "gst_treatment": "string", "tax_treatment": "string", "line_items": [ { "line_item_id": "982000000567002", "item_id": "982000000030049", "name": "Hard Drive", "sku": "HD-1TB-001", "description": "1TB External Hard Drive", "item_order": 1, "rate": 2500, "bcy_rate": 2500, "quantity": 2, "unit": "Nos", "discount": 0, "tax_id": "982000000030010", "tax_name": "GST", "tax_type": "string", "tax_percentage": 9, "item_total": 5000, "hsn_or_sac": "string", "tax_exemption_id": "string", "tax_exemption_code": "string", "warehouse_id": "string", "warehouse_name": "string", "quantity_invoiced": 0, "quantity_returned": 0, "line_item_taxes": [ { "tax_id": "982000000030010", "tax_name": "GST", "tax_amount": 225 } ] } ], "sub_total": 5000, "tax_total": 450, "total": 5450, "adjustment": 0, "adjustment_description": "string", "shipping_address": { "address": "123 Main Street", "street2": "string", "city": "Chennai", "state": "Tamil Nadu", "zip": "600001", "country": "India", "fax": "string", "phone": "+91-44-12345678", "attention": "string" }, "notes": "Deliver to the reception desk", "terms": "string", "template_id": "982000000567030", "template_name": "Standard Template", "custom_fields": "string", "has_qty_returned": true, "branch_id": "982000000567040", "branch_name": "string", "location_id": "982000000567040", "location_name": "string", "created_time": "2024-06-15T10:30:00+0530", "last_modified_time": "2024-06-15T10:30:00+0530", "created_by_id": "982000000024001" } }

Delete a delivery challan

Delete an existing delivery challan.
OAuth Scope : ZohoBooks.deliverychallans.DELETE

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?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", "/books/v3/deliverychallans/982000000567001?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": "/books/v3/deliverychallans/982000000567001?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/books/v3/deliverychallans/982000000567001?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "The delivery challan has been deleted" }

Mark a delivery challan as open

Change the status of a delivery challan to open.
OAuth Scope : ZohoBooks.deliverychallans.CREATE

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/status/open?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/books/v3/deliverychallans/982000000567001/status/open?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/books/v3/deliverychallans/982000000567001/status/open?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", "/books/v3/deliverychallans/982000000567001/status/open?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": "/books/v3/deliverychallans/982000000567001/status/open?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/books/v3/deliverychallans/982000000567001/status/open?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success" }

Mark a delivery challan as delivered

Change the status of a delivery challan to delivered.
OAuth Scope : ZohoBooks.deliverychallans.CREATE

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/status/delivered?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/books/v3/deliverychallans/982000000567001/status/delivered?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/books/v3/deliverychallans/982000000567001/status/delivered?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", "/books/v3/deliverychallans/982000000567001/status/delivered?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": "/books/v3/deliverychallans/982000000567001/status/delivered?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/books/v3/deliverychallans/982000000567001/status/delivered?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success" }

Mark a delivery challan as returned

Change the status of a delivery challan to returned.
OAuth Scope : ZohoBooks.deliverychallans.CREATE

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/status/returned?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/books/v3/deliverychallans/982000000567001/status/returned?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/books/v3/deliverychallans/982000000567001/status/returned?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", "/books/v3/deliverychallans/982000000567001/status/returned?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": "/books/v3/deliverychallans/982000000567001/status/returned?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/books/v3/deliverychallans/982000000567001/status/returned?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success" }

Mark a delivery challan as undelivered

Change the status of a delivery challan to undelivered.
OAuth Scope : ZohoBooks.deliverychallans.CREATE

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/status/undelivered?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/books/v3/deliverychallans/982000000567001/status/undelivered?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/books/v3/deliverychallans/982000000567001/status/undelivered?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", "/books/v3/deliverychallans/982000000567001/status/undelivered?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": "/books/v3/deliverychallans/982000000567001/status/undelivered?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/books/v3/deliverychallans/982000000567001/status/undelivered?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success" }

Return delivery challans

Partially return one or more delivery challans by specifying the line items and quantities to return.
OAuth Scope : ZohoBooks.deliverychallans.UPDATE

Arguments

line_items
array
Line items with return quantities.
Show Sub-Attributes arrow
line_item_id
string
Unique identifier of the line item.
qty_returned
number
Quantity to return.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
deliverychallan_ids
string
(Required)
Comma-separated IDs of delivery challans to mark as returned.

Request Example

Click to copy
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/books/v3/deliverychallans/return?organization_id=10234695&deliverychallan_ids=982000000567001" 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/books/v3/deliverychallans/return?organization_id=10234695&deliverychallan_ids=982000000567001") .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/books/v3/deliverychallans/return?organization_id=10234695&deliverychallan_ids=982000000567001', 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", "/books/v3/deliverychallans/return?organization_id=10234695&deliverychallan_ids=982000000567001", 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": "/books/v3/deliverychallans/return?organization_id=10234695&deliverychallan_ids=982000000567001", "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/books/v3/deliverychallans/return?organization_id=10234695&deliverychallan_ids=982000000567001' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "line_items": [ { "line_item_id": "982000000567002", "qty_returned": 1 } ] }

Response Example

{ "code": 0, "message": "success" }

Undo return of delivery challans

Undo a previously applied return for one or more delivery challans.
OAuth Scope : ZohoBooks.deliverychallans.UPDATE

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
deliverychallan_ids
string
(Required)
Comma-separated IDs of delivery challans to undo return.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/undo/return?organization_id=10234695&deliverychallan_ids=982000000567001" type: PUT headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v3/deliverychallans/undo/return?organization_id=10234695&deliverychallan_ids=982000000567001") .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/books/v3/deliverychallans/undo/return?organization_id=10234695&deliverychallan_ids=982000000567001', 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", "/books/v3/deliverychallans/undo/return?organization_id=10234695&deliverychallan_ids=982000000567001", 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": "/books/v3/deliverychallans/undo/return?organization_id=10234695&deliverychallan_ids=982000000567001", "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/books/v3/deliverychallans/undo/return?organization_id=10234695&deliverychallan_ids=982000000567001' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success" }

Add attachment to a delivery challan

Attach files to an existing delivery challan (maximum of 20 files).'
OAuth Scope : ZohoBooks.deliverychallans.CREATE

Arguments

attachment
binary
File to attach. Max size 10 MB.

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
parameters_data = Map(); parameters_data.put("field1", "value1") parameters_data.put("field2", "value2") headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/attachment?organization_id=10234695" type: POST headers: headers_data parameters: parameters_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001"); RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n"); Request request = new Request.Builder() .url("https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/attachment?organization_id=10234695") .post(body) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001") .build(); Response response = client.newCall(request).execute();
const form = new FormData(); form.append("field1", "value1"); form.append("field2", "value2"); const options = { method: 'POST', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'multipart/form-data; boundary=---011000010111000001101001' } }; options.body = form; fetch('https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/attachment?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 = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n" headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "multipart/form-data; boundary=---011000010111000001101001" } conn.request("POST", "/books/v3/deliverychallans/982000000567001/attachment?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": "/books/v3/deliverychallans/982000000567001/attachment?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "multipart/form-data; boundary=---011000010111000001101001" } }; 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("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field1\"\r\n\r\nvalue1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field2\"\r\n\r\nvalue2\r\n-----011000010111000001101001--\r\n"); req.end();
curl --request POST \ --url 'https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/attachment?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: multipart/form-data' \ --form field1=value1 \ --form field2=value2

Body Parameters

Click to copy
{ "attachment": "string" }

Response Example

{ "code": 0, "message": "success" }

Get a delivery challan attachment

Retrieve an attachment.
OAuth Scope : ZohoBooks.deliverychallans.READ

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.
document_id
string
(Required)
Unique identifier of the document.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/documents/982000000567020?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/books/v3/deliverychallans/982000000567001/documents/982000000567020?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/books/v3/deliverychallans/982000000567001/documents/982000000567020?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", "/books/v3/deliverychallans/982000000567001/documents/982000000567020?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": "/books/v3/deliverychallans/982000000567001/documents/982000000567020?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/books/v3/deliverychallans/982000000567001/documents/982000000567020?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

Delete a delivery challan attachment

Delete an attachment.
OAuth Scope : ZohoBooks.deliverychallans.UPDATE

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.
document_id
string
(Required)
Unique identifier of the document.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/documents/982000000567020?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/books/v3/deliverychallans/982000000567001/documents/982000000567020?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/books/v3/deliverychallans/982000000567001/documents/982000000567020?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", "/books/v3/deliverychallans/982000000567001/documents/982000000567020?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": "/books/v3/deliverychallans/982000000567001/documents/982000000567020?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/books/v3/deliverychallans/982000000567001/documents/982000000567020?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success" }

List delivery challan templates

Retrieve a list of available templates for delivery challans.
OAuth Scope : ZohoBooks.deliverychallans.READ

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/templates?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/books/v3/deliverychallans/templates?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/books/v3/deliverychallans/templates?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", "/books/v3/deliverychallans/templates?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": "/books/v3/deliverychallans/templates?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/books/v3/deliverychallans/templates?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "templates": [ { "template_id": "982000000567030", "template_name": "Standard Template", "template_type": "standard" }, {...}, {...} ] }

Update a delivery challan template

Assign a different template to an existing delivery challan.
OAuth Scope : ZohoBooks.deliverychallans.UPDATE

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.
template_id
string
(Required)
Unique identifier of the template.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/books/v3/deliverychallans/982000000567001/templates/982000000567030?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/books/v3/deliverychallans/982000000567001/templates/982000000567030?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/books/v3/deliverychallans/982000000567001/templates/982000000567030?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", "/books/v3/deliverychallans/982000000567001/templates/982000000567030?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": "/books/v3/deliverychallans/982000000567001/templates/982000000567030?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/books/v3/deliverychallans/982000000567001/templates/982000000567030?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success" }

Update shipping address

Update the shipping address of an existing delivery challan.
OAuth Scope : ZohoBooks.deliverychallans.UPDATE

Arguments

address
string
Address line.
street2
string
Second address line.
city
string
City.
state
string
State.
zip
string
Postal or ZIP code.
country
string
Country.
fax
string
Fax number.
phone
string
Phone number.
attention
string
Attention.

Path Parameters

deliverychallan_id
string
(Required)
Unique identifier of the delivery challan. Note: This value is a set of numeric characters.

Query Parameters

organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.

Request Example

Click to copy
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/books/v3/deliverychallans/982000000567001/address/shipping?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/books/v3/deliverychallans/982000000567001/address/shipping?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/books/v3/deliverychallans/982000000567001/address/shipping?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", "/books/v3/deliverychallans/982000000567001/address/shipping?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": "/books/v3/deliverychallans/982000000567001/address/shipping?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/books/v3/deliverychallans/982000000567001/address/shipping?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "address": "123 Main Street", "street2": "string", "city": "Chennai", "state": "Tamil Nadu", "zip": "600001", "country": "India", "fax": "string", "phone": "+91-44-12345678", "attention": "string" }

Response Example

{ "code": 0, "message": "success" }