API Docs
/
No Results Found
Sales Orders

Sales Orders

A sales order is a financial document that confirms an impending sale. It details the exact quantity, price and delivery details of the products or services being sold. Perform the simple operations mentioned below to create and manage your Sales Orders.

Attribute

salesorder_id
long
Unique ID generated by the server for the Sales Order. This is used as identifier.
salesorder_number
string
The Sales Order number. This is unique for each sales order.
date
string
The date for the Sales Order.
status
string
The current status of the Sales Order.
shipment_date
string
Shipment date of the Sales Order.
reference_number
string
Reference number of the Sales Order
customer_id
long
Unique ID generated for the customer. This is used as an identifier.
customer_name
string
Name of the customer.
contact_persons
array
List of contact persons details.
Show Sub-Attributes arrow
contact_person_id
long
Unique ID generated by the server for the contact person
currency_id
long
Unique ID generated by the server for the currency. This is used as an identifier.
currency_code
string
Currency code.
currency_symbol
string
The symbol for the selected currency.
exchange_rate
double
Exchange rate of the currency, with respect to the base currency.
discount_amount
double
Discount to be applied on the Sales Order.
discount
double
The percentage of Discount applied.
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
discount_type
string
Type of discount. Allowed values are entity_level,item_level. For entity_level type, discount is applied at entity level and the node discount resides outside the line_items node.For item_level type, discount is applied at item level and the node discount resides inside each line_item under the line_items node
estimate_id
long
Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier.
delivery_method
string
Delivery method of the shipment.
delivery_method_id
long
Unique ID generated by the server for the delivery method. This is used as an identifier.
line_items
array
A sales order can contain multiple line items. Each line item contains item_id,name,description,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total.
Show Sub-Attributes arrow
item_id
long
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
name
string
Name of the line item.
description
string
Description of the line item.
item_order
integer
The order of the line items, starts from 0 by default.
bcy_rate
double
Item rate in the organization's base currency.
rate
double
Rate / Selling Price of the line item.
quantity
double
Quantity of the line item.
quantity_invoiced
double
Quantity invoiced of the line item.
quantity_packed
double
Quantity packed of the line item.
quantity_shipped
double
Quantity shipped of the line item.
unit
string
Unit of line item.
tax_id
long
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
string
Name of the tax applied on the line item.
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
double
Percentage of the tax.
item_total
double
Total of line item.
is_invoiced
boolean
Checks whether the Sales Order has been invoiced or not.
image_id
double
Unique ID generated by the server for the item image. This is used an identifier.
image_name
string
Name of the image of the line item.
image_type
string
The type (file format) of the image.
warehouse_id
long
Unique ID generated by the server for the ware houses
hsn_or_sac
string
🇮🇳 India
only
Add HSN/SAC code for your goods/services
shipping_charge
double
Shipping charges that can be applied to the Sales Order.
adjustment
double
Adjustment on the Sales Order's total.
adjustment_description
string
Description for the adjustment.
sub_total
double
Sub total of the Sales Order.
tax_total
double
Tax total of the Sales Order.
total
double
Total amount of the Sales Order.
taxes
array
Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount.
Show Sub-Attributes arrow
tax_name
string
Name of the tax applied on the line item.
tax_amount
double
Amount of the tax.
price_precision
integer
The precision level for the price's decimal point in a Sales Order.
pricebook_id
string
Unique ID generated by the server for the Pricebook. This is used as an identifier.
shipping_address
array
Customer's shipping address. It contains - address, city, state, zip, country and fax.
Show Sub-Attributes arrow
address
string
Name of the street of the customer’s shipping address.
city
string
Name of the city of the customer’s shipping address.
state
string
Name of the state of the customer's shipping address.
zip
string
Zip code of the customer’s shipping address.
country
string
Name of the country of the customer’s shipping address.
fax
string
Fax number of the customer’s shipping address.
billing_address
array
Customer's billing address. It contains - address, city, state, zip, country and fax.
Show Sub-Attributes arrow
address
string
Name of the street of the customer’s shipping address.
city
string
Name of the city of the customer’s shipping address.
state
string
Name of the state of the customer's shipping address.
zip
string
Zip code of the customer’s shipping address.
country
string
Name of the country of the customer’s shipping address.
fax
string
Fax number of the customer’s shipping address.
notes
string
Notes for the Sales Order.
terms
string
Terms for the Sales Order.
template_id
long
Unique ID generated by the server for the Template. This is used as an identifier.
template_name
string
Name of the template used for the Sales Order.
template_type
string
Type of the template.
created_time
string
Time at which the Sales Order was created.
last_modified_time
string
Time at which the sales order details were last modified.
salesperson_id
string
Unique ID generated by the server for the sales person. This is used as an identifier.
salesperson_name
string
Name of the Sales Person.
documents
array
Sales order can have files attached to them. Each attachment has the following attributes can_send_in_mail, file_name, file_type, file_size_formatted, attachment_order, document_id, file_size.
Show Sub-Attributes arrow
can_send_in_mail
boolean
Checks whether the sales order can be sent as a mail or not.
file_name
string
This indicates the name of the file.
file_type
string
This indicates the type of the file.
file_size_formatted
string
This indicates the size of the formatted file.
attachment_order
integer
This indicates the chronological number of the attachment.
document_id
long
Unique ID generated by the server for the document. This is used as an identifier.
file_size
long
this indicates the size of the attached file.
is_pre_gst
boolean
🇮🇳 India
only
Applicable for transactions that fall before july 1, 2017
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer.
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
place_of_supply
string
🇮🇳 India
only
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)

Example

{ "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "date": "2015-05-28", "status": "fulfilled", "shipment_date": "2015-06-02", "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "customer_name": "Molly", "contact_persons": [ { "contact_person_id": 4815000000044080 } ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity": 2, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg", "warehouse_id": 130426000000664020, "hsn_or_sac": 80540 } ], "shipping_charge": 7, "adjustment": 0, "adjustment_description": "Just an example description.", "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "shipping_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "billing_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T00:00:00.000Z", "last_modified_time": "2015-05-28T00:00:00.000Z", "salesperson_id": 4815000000044762, "salesperson_name": "Lara", "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ], "is_pre_gst": false, "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "place_of_supply": "TN" }

Create a Sales Order

Creates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation - Ignore auto sales order number generation for this sales order. This mandates the Sales Order number to be entered. Allowed Values true and false.
oauthscope : ZohoInventory.salesorders.CREATE

Arguments

customer_id
long
(Required)
Unique ID generated for the customer. This is used as an identifier.
salesorder_number
string
(Required)
The Sales Order number. This is unique for each sales order.
date
string
The date for the Sales Order.
shipment_date
string
Shipment date of the Sales Order.
custom_fields
array
Show Sub-Attributes arrow
custom_field_id
long
index
integer
Index of the custom field
label
string
Label of the Custom Field
value
string
Value of the Custom Field
reference_number
string
Reference number of the Sales Order
line_items
array
(Required)
A sales order can contain multiple line items. Each line item contains item_id,name,description,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total.
Show Sub-Attributes arrow
item_id
long
Unique ID generated by the server for the item. This is used as an identifier.
name
string
Name of the line item.
description
string
Description of the line item.
rate
double
Rate / Selling Price of the line item.
quantity
double
Quantity of the line item.
unit
string
Unit of line item.
tax_id
long
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
string
Name of the tax applied on the line item.
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
double
Percentage of the tax.
item_total
double
Total of line item.
warehouse_id
long
Unique ID generated by the server for the ware houses
hsn_or_sac
string
🇮🇳 India
only
Add HSN/SAC code for your goods/services
notes
string
Notes for the Sales Order.
terms
string
Terms for the Sales Order.
discount
double
The percentage of Discount applied.
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
discount_type
string
Type of discount. Allowed values are entity_level,item_level. For entity_level type, discount is applied at entity level and the node discount resides outside the line_items node.For item_level type, discount is applied at item level and the node discount resides inside each line_item under the line_items node
shipping_charge
double
Shipping charges that can be applied to the Sales Order.
delivery_method
string
Delivery method of the shipment.
adjustment
double
Adjustment on the Sales Order's total.
pricebook_id
string
Unique ID generated by the server for the Pricebook. This is used as an identifier.
salesperson_id
string
Unique ID generated by the server for the sales person. This is used as an identifier.
adjustment_description
string
Description for the adjustment.
is_inclusive_tax
boolean
Used to specify whether the line item rates are inclusive or exclusive of tax.
exchange_rate
double
Exchange rate of the currency, with respect to the base currency.
template_id
long
Unique ID generated by the server for the Template. This is used as an identifier.
documents
array
Sales order can have files attached to them. Each attachment has the following attributes can_send_in_mail, file_name, file_type, file_size_formatted, attachment_order, document_id, file_size.
Show Sub-Attributes arrow
can_send_in_mail
boolean
Checks whether the sales order can be sent as a mail or not.
file_name
string
This indicates the name of the file.
file_type
string
This indicates the type of the file.
file_size_formatted
string
This indicates the size of the formatted file.
attachment_order
integer
This indicates the chronological number of the attachment.
document_id
long
Unique ID generated by the server for the document. This is used as an identifier.
file_size
long
this indicates the size of the attached file.
billing_address_id
long
Unique Id generated by the server for address in contacts page. To add a billing address to sales order, send the address_id using this node. Else, the default billing address for that contact is used
shipping_address_id
long
Unique Id generated by the server for address in contacts page. To add a shipping address to sales order, send the address_id using this node. Else, the default shipping address for that contact is used
place_of_supply
string
🇮🇳 India
only
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer.

Query Parameters

ignore_auto_number_generation
Ignore auto sales order number generation for this sales order. This mandates the sales order number. Allowed values are true , false .
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://inventory.zoho.com/api/v1/salesorders?organization_id=10234695 -X POST -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "customer_id": 4815000000044080, "salesorder_number": "SO-00003", "date": "2015-05-28", "shipment_date": "2015-06-02", "custom_fields": [ { "custom_field_id": 0, "index": 0, "label": "string", "value": "string" } ], "reference_number": "REF-S-00003", "line_items": [ { "item_id": 4815000000044100, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "rate": 122, "quantity": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "warehouse_id": 130426000000664020, "hsn_or_sac": 80540 } ], "notes": "Sample Note", "terms": "Terms and Conditions", "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "shipping_charge": 7, "delivery_method": "FedEx", "adjustment": 0, "pricebook_id": 4815000000044054, "salesperson_id": 4815000000044762, "adjustment_description": "Just an example description.", "is_inclusive_tax": false, "exchange_rate": 1, "template_id": 4815000000017003, "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ], "billing_address_id": 4815000000017005, "shipping_address_id": 4815000000017005, "place_of_supply": "TN", "gst_treatment": "business_gst", "gst_no": "22AAAAA0000A1Z5" }

Response Example

{ "code": 0, "message": "success", "sales_order": { "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "date": "2015-05-28", "status": "fulfilled", "shipment_date": "2015-06-02", "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "customer_name": "Molly", "contact_persons": [ { "contact_person_id": 4815000000044080 } ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity": 2, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg", "warehouse_id": 130426000000664020, "hsn_or_sac": 80540 } ], "shipping_charge": 7, "adjustment": 0, "adjustment_description": "Just an example description.", "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "shipping_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "billing_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T00:00:00.000Z", "last_modified_time": "2015-05-28T00:00:00.000Z", "salesperson_id": 4815000000044762, "salesperson_name": "Lara", "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ], "is_pre_gst": false, "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "place_of_supply": "TN" } }

List all Sales Orders

Lists all the available Sales Orders in Zoho Inventory.
oauthscope : ZohoInventory.salesorders.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://inventory.zoho.com/api/v1/salesorders?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "salesorders": [ { "salesorder_id": 4815000000044895, "customer_name": "Molly", "customer_id": 4815000000044080, "status": "fulfilled", "salesorder_number": "SO-00003", "reference_number": "REF-S-00003", "date": "2015-05-28", "shipment_date": "2015-06-02", "shipment_days": 2, "quantity": 2, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "currency_code": "USD", "total": 350, "bcy_total": 33, "created_time": "2015-05-28T00:00:00.000Z", "last_modified_time": "2015-05-28T00:00:00.000Z", "is_emailed": true, "is_drop_shipment": false, "is_backorder": false, "sales_channel": "direct_sales", "custom_fields": [ { "custom_field_id": 0, "index": 0, "label": "string", "value": "string" } ] }, {...}, {...} ] }

Update a Sales Order

Updates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation - Ignore auto sales order number generation for this sales order. This mandates the Sales Order number to be entered. Allowed Values true and false.
oauthscope : ZohoInventory.salesorders.UPDATE

Arguments

salesorder_number
string
(Required)
The Sales Order number. This is unique for each sales order.
date
string
The date for the Sales Order.
shipment_date
string
Shipment date of the Sales Order.
custom_fields
array
Show Sub-Attributes arrow
custom_field_id
long
index
integer
Index of the custom field
label
string
Label of the Custom Field
value
string
Value of the Custom Field
reference_number
string
Reference number of the Sales Order
customer_id
long
(Required)
Unique ID generated for the customer. This is used as an identifier.
contact_persons
array
List of contact persons details.
Show Sub-Attributes arrow
contact_person_id
long
Unique ID generated by the server for the contact person
discount
double
The percentage of Discount applied.
is_discount_before_tax
boolean
Used to check whether the discount is applied before tax or after tax.
discount_type
string
Type of discount. Allowed values are entity_level,item_level. For entity_level type, discount is applied at entity level and the node discount resides outside the line_items node.For item_level type, discount is applied at item level and the node discount resides inside each line_item under the line_items node
delivery_method
string
Delivery method of the shipment.
shipping_charge
double
Shipping charges that can be applied to the Sales Order.
adjustment
double
Adjustment on the Sales Order's total.
adjustment_description
string
Description for the adjustment.
pricebook_id
string
Unique ID generated by the server for the Pricebook. This is used as an identifier.
notes
string
Notes for the Sales Order.
salesperson_name
string
Name of the Sales Person.
terms
string
Terms for the Sales Order.
exchange_rate
double
Exchange rate of the currency, with respect to the base currency.
line_items
array
(Required)
A sales order can contain multiple line items. Each line item contains item_id,name,description,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total.
Show Sub-Attributes arrow
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
item_id
long
Unique ID generated by the server for the item. This is used as an identifier.
name
string
Name of the line item.
description
string
Description of the line item.
rate
double
Rate / Selling Price of the line item.
quantity
double
Quantity of the line item.
unit
string
Unit of line item.
tax_id
long
Unique ID generated by the server for the tax. This is used as an identifier.
tax_name
string
Name of the tax applied on the line item.
tax_type
string
Denotes the type of the tax. This can either be a single tax or a tax group.
tax_percentage
double
Percentage of the tax.
item_total
double
Total of line item.
warehouse_id
long
Unique ID generated by the server for the ware houses
hsn_or_sac
string
🇮🇳 India
only
Add HSN/SAC code for your goods/services
billing_address_id
long
Unique Id generated by the server for address in contacts page. To add a billing address to sales order, send the address_id using this node. Else, the default billing address for that contact is used
shipping_address_id
long
Unique Id generated by the server for address in contacts page. To add a shipping address to sales order, send the address_id using this node. Else, the default shipping address for that contact is used
place_of_supply
string
🇮🇳 India
only
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
gst_treatment
string
🇮🇳 India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
gst_no
string
🇮🇳 India
only
15 digit GST identification number of the customer.

Query Parameters

ignore_auto_number_generation
Ignore auto sales order number generation for this sales order. This mandates the sales order number. Allowed values are true , false .
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}?organization_id=10234695 -X PUT -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "salesorder_number": "SO-00003", "date": "2015-05-28", "shipment_date": "2015-06-02", "custom_fields": [ { "custom_field_id": 0, "index": 0, "label": "string", "value": "string" } ], "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "contact_persons": [ { "contact_person_id": 4815000000044080 } ], "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "delivery_method": "FedEx", "shipping_charge": 7, "adjustment": 0, "adjustment_description": "Just an example description.", "pricebook_id": 4815000000044054, "notes": "Sample Note", "salesperson_name": "Lara", "terms": "Terms and Conditions", "exchange_rate": 1, "line_items": [ { "line_item_id": 4815000000044897, "item_id": 4815000000044100, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "rate": 122, "quantity": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "warehouse_id": 130426000000664020, "hsn_or_sac": 80540 } ], "billing_address_id": 4815000000017005, "shipping_address_id": 4815000000017005, "place_of_supply": "TN", "gst_treatment": "business_gst", "gst_no": "22AAAAA0000A1Z5" }

Response Example

{ "code": 0, "message": "Sales Order has been updated.", "sales_order": { "salesorder_id": 4815000000044895, "salesorder_number": "SO-00003", "date": "2015-05-28", "status": "fulfilled", "shipment_date": "2015-06-02", "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "customer_name": "Molly", "contact_persons": [ { "contact_person_id": 4815000000044080 } ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity": 2, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg", "warehouse_id": 130426000000664020, "hsn_or_sac": 80540 } ], "shipping_charge": 7, "adjustment": 0, "adjustment_description": "Just an example description.", "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "pricebook_id": 4815000000044054, "packages": [ { "package_id": 4815000000044905, "package_number": "PK-00004", "status": "fulfilled", "detailed_status": "Delivered", "status_message": "Delivered", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "shipment_status": 3, "carrier": "FedEx", "service": "SMART_POST", "tracking_number": "TRK214124124", "shipment_date": "2015-06-02", "delivery_days": 12, "delivery_guarantee": true } ], "invoices": [ { "invoice_id": 4815000000045091, "invoice_number": "INV-001", "status": "fulfilled", "date": "2015-05-28", "due_date": "2015-06-13", "total": 350, "balance": 0 } ], "shipping_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "billing_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T00:00:00.000Z", "last_modified_time": "2015-05-28T00:00:00.000Z", "attachment_name": "sample.pdf", "can_send_in_mail": true, "salesperson_id": 4815000000044762, "salesperson_name": "Lara", "is_pre_gst": false, "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "place_of_supply": "TN" } }

Retrieve a Sales Order

Retrieves the details for an existing Sales Order.
oauthscope : ZohoInventory.salesorders.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "sales_order": { "salesorder_id": 4815000000044895, "documents": [ { "can_send_in_mail": true, "file_name": "sample.pdf", "file_type": "pdf", "file_size_formatted": "116.8 KB", "attachment_order": 1, "document_id": 16115000000096068, "file_size": 11957 } ], "salesorder_number": "SO-00003", "date": "2015-05-28", "status": "fulfilled", "shipment_date": "2015-06-02", "reference_number": "REF-S-00003", "customer_id": 4815000000044080, "customer_name": "Molly", "contact_persons": [ { "contact_person_id": 4815000000044080 } ], "currency_id": 4815000000000097, "currency_code": "USD", "currency_symbol": "$", "exchange_rate": 1, "discount_amount": 0, "discount": "20.00%", "is_discount_before_tax": true, "discount_type": "entity_level", "estimate_id": 4815000000045091, "delivery_method": "FedEx", "delivery_method_id": 4815000000044822, "is_inclusive_tax": false, "sales_channel": "direct_sales", "is_dropshipped": false, "is_backordered": false, "is_backorder_allowed": false, "line_items": [ { "item_id": 4815000000044100, "line_item_id": 4815000000044897, "name": "Laptop-white/15inch/dell", "description": "Just a sample description.", "item_order": 0, "bcy_rate": 122, "rate": 122, "quantity": 2, "quantity_invoiced": 2, "quantity_packed": 2, "quantity_shipped": 2, "unit": "qty", "tax_id": 4815000000044043, "tax_name": "Sales Tax", "tax_type": "tax", "tax_percentage": 12, "item_total": 244, "is_invoiced": true, "image_id": 2077500000000002000, "image_name": "dell.jpg", "image_type": "jpg", "warehouse_id": 130426000000664020, "hsn_or_sac": 80540 } ], "shipping_charge": 7, "adjustment": 0, "pricebook_id": 4815000000044054, "adjustment_description": "Just an example description.", "sub_total": 244, "tax_total": 29, "total": 350, "taxes": [ { "tax_name": "Sales Tax", "tax_amount": 29.28 } ], "price_precision": 2, "is_emailed": true, "has_unconfirmed_line_item": true, "packages": [ { "package_id": 4815000000044905, "package_number": "PK-00004", "status": "fulfilled", "detailed_status": "Delivered", "status_message": "Delivered", "shipment_id": 4815000000044917, "shipment_number": "SH-00004", "shipment_status": 3, "carrier": "FedEx", "service": "SMART_POST", "tracking_number": "TRK214124124", "shipment_date": "2015-06-02", "delivery_days": 12, "delivery_guarantee": true } ], "invoices": [ { "invoice_id": 4815000000045091, "invoice_number": "INV-001", "status": "fulfilled", "date": "2015-05-28", "due_date": "2015-06-13", "total": 350, "balance": 0 } ], "purchaseorders": [ "string" ], "billing_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "shipping_address": [ { "address": "No:432,Bayside,Queens", "city": "New York City", "state": "New York", "zip": 11364, "country": "U.S.A", "fax": "424-524242" } ], "notes": "Sample Note", "terms": "Terms and Conditions", "custom_fields": [ { "custom_field_id": 0, "index": 0, "label": "string", "value": "string" } ], "template_id": 4815000000017003, "template_name": "Standard", "template_type": "standard", "created_time": "2015-05-28T00:00:00.000Z", "last_modified_time": "2015-05-28T00:00:00.000Z", "attachment_name": "sample.pdf", "can_send_in_mail": true, "salesperson_id": 4815000000044762, "salesperson_name": "Lara", "is_pre_gst": false, "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "place_of_supply": "TN" } }

Delete a Sales Order

Deletes an existing Sales Order from Zoho Inventory.
oauthscope : ZohoInventory.salesorders.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}?organization_id=10234695 -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The Sales Order has been deleted." }

Mark as Confirmed

Changes the status of a Sales Order to Confirmed.
oauthscope : ZohoInventory.salesorders.CREATE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}/status/confirmed?organization_id=10234695 -X POST -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Sales order status has been changed to 'Confirmed'." }

Mark as Void

Changes the status of a Sales Order to Void.
oauthscope : ZohoInventory.salesorders.CREATE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}/status/void?organization_id=10234695 -X POST -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The status of the Sales Order has been changed to void." }