Zoho Inventory salesorders API
SalesOrders Module
Zoho Inventory salesorders 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 Sales Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 15 operations across 11 paths, and defines 155 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
15 operations
11 paths
155 schemas
2 DELETE2 GET10 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory salesorders API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 15
Across 11 paths, the API surfaces 15 operations — 2 DELETE, 2 GET, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
salesorders 15
SalesOrders Module
POST
/salesorders
Create a Sales Order
GET
/salesorders
List all Sales Orders
DELETE
/salesorders
Bulk delete Sales Orders
GET
/salesorders/{salesorder_id}
Retrieve a Sales Order
PUT
/salesorders/{salesorder_id}
Update a Sales Order
DELETE
/salesorders/{salesorder_id}
Delete a Sales Order
POST
/salesorders/{salesorder_id}/status/confirmed
Mark as Confirmed
POST
/salesorders/{salesorder_id}/status/void
Mark as Void
POST
/salesorders/status/confirmed
Bulk confirm Sales Orders
POST
/salesorders/{salesorder_id}/submit
Submit a sales order for approval
POST
/salesorders/{salesorder_id}/approve
Approve a sales order
POST
/salesorders/{salesorder_id}/approve/final
Final approval of a sales order
POST
/salesorders/{salesorder_id}/reject
Reject a sales order
POST
/salesorders/submit
Bulk submit sales orders for approval
POST
/salesorders/approve
Bulk approve sales orders
Schemas 155
The contract defines 155 schemas that model the data the API accepts and returns. The most detailed are sales_order-response (49 properties), create-a-sales-order-request (29 properties), update-a-sales-order-request (26 properties), billing_address (6 properties). Each schema is shown below with its type and property counts.
create-a-sales-order-response
object
3 properties
contact_person_name
string
Name of the Contact Person
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
shipment_date
string
Shipment date of the Sales Order.
create-a-sales-order-request
object
29 properties
3 required
last_name
string
Last Name of the Contact Person
list-all-sales-orders-response
object
3 properties
is_invoiced
boolean
Checks whether the Sales Order has been invoiced or not.
location_id
string
Location ID
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
shipment_status
string
Shipment status of the package.
can_send_in_mail
boolean
Checks whether the sales order can be sent as a mail or not.
contact_person_email
string
Email ID of the Contact Person.
is_backorder
boolean
Denotes if a SalesOrder is a backorder
shipping_address_id
string
Unique Id generated by the server for address in contacts page. To add a shipping address to sales order, send the addressid using this node. Else, the default…
location_name
string
Name of the location
adjustment_description
string
Description for the adjustment.
notes
string
Notes for the Sales Order.
delivery_method_id
string
Unique ID generated by the server for the delivery method. This is used as an identifier.
is_drop_shipment
boolean
Denotes if a SalesOrder is a drop shipment
documents
array
Sales order can have files attached to them. Each attachment has the following attributes cansendinmail , filename , filetype , filesizeformatted , attachmento…
delivery_days
string
The expected days to be taken for the delivery.
update-a-sales-order-response
object
3 properties
tax_name
string
Name of the tax applied on the line item.
salesorder_number
string
The Sales Order number. This is unique for each sales order.
is_combo_product
boolean
Indicates whether the line item is a composite product.
bcy_rate
number
Item rate in the organization's base currency.
is_emailed
boolean
Checks whether the Sales Order has been emailed to the customer or not.
address
string
Name of the street of the customer's shipping address.
salesperson_name
string
Name of the Sales Person.
service
string
Name of the service provided by the carrier.
image_type
string
The type (file format) of the image.
retrieve-a-sales-order-response
object
3 properties
invoices
array
Invoices created for the Sales Order. Each invoice contains - invoiceid , invoicenumber , status , date , duedate , total , balance .
quantity_packed
number
Quantity packed of the line item.
approval-action-response
object
2 properties
item_total
number
Total of line item.
delivery_guarantee
boolean
Delivery guarantee of the shipment can be true or false.
currency_id
string
Unique ID generated by the server for the currency. This is used as an identifier.
description
string
Description of the line item.
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
bulk-delete-sales-orders-response
object
2 properties
name
string
Name of the line item.
image_id
number
Unique ID generated by the server for the item image. This is used an identifier.
currency_code
string
Currency code.
tax_total
number
Tax total of the Sales Order.
mobile
string
Mobile Number of the Contact Person
mark-as-void-response
object
2 properties
mark-as-confirmed-response
object
2 properties
gst_no
string
15 digit GST identification number of the customer.
billing_address
object
Customer's billing address. It contains - address , city , state , zip , country and fax .
6 properties
quantity
number
Quantity of the line item.
carrier
string
Name of the shipping carrier.
is_pre_gst
boolean
Applicable for transactions that fall before july 1, 2017
bulk-confirm-salesorders-response
object
3 properties
image_name
string
Name of the image of the line item.
template_name
string
Name of the template used for the Sales Order.
rate
number
Rate / Selling Price of the line item.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
sat_item_key_code
string
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
template_id
string
Unique ID generated by the server for the Template. This is used as an identifier.
update-a-sales-order-request
object
26 properties
3 required
shipping_charge
number
Shipping charges that can be applied to the Sales Order.
discount_type
string
Type of discount. Allowed values are entitylevel , itemlevel . For entitylevel type, discount is applied at entity level and the node discount resides outside…
contact_persons_associated_payload
array
Contact Persons associated with the sales order.
tds_tax_id
string
ID of the TDS tax or TDS tax group applied
custom_fields
array
List of custom fields associated with the sales order
currency_symbol
string
The symbol for the selected currency.
has_unconfirmed_line_item
boolean
mapped_items
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
sales_channel
string
From which channel the saleorder was obtained
fax
string
Fax number of the customer's shipping address.
file_name
string
This indicates the name of the file.
estimate_id
string
Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.
state
string
Name of the state of the customer's shipping address.
terms
string
Terms for the Sales Order.
salesorder_id
string
Unique ID generated by the server for the Sales Order. This is used as identifier.
invoice_number
string
The number of the Invoice.
item_custom_fields
array
List of custom fields associated with the line item
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
shipment_number
string
Shipment number of the package.
exchange_rate
number
Exchange rate of the currency, with respect to the base currency.
quantity_invoiced
number
Quantity invoiced of the line item.
mapped_items_update
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
status
string
The current status of the Sales Order.
label
string
Label of the Custom Field
tax_percentage
number
Percentage of the tax.
total
number
Total amount of the Sales Order.
packages
array
These are the packages created for Sales Orders. Each package contains - packageid , packagenumber , status , detailedstatus , statusmessage , shipmentid , shi…
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
2 properties
discount_amount
number
Discount to be applied on the Sales Order.
quantity_shipped
number
Quantity shipped of the line item.
line_items
array
A sales order can contain multiple line items. Each line item contains itemid , name , description , rate , quantity , unit , taxid , taxname , taxtype , taxpe…
country
string
Name of the country of the customer's shipping address.
status_message
string
Status message of package.
date
string
The date for the Sales Order.
reference_number
string
Reference number of the Sales Order
billing_address_id
string
Unique Id generated by the server for address in contacts page. To add a billing address to sales order, send the addressid using this node. Else, the default…
last_modified_time
string
Time at which the sales order details were last modified.
city
string
Name of the city of the customer's shipping address.
reject-request
object
1 property
is_backorder_allowed
boolean
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
contact_person_id
string
Unique ID of the Contact Person
purchaseorders
array
file_size
integer
this indicates the size of the attached file.
taxes
array
Number of taxes applied on sales order. Each tax contains: taxname and taxamount .
created_time
string
Time at which the Sales Order was created.
package_id
string
Unique ID generated by the server for the package. This is used as an identifier.
tracking_number
string
Tracking number of shipment.
shipment_id
string
Unique ID generated by the server for the shipment. This is used as an identifier.
file_type
string
This indicates the type of the file.
first_name
string
First Name of the Contact Person
bcy_total
integer
Total in Base Currency of the Organisation
is_dropshipped
boolean
Denotes if a SalesOrder has been dropshipped
template_type
string
Type of the template.
item_order
integer
The order of the line items, starts from 0 by default.
contact_persons_associated
array
Contact Persons associated with the sales order.
delete-a-sales-order-response
object
2 properties
document_id
string
Unique ID generated by the server for the document. This is used as an identifier.
invoice_id
string
Unique ID generated by the server for the invoice. This is used as an identifier.
hsn_or_sac
string
Add HSN/SAC code for your goods/services
delivery_method
string
Delivery method of the shipment.
balance
number
Balance due for the invoice.
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive or exclusive of tax.
place_of_supply
string
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
item_id
string
Unique ID generated by the server for the item. This is used as an identifier.
pricebook_id
string
Unique ID generated by the server for the Pricebook. This is used as an identifier.
customer_id
string
Unique ID generated for the customer. This is used as an identifier.
customer_name
string
Name of the customer.
attachment_order
integer
This indicates the chronological number of the attachment.
price_precision
integer
The precision level for the price's decimal point in a Sales Order.
tax_id
string
Unique ID generated by the server for the tax. This is used as an identifier.
file_size_formatted
string
This indicates the size of the formatted file.
shipping_address
object
Customer's shipping address. It contains - address , city , state , zip , country and fax .
6 properties
phone
string
Phone Number of the Contact Person
shipment_days
integer
Days of Shipment for the Order
unitkey_code
string
Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs.
value
string
Value of the Custom Field
zip
string
Zip code of the customer's shipping address.
customfield_id
string
Unique ID of the custom field.
unit
string
Unit of line item.
salesperson_id
string
Unique ID generated by the server for the sales person. This is used as an identifier.
due_date
string
Due date for the Invoice.
attachment_name
string
Name of attached file with Sales Order.
adjustment
number
Adjustment on the Sales Order's total.
sales_order-response
object
49 properties
tax_amount
number
Amount of the tax.
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
package_number
string
Package number of the Sales Order.
is_backordered
boolean
Denotes if a SalesOrder has been backordered
sub_total
number
Sub total of the Sales Order.
mapped_items_create
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
discount
number
Discount applied to the sales order, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g.,…
detailed_status
string
Detailed status.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
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 delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
#Sales Orders
Where this information came from
This is an independent, third-party profile of Zoho Inventory salesorders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.