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 salesorders. 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.0.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), shipping_address (6 properties). Each schema is shown below with its type and property counts.
carrier
string
Name of the shipping carrier.
item_custom_fields
array
List of custom fields associated with the line item
is_invoiced
boolean
Checks whether the Sales Order has been invoiced or not.
quantity_shipped
number
Quantity shipped of the line item.
terms
string
Terms for the Sales Order.
contact_persons_associated
array
Contact Persons associated with the sales order.
packages
array
These are the packages created for Sales Orders. Each package contains - packageid , packagenumber , status , detailedstatus , statusmessage , shipmentid , shi…
taxes
array
Number of taxes applied on sales order. Each tax contains: taxname and taxamount .
bcy_total
integer
Total in Base Currency of the Organisation
bulk-confirm-salesorders-response
object
3 properties
purchaseorders
array
zip
string
Zip code of the customer's shipping address.
item_id
string
Unique ID generated by the server for the item. This is used as an identifier.
sub_total
number
Sub total of the Sales Order.
approval-action-response
object
2 properties
package_number
string
Package number of the Sales Order.
sat_item_key_code
string
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
is_backorder
boolean
Denotes if a SalesOrder is a backorder
documents
array
Sales order can have files attached to them. Each attachment has the following attributes cansendinmail , filename , filetype , filesizeformatted , attachmento…
date
string
The date for the Sales Order.
item_total
number
Total of line item.
custom_fields
array
List of custom fields associated with the sales order
shipment_id
string
Unique ID generated by the server for the shipment. This is used as an identifier.
shipment_days
integer
Days of Shipment for the Order
value
string
Value of the Custom Field
currency_symbol
string
The symbol for the selected currency.
is_drop_shipment
boolean
Denotes if a SalesOrder is a drop shipment
unitkey_code
string
Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs.
contact_person_email
string
Email ID of the Contact Person.
document_id
string
Unique ID generated by the server for the document. This is used as an identifier.
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.
shipment_number
string
Shipment number of the package.
tracking_number
string
Tracking number of shipment.
country
string
Name of the country of the customer's shipping address.
quantity_packed
number
Quantity packed of the line item.
mark-as-void-response
object
2 properties
status
string
The current status of the Sales Order.
detailed_status
string
Detailed status.
label
string
Label of the Custom Field
phone
string
Phone Number of the Contact Person
hsn_or_sac
string
Add HSN/SAC code for your goods/services
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…
adjustment_description
string
Description for the adjustment.
quantity
number
Quantity of the line item.
package_id
string
Unique ID generated by the server for the package. This is used as an identifier.
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.,…
billing_address
object
Customer's billing address. It contains - address , city , state , zip , country and fax .
6 properties
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.
delivery_method_id
string
Unique ID generated by the server for the delivery method. This is used as an identifier.
name
string
Name of the line item.
tax_percentage
number
Percentage of the tax.
can_send_in_mail
boolean
Checks whether the sales order can be sent as a mail or not.
customer_name
string
Name of the customer.
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
invoice_id
string
Unique ID generated by the server for the invoice. This is used as an identifier.
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
2 properties
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…
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
mark-as-confirmed-response
object
2 properties
currency_id
string
Unique ID generated by the server for the currency. This is used as an identifier.
tax_total
number
Tax total of the Sales Order.
reference_number
string
Reference number of the Sales Order
sales_channel
string
From which channel the saleorder was obtained
location_id
string
Location ID
service
string
Name of the service provided by the carrier.
shipping_charge
number
Shipping charges that can be applied to the Sales Order.
is_pre_gst
boolean
Applicable for transactions that fall before july 1, 2017
quantity_invoiced
number
Quantity invoiced of the line item.
description
string
Description of the line item.
mobile
string
Mobile Number of the Contact Person
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…
discount_amount
number
Discount to be applied on the Sales Order.
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…
update-a-sales-order-response
object
3 properties
delivery_guarantee
boolean
Delivery guarantee of the shipment can be true or false.
notes
string
Notes for the Sales Order.
currency_code
string
Currency code.
attachment_name
string
Name of attached file with Sales Order.
list-all-sales-orders-response
object
3 properties
last_modified_time
string
Time at which the sales order details were last modified.
create-a-sales-order-response
object
3 properties
is_backorder_allowed
boolean
reject-request
object
1 property
address
string
Name of the street of the customer's shipping address.
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive or exclusive of tax.
salesperson_id
string
Unique ID generated by the server for the sales person. This is used as an identifier.
invoice_number
string
The number of the Invoice.
shipping_address
object
Customer's shipping address. It contains - address , city , state , zip , country and fax .
6 properties
file_size
integer
this indicates the size of the attached file.
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)
customer_id
string
Unique ID generated for the customer. This is used as an identifier.
file_size_formatted
string
This indicates the size of the formatted file.
due_date
string
Due date for the Invoice.
contact_person_name
string
Name of the Contact Person
update-a-sales-order-request
object
26 properties
3 required
image_id
number
Unique ID generated by the server for the item image. This is used an identifier.
is_backordered
boolean
Denotes if a SalesOrder has been backordered
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
invoices
array
Invoices created for the Sales Order. Each invoice contains - invoiceid , invoicenumber , status , date , duedate , total , balance .
shipment_status
string
Shipment status of the package.
exchange_rate
number
Exchange rate of the currency, with respect to the base currency.
fax
string
Fax number of the customer's shipping address.
last_name
string
Last Name of the Contact Person
unit
string
Unit of line item.
delivery_method
string
Delivery method of the shipment.
salesperson_name
string
Name of the Sales Person.
image_type
string
The type (file format) of the image.
created_time
string
Time at which the Sales Order was created.
item_order
integer
The order of the line items, starts from 0 by default.
template_name
string
Name of the template used for the Sales Order.
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
adjustment
number
Adjustment on the Sales Order's total.
file_type
string
This indicates the type of the file.
salesorder_number
string
The Sales Order number. This is unique for each sales order.
create-a-sales-order-request
object
29 properties
3 required
rate
number
Rate / Selling Price of the line item.
estimate_id
string
Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.
attachment_order
integer
This indicates the chronological number of the attachment.
delete-a-sales-order-response
object
2 properties
has_unconfirmed_line_item
boolean
first_name
string
First Name of the Contact Person
file_name
string
This indicates the name of the file.
tax_id
string
Unique ID generated by the server for the tax. This is used as an identifier.
contact_persons_associated_payload
array
Contact Persons associated with the sales order.
is_dropshipped
boolean
Denotes if a SalesOrder has been dropshipped
location_name
string
Name of the location
template_id
string
Unique ID generated by the server for the Template. This is used as an identifier.
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
template_type
string
Type of the template.
balance
number
Balance due for the invoice.
pricebook_id
string
Unique ID generated by the server for the Pricebook. This is used as an identifier.
city
string
Name of the city of the customer's shipping address.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
price_precision
integer
The precision level for the price's decimal point in a Sales Order.
is_combo_product
boolean
Indicates whether the line item is a composite product.
shipment_date
string
Shipment date of the Sales Order.
status_message
string
Status message of package.
retrieve-a-sales-order-response
object
3 properties
customfield_id
string
Unique ID of the custom field.
total
number
Total amount of the Sales Order.
is_emailed
boolean
Checks whether the Sales Order has been emailed to the customer or not.
tds_tax_id
string
ID of the TDS tax or TDS tax group applied
bcy_rate
number
Item rate in the organization's base currency.
salesorder_id
string
Unique ID generated by the server for the Sales Order. This is used as identifier.
image_name
string
Name of the image of the line item.
bulk-delete-sales-orders-response
object
2 properties
tax_amount
number
Amount of the tax.
sales_order-response
object
49 properties
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.
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
state
string
Name of the state of the customer's shipping address.
gst_no
string
15 digit GST identification number of the customer.
contact_person_id
string
Unique ID of the Contact Person
tax_name
string
Name of the tax applied on the line item.
delivery_days
string
The expected days to be taken for the delivery.
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
#salesorders