Kaizen #53 - Sales Orders #API
Hello everyone!
Welcome back to another week of Kaizen.
In this post, we will discuss inserting, updating, and deleting a Sales Order via an API.
What is a Sales Order?
A Sales Order is a document sent to your customers to confirm the items and prices of a sale. It is usually created after a quote is accepted by your customers, and your items are ready to be shipped or delivered to them.
Getting a Sales Order
Use the Get Records API to get the record(s) from the Sales Order module.
Request URL: {api-domain}/crm/v2/Sales_Orders (or)
{api-domain}/crm/v2/Sales_Orders/ {record_id}
Request Method: GET
Sample Response
Creating a Sales Order
Request URL: {api-domain}/crm/v2/Sales_Orders
Request Method: POST
Sample Input
{ "data": [ { "Account_Name": { "id": "3652397000000624046" }, "Subject": "SO Kaizen 53", "Product_Details": [ { "product": { "id": "3652397000000416001" }, "quantity": 10, "Discount": 20, "Unit Price": 1000, "line_tax": [ { "percentage": 10, "name": "Sales Tax" }, { "percentage": 1, "name": "VAT" } ] } ] } ] } |
Request JSON
Key | Description |
Account_Name Mandatory, JSON object | The record ID of the account you want to associate the sales order with. Use the Get Records API to fetch the Account_Name. |
Subject Mandatory, string | The subject line of your sales order. |
Product_Details Mandatory, JSON array | An array of details of the product you want to generate the sales order for. For more details on the keys inside this array, refer to our post on Handling product line items in the inventory modules. |
Owner Optional, JSON object | The record ID of the owner you want to assign this sales order record to. Use the Get Users API to fetch the owner's details. |
Deal_Name Optional, JSON object | The record ID of the deal you want to associate with this sales order. Use the Get Records API to fetch the Deal_Name. |
Quote_Name Optional, JSON object | The record ID of the quote that is associated with the sales order. |
Contact_Name Optional, JSON object | The record ID of the contact you want to associate with the sales order. Use the Get Records API to fetch the Contact_Name. |
Discount Optional, integer | The discount you want to offer on the sales order. |
Description Optional, string | A description of the sales order. |
Customer_No Optional, string | The customer number that you are generating the sales order for. This is for your own internal reference. |
Tax Optional, integer | The tax you want to apply for the sales order (this is different from the tax inside the product details section, which pertains to the taxes levied on that product). |
Carrier Optional, string | The name of the carrier that will ship the sales order. You can get the possible values through the Fields Metadata API. |
Sales_Commission Optional, integer | The commission that is applicable for the sale. |
Due_Date Optional, string | The date in the yyyy-mm-dd format on which the sales order is due. |
Adjustment Optional, integer | The adjustment in the sale, if any, that is added to the grand total of that product. |
Terms_and_Conditions Optional, string | The terms and conditions of the sales order, if any. |
Excise_Duty Optional, integer | The excise duty levied on the sale of the product, if any. |
$line_tax Optional, JSON array | The tax that you want to apply to the Sub Total of the line items while generating the sales order. For more details, refer to Handling product line items in the inventory modules. |
Status Optional, string | The status of the sales order. You can get the possible values through the Fields Metadata API. |
Apart from the above keys, you can also specify the keys about the billing and shipping details. Go to Setup > Developer Space > APIs > API Names > Sales Orders to know the API names of these fields. You can also use the Fields Metadata API.
Sample Response
Note
- You can insert a maximum of 100 sales orders in an API call.
- You can associate up to 200 products with a sales order. Add a JSON object for each product in the Product_Details section.
Updating a Sales Order
Use the Update Records API to update the record(s) in the Sales Order module.
Request URL: {api-domain}/crm/v2/Sales_Orders/record_id (or)
{api-domain}/crm/v2/Sales_Orders (with record IDs in the input body)
Request Method: PUT
Sample Input
In this example, we have updated the product associated with the sales order.
Sample Response
Note
- You can update a maximum of 100 sales orders in an API call.
- When you update multiple sales orders in a single call, pass the record ID of each sales order in the JSON object under the root key "data". Example:{"data": [{"id":"3652397000002791035",},{"id":"3652397000002791004",}]}
Deleting a Sales Order
Use the Delete Records API to delete the record(s) in the Sales Order module.
Request URL: {api-domain}/crm/v2/Sales_Orders/{record_id} (or)
{api-domain}/crm/v2/Sales_Orders?ids=record_id1,record_id2
Request Method: DELETE
Sample Response
Note
You can delete a maximum of 100 sales orders in a single API call.
We hope you found this post useful. Let us know your questions and feedback in the comments section, or write to us at support@zohocrm.com.
Cheers!
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Shylaja S
MR Sales PLC
Sunderjan Siddharth
Atishay Jain
Andres
Sticky Posts
Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes areKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over theKaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
[Webinar] Live demos and user Q&A with Zoho Writer product experts
Join us on June 12, 2025 for live demos based on your use cases and real-world scenarios raised via form. This is also an opportunity to get your questions answered directly by product experts from the Zoho Writer team. Webinar agenda Live demos basedZoho Writer's built-in citation and bibliography generator
Hey researchers and writers! Do you manually format citations and bibliographies, spending hours jumping between apps and tabs? If so, then check out Zoho Writer's built-in "Citations and Bibliography" feature. Imagine you're writing a thesis on the futureSingle and group checkboxes in Zoho Writer's fillable forms
Hey Writer Fam, Are you making the most out of single and group checkboxes in fillable forms in Zoho Writer? Here is a handy tip to optimize your use of checkboxes, both single and group, and enhance your data collection process. Single checkboxes: SingleCollaborate efficiently with Zoho Writer's track changes feature
Hi Zoho Writer Community, Zoho Writer's track changes feature is a simple, built-in solution that helps you and your team work together efficiently. Instead of juggling multiple versions of a document or building up a long email chain of comments, eachZoho Writer's WordPress extensions
Hey Zoho Writer users! Say goodbye to all your WordPress content publishing woes with Zoho Writer's WordPress extensions. Publish content with all your formatting and images, republish content when you update a document, and more—from a single windowTime-saving table hacks
Hey Zoho Writer Community, Do you find yourself using a lot of tables in your documents? We're here to share some of our time-saving hacks that will help you work more efficiently, organize your data, and make your documents look neat and professional.Automating document approval and signing with Zoho Writer and Zoho Sign
Hey Zoho Writer Community! Here's another automation tip to make your processes more efficient! Question: Can I send a document for client approval first, then automatically send it for signing with Zoho Sign if they approve? Since it's the same personCustomization hacks in Zoho Writer - Part 2
Hey community, We're back with some more tricks to personalize your documents, save time, and get in the zone when you work in Writer. Check out part 1 of this post if you haven't already. Let's dive right in! Document ruler units Imagine you're creatingSimplify your tax calculations with Zoho Writer
Hello Zoho Writer Community! Tax season can be stressful, but with Zoho Writer, managing your income tax calculations becomes straightforward and efficient. Here’s an example of how you can use the tables and formulae of Zoho Writer to calculate incomeEnhance document navigation with headings and TOC
Hey Zoho Writer Community! We're back with some useful features in Zoho Writer that can simplify your document creation and navigation process. Let's dive right in! Check out our video on how to make the most of Zoho Writer's heading and table of contentsUse and download in PDF format of Zoho wirter Merge template using deluge
Hello Zoho Developers. Here is some information about Zoho Writer. Writer is not just another online word processor, it's a powerful tool for editing, collaboration, and publishing. Even with its wide range of features, Writer's pared-down user interfaceCustomization hacks in Zoho Writer - Part 3
Hello everyone, Welcome back to Part 3 of our customization tips in Zoho Writer! In this third installment, we'll be diving into some essential customization settings that can enhance your document creation experience. Sender email address in mail mergeDaytime saving timezones messing up writer pdf
Hi, I need help for something I can't figure out. I created a Form to collect data and it is set up with my current Daylight Saving Time (GMT-3). This form is used to generate a contract (pdf Writer) with dates from an event that is being held in 4 monthsIssue with locked content in Writer
Hi, I have seen the documentation which outlines how to lock specific content within a Writer document so that it can't be modified by collaborators, but I have come across an issue. When the editor locks a paragraph for example, then a collaborator can'tDeprecation of certain URL patterns for published Zoho Writer documents
Hi Zoho Writer users! We'd like to let you know that we have deprecated certain URL patterns for published and embedded documents in Zoho Writer due to security reasons. If the published or embedded documents are in any of these URL patterns, then theirUsing Mail Merge Template to Print Documents with One Subform Record's Fields per Document
Hello, We have a Mail Merge template created in Zoho Writer which is not able to perform the functionality which is currently required to automate the documentation task portion of our process. The CRM module we are primarily using is based on a "Loans"Problem with Writer and Workdrive
Hi team, I’m the super admin for our Zoho One org. WorkDrive is active, and Zoho Docs is deprecated for our org. However, Zoho Writer cannot connect to WorkDrive at all — we’ve cleared cache, tried incognito, and restarted several times. I was able toSet to Review for all
We are testing the use of Writer as part of an internal review process for statement of work documents and have found that when the document is changed from Compose to Review by one person, that is not reflected for all others who view the document. IsI’ve noticed that Zoho Sheet currently doesn’t have a feature similar to the QUERY formula in Google Sheets or Power Query in Microsoft Excel.
These tools are extremely helpful for: Filtering and extracting data using simple SQL-like queries Combining or transforming data from multiple sheets or tables Creating dynamic reports without using complex formulas Having a Query-like function in Zohostock
bom/bse : stock details or price =STOCK(C14;"price") not showing issue is #N/A! kindly resolve this problemSOME FEATURES ARE NOT IN THE ZOHO SHEET IN COMPARISION TO ZOHO SHEET
TO ZOHO sir/maam with due to respect i want to say that i am using ZOHO tool which is spreadsheet i want to say that some features are not there in zoho sheet as comparison to MS EXCEL like advance filter and other Features which should be there in ZOHOZoho sheet for desktop
Hi is zoho sheets available for desktop version for windowsTip #18: 6 Trendlines and when to use them in your spreadsheet data?
Charts are a great tool for visualizing and interpreting large chunks of data in spreadsheets. Zoho Sheet offers you 35+ chart options, along with AI-powered chart recommendations based on the data set you select. There are various chart elements thatPerform customized calculations with the new LAMBDA functions!
We released the LAMBDA function in Zoho Sheet in 2021, enabling customized calculations inside predefined functions. Now, we're extending LAMBDA's capabilities with six new functions. Each of these functions applies LAMBDA to the given input, performsTip #17: Easily share spreadsheets with non-Zoho account users
With efficient, collaboration-friendly options, Zoho Sheet is a popular choice among users. Sheet's external share links help you collaborate more effectively by sharing your spreadsheets with anyone outside your organization, including users who do notWork seamlessly with Sheet's shortcuts without affecting the browser
Navigating your worksheets and performing specific actions should be a quick and easy process. That's where keyboard shortcuts come in. Shortcut keys help you accomplish tasks more efficiently, eliminating the need to move away from the keyboard. WhatZoho Sheet for iPad: Improved UI, external keyboard support, and more!
The portability and capabilities of the iPad have made it an essential device in the business world. With this in mind, we had launched an exclusive Zoho Sheet app for iPad, with device-specific improvements and enhanced usability. Now, we're improvingThe new Zoho Sheet for Android: Seamless UI and advanced features
At Zoho Sheet, we know mobile apps have become the go-to platforms for creating, sharing, and storing information. And we understand the importance of an efficient and seamless app experience. We've been working hard on improving the overall user experienceZia in Zoho Sheet now makes suggestions on conditional formats, picklists, and checkboxes
Zia, Zoho's popular AI assistant, has been helping users succeed across Zoho applications since inception. In Zoho Sheet, Zia helps users efficiently build reports and analyze data with recommendations about data cleaning, charts, and pivot table. Also,VBA attached to button no longer works on external shared sheet
Hi - we have a Sheet that our clients use, which requires them to press a button once they've entered data. The button then triggers a flow via a webhook. The button works fine when editing within Zoho Sheet - however when shared externally it no longercan I use zoho sheet for survey?
Hi I wanna use zoho sheet for my ARY to know consumer better so i wanna have permission to do soHow to Avoid Impacting Other Users When Hiding Columns in Zoho Sheet
Hi Team, We’re experiencing a challenge with the column-hiding feature on Zoho Sheet during collaborative sessions. When one user hides a column, it becomes hidden for all users working on the file, which disrupts others' workflows. In comparison, ExcelWhat are the benefits of procurement software in a growing business setup?
I’ve been exploring tools that can help automate purchasing and vendor-related tasks. I keep hearing about the benefits of procurement software, especially for businesses that are scaling. I want to understand how it helps in streamlining operations,Object required error
Hi, I am getting an 'Object required' error on the line Call HideColumnsOutsideRange(ws, startOfWeek, endOfWeek) when I run the ShowCurrentWeek macro but not when I run the ShowCurrentMonth macro. Any ideas? Regards, GW Option Explicit Sub HideColumnsOutsideRange(wsWhat formula to use in computing total hrs and decimal hrss
So , my data includes log im column , 2 breaks with 2 columns that says back and lunch and 1 column that says back and logged out. What formula should i use to be able to automatically have my total hours as I input time in each column? ThankyouReplacing email ID,
In zoho sheets If I am sending it as an email attachments can I replace sender email ID from notifications to my email ID.Latest Enhancements and Bug Fixes in Zoho Meeting
Hello there, We hope you're doing well. The latest updates from Zoho Meeting include enhancements like adding names for instant meetings, renaming participants, enabling text notifications for participant entry/exit, viewing details of bandwidth optimization,Multi-video feed in webinars, custom domain options, and our integration with MS Outlook
Hi there, We hope you're doing well. With your help, we have been able to release many useful features and enhancements in 2020. We, the Zoho Meeting team, would like to thank you all for the feedback, support, and encouragement you've given as we workedAdd co-hosts in meetings, manage webinar registration and other enhancements
Hello all, This month's updates allow you to add co-hosts while scheduling meetings. You can also control your webinar registrations better by allowing or blocking registrations from the domain or country of your choice. Read on to learn more. MeetingA new UI for distraction-free engagement in online meetings and webinars that scale up for 3000 attendees
Hello all, We're excited to share our new, refined UI for online meetings. Here's how the new UI will improve your experience during online meetings: We've re-designed Zoho Meeting's online meeting UI to enable users to fully engage in conversationsNext Page