Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Inventory delivery-challans API

Delivery Challans Module

Zoho Inventory delivery-challans API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include delivery-challans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 17 operations across 13 paths, and defines 28 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.

17 operations 13 paths 28 schemas 2 DELETE4 GET6 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://www.zohoapis.com/inventory/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Inventory delivery-challans API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 17

Across 13 paths, the API surfaces 17 operations — 2 DELETE, 4 GET, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

delivery-challans 17

Delivery Challans Module

GET
/deliverychallans
List delivery challans
list_delivery_challans 9 params → 200
POST
/deliverychallans
Create a delivery challan
create_delivery_challan 2 params body → 201
GET
/deliverychallans/{deliverychallan_id}
Retrieve a delivery challan
get_delivery_challan 3 params → 200
PUT
/deliverychallans/{deliverychallan_id}
Update a delivery challan
update_delivery_challan 2 params body → 200
DELETE
/deliverychallans/{deliverychallan_id}
Delete a delivery challan
delete_delivery_challan 2 params → 200
POST
/deliverychallans/{deliverychallan_id}/status/open
Mark a delivery challan as open
mark_delivery_challan_as_open 2 params → 200
POST
/deliverychallans/{deliverychallan_id}/status/delivered
Mark a delivery challan as delivered
mark_delivery_challan_as_delivered 2 params → 200
POST
/deliverychallans/{deliverychallan_id}/status/returned
Mark a delivery challan as returned
mark_delivery_challan_as_returned 2 params → 200
POST
/deliverychallans/{deliverychallan_id}/status/undelivered
Mark a delivery challan as undelivered
mark_delivery_challan_as_undelivered 2 params → 200
PUT
/deliverychallans/return
Return delivery challans
return_delivery_challans 2 params body → 200
PUT
/deliverychallans/undo/return
Undo return of delivery challans
undo_return_delivery_challans 2 params → 200
POST
/deliverychallans/{deliverychallan_id}/attachment
Add attachment to a delivery challan
add_attachment_to_delivery_challan 2 params body → 200
GET
/deliverychallans/{deliverychallan_id}/documents/{document_id}
Get a delivery challan attachment
get_delivery_challan_attachment 3 params → 200
DELETE
/deliverychallans/{deliverychallan_id}/documents/{document_id}
Delete a delivery challan attachment
delete_delivery_challan_attachment 3 params → 200
GET
/deliverychallans/templates
List delivery challan templates
list_delivery_challan_templates 1 param → 200
PUT
/deliverychallans/{deliverychallan_id}/templates/{template_id}
Update a delivery challan template
update_delivery_challan_template 3 params → 200
PUT
/deliverychallans/{deliverychallan_id}/address/shipping
Update shipping address
update_delivery_challan_shipping_address 2 params body → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are delivery-challan-response (40 properties), create-delivery-challan-request (29 properties), update-delivery-challan-request (28 properties), line-item-response (28 properties). Each schema is shown below with its type and property counts.

item_custom_fields
array
List of custom fields associated with the line item
update-shipping-address-request
object
9 properties
return-delivery-challan-request
object
1 property
get-delivery-challan-response
object
3 properties
update-delivery-challan-response
object
3 properties
page_context
object
The context of a particular page.
7 properties
label
string
Label of the Custom Field
line-item-request-update
object
19 properties
line-item-response
object
28 properties
delivery-challan-response
object
40 properties
action-delivery-challan-response
object
2 properties
list-delivery-challans-response
object
4 properties
mapped_items_create
array
Mapped items of a composite item for creation.
combo_type
string
Type of the composite item. Allowed value is assembly and kit .
create-delivery-challan-request
object
29 properties 1 required
delete-delivery-challan-response
object
2 properties
line-item-tax
object
3 properties
update-delivery-challan-request
object
28 properties 1 required
address-detail
object
9 properties
is_combo_product
boolean
Whether the line item is a composite product.
custom_fields
array
Custom fields associated with the delivery challan.
customfield_id
string
Unique ID of the custom field.
value
string
Value of the Custom Field
create-delivery-challan-response
object
3 properties
mapped_items
array
Mapped items of a composite item.
line-item-request
object
17 properties
mapped_items_update
array
Mapped items of a composite item for update.
list-templates-response
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-delivery-challans-api-openapi.yml Raw ↑

Other APIs Zoho Inventory publishes across the network.

Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
Zoho Inventory items API