Sales Orders

A sales order is a financial document that confirms an impending sale. It contains details of the quantity, price and delivery details of the products or services being sold. You can perform these simple operations mentioned below to retrieve your sales orders.

HeaderValues
AuthorizationZoho-oauthtoken ***
X-com-zoho-store-organizationid58927961

Attributes

AttributeDescription
salesorder_idlong: Unique ID generated by the server for each sales order. This is used an identifier.
salesorder_number string: The sales order number. This is unique for each sales order.
datestring: The date for the sales order.
order_statusstring: The current status of the Sales Order. Allowed values: pending, confirmed, completed, returned, cancelled, and declined.
shipment_datestring: Shipment date of the sales order.
reference_numberstring: Reference number of the Sales Order.
customer_idlong: Unique ID generated for the customer. This is used as an identifier.
customer_namestring: Name of the customer.
currency_idlong: Unique ID generated by the server for the currency. This is used as an identifier.
currency_code string: Currency code.
currency_symbolstring: The symbol for the selected currency
totaldouble: Total amount of the sales order.
is_emailedboolean: Checks whether the sales order has been emailed to the customer or not.
created_timestring: Time at which the sales order was created.
last_modified_timestring: Time at which the sales order details were last modified.
contact_personslist: Person/Individual who represents a company.
billing_addressobject: Billing address of the contact.
shipping_addressobject: Customer's shipping address to which the goods must be delivered.
exchange_ratedouble: Exchange rate of the currency, with respect to the base currency.
discount_amountdouble: Discount to be applied on the sales order.
discountdouble: The percentage of discount applied.
discount_typestring: 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.
line_itemslist: 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.
shipping_chargedouble: Shipping charges that can be applied to the sales order.
adjustmentdouble: Adjustment on the sales order's total.
adjustment_description string: Description for the adjustment.
sub_totaldouble: Sub total of the sales order.
tax_total double: Tax total of the sales order.
taxeslist: Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount.
price_precisiondouble: The precision level for the price's decimal point in a sales order.
packageslist: These are the packages created for sales orders. Each package contains—package_id, package_number, status, detailed_status, status_message, shipment_id, shipment_number, shipment status, carrier, service, tracking_number, shipment_date, delivery_days, and delivery_guarantee.
notesstring: Notes for the sales order.
termsstring: Terms for the sales order.
invoiced_statusstring: The current status of the invoice. Allowed values: paid, unpaid, refunded, cancelled, and declined.
shipped_statusstring: The current status of the package. Allowed values: paid, unpaid, refunded, cancelled, and declined.
payment_modestring: Mode through which payment is made. This can be Cash on Delivery, Razorpay, Stripe, or others. Maximum length [100].
is_offline_paymentboolean: Checks whether the payment was made offline.