Products

Response Structure


   
   {
    "data": [
        {
            "Product_Category": "Hardware", //Represents the category of the product
            
            "Qty_in_Demand": 100, //Represents the quantity in demand
            
            "Owner": { //Name, ID, and email of the owner of the Lead
               
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
            },
            
            "Description": "This is a sample description", //Description of the product
            
            "$currency_symbol": "DA", //The currency in which the revenue is generated
            
            "Vendor_Name": { //Name and ID of the product vendor
               
                "name": "Vendor1",
                
                "id": "4150868000000236379"
            },
            
            "$review_process": { //Review process details of the product
               
                "approve": false,
                
                "reject": false,
                
                "resubmit": false
            },
            
            "Tax": [ //Represents the tax details of the product
               
                "Vat - 5.0 %"
            ],
            
            "Sales_Start_Date": "2020-08-25", //Date on which the product sale starts
            
            "Product_Active": true, //Represents if the product is active
            
            "Record_Image": null, //Represents the product image details
            
            "Subproducts": [ //Represents the subproduct details
                {
                   
                    "Discount": 5, //Represents the discount details of the subproduct
                    
                    "$in_merge": false, 
                    
                    "Rate": 30, //Represents the rate of the subproduct
                    
                    "Amount": 15, //Represents the final amount (rate-discount) of the subproduct
                    
                    "Parent_Id": { //Represents the name and ID of the parent product of the subproduct
                       
                        "name": "Sample Product",
                        
                        "id": "4150868000002795025"
                    },
                    
                    "Quantity": 1, //Represents the number of subproduct quantities added to the main product
                    
                    "id": "4150868000002795033", //Represents the unique ID of the subproduct
                    
                    "Vendor": { //Name and ID of the subproduct vendor
                       
                        "name": "Zylker",
                        
                        "id": "4150868000002782004"
                    },
                    
                    "Add_on_name": { //Represents the add-on product details
                       
                        "name": "sample",
                        
                        "id": "4150868000002161023"
                    },
                    
                    "$orchestration": false //Represents if the subproduct is a part of orchestration process
                }
            ],
            "Modified_By": { //Name and ID of the user who modified the product. This is a system-generated field. You cannot modify it.
               
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
            },
            
            "$review": null, //Represents the review process details of the product
            
            "Product_Code": "1001", //Represents the product identification code given manually by the user
            
            "$process_flow": false, //Represents if the record is a blueprint data
            
            "Manufacturer": "AltvetPet Inc.", //Name of the product manufacturer
            
            "id": "4150868000002795025", //Unique ID of the product
            
            "Support_Expiry_Date": "2020-08-31", //The date on which the product support ends
            
            "$approved": true, //Represents whether the record is approved
            
            "$approval": { //Represents if the current user can approve, delegate, reject, or resubmit the operations performed on this record
               
                "delegate": false,
                
                "approve": false,
                
                "reject": false,
                
                "resubmit": false
            },
            
            "Modified_Time": "2020-08-02T23:43:52+05:30", //Date and time at which the record was last modified. This is a system-generated field. You cannot modify it.
            
            "OS": null,
            
            "Created_Time": "2020-08-02T23:43:52+05:30", //Date and time at which the record was created. This is a system-generated field. You cannot modify it.
            
            "Commission_Rate": 1, //Commission rate for selling the product
            
            "Product_Name": "Sample Product", //Name of the product. This is a mandatory field.
            
            "Handler": null, //Name and ID of the Zoho CRM user who handles the product
            
            "$taxable": true, //Represents if the product is taxable
            
            "$editable": true, //Represents if the user can edit the product
            
            "Support_Start_Date": "2020-08-31", //Date on which the product support starts
            
            "$orchestration": false, //Represents if the record is a part of orchestration process
            
            "Usage_Unit": "Box", //Represents the usage unit of the product such as dozen, each, box, etc,.
            
            "Qty_Ordered": 100, //The number of product units ordered
            
            "$in_merge": false,
            
            "Qty_in_Stock": 10000, //The number of product units in stock
            
            "Created_By": { //Name and ID of the user who created the record. This is a system-generated field. You cannot modify it.
               
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "patricia.b@zohocorp.com"
            },
            
            "Tag": [], //List of tags associated with the record
            
            "$approval_state": "approved", //Represents if the record is approved
            
            "Sales_End_Date": "2020-08-31", //Date on which the product sale ends
            
            "Unit_Price": 100, //The price of each unit of the product
            
            "Taxable": true, //Represents whether the product is taxable
            
            "Reorder_Level": 500 //Represents the reorder value
        }
    ]
}
   

Note:

  • The fields beginning with "$" indicate that they do not appear on the Zoho CRM UI, but contain important data. They are read-only fields.
  • For more information about sample attributes, refer Get List of Records.