List All Sales Orders
HTTP Request
GET https://commerce.zoho.com/store/api/v1/salesorders
OAuth Scope
ZohoCommerce.salesorders.READ
Headers
| Header | Values |
| Authorization | Zoho-oauthtoken *** |
| X-com-zoho-store-organizationid | 58927961 |
Query Parameters
| Parameter | Values |
| filter_by | Status.All, Status.Draft, Status.Confirmed, Status.ToBePacked, Status.ToBeShipped, Status.Shipped, Status.ToBeInvoiced, Status.Closed, Status.Void |
| sort_column | customer_name, salesorder_number, date, shipment_date, total, bcy_total, created_time, last_modified_time |
| sort_order | A, D |
| page | 1 to n |
| per_page | 10, 25, 50, 100, 200 |
Search Nodes
| Parameter | Values |
| customer_id | 3000000002259 |
| salesorder_number_contains | SO-00002 |
| peterparker@bowmanfurniture.com | |
| mobile | 9876543210 |
| order_status | draft, pending, confirmed, closed, void, onhold, cancelled |
| invoiced_status | null, partially_ invoiced,invoiced, paid |
| paid_status | null, unpaid,partially_paid, paid |
| shipped_status | null, pending, partially_shipped, shipped, fulfilled |
| return_status | null, initiated, partially_returned, returned |
| return_shipment_status | null, receive_pending, partially_received, received |
| refund_status | null, refund_pending, partially_refunded, refunded |
| is_return_waiting_for_approval | true, false |
| is_cancel_item_waiting_for_approval | true, false |
Request Example
Copiedcurl -i -L -X GET
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:58927961"
-H "X-ZOHO-Include-Formatted:true"
'https://commerce.zoho.com/store/api/v1/salesorders'Success Response
Copied{
"code": 0,
"message": "success",
"salesorders": [
{
"salesorder_id": "3000000003001",
"zcrm_potential_id": "",
"zcrm_potential_name": "",
"customer_name": "a",
"email":"abc@zoho.com",
"customer_id": "3000000002259",
"email":"peterparker@bowmanfurniture.com",
"order_status":"draft|pending|confirmed|closed|void|onhold|cancelled",
"invoiced_status": "null|partially_invoiced|invoiced|paid",
"paid_status": "null|unpaid|partially_paid|paid",
"shipped_status": "null|pending|partially_shipped|shipped|fulfilled",
"refund_status": "null|refund_pending|partially_refunded|refunded",
"return_status": "null|initiated|partially_returned|returned",
"return_shipment_status": "null|receive_pending|partially_received|received",
"salesorder_number": "SO-00002",
"reference_number": "",
"date": "2017-01-18",
"shipment_date": "",
"shipment_days": "",
"currency_id": "3000000000061",
"currency_code": "INR",
"total": 20,
"bcy_total": 20,
"created_time": "2017-01-18T11:06:58+0530",
"last_modified_time": "2017-01-18T11:06:58+0530",
"is_emailed": false,
"is_possible_fraud_transaction":true,
"Notes" :"Order Notes Sample",
"fraud_transaction_reason" : "Reason for fraud"
},
{
"salesorder_id": "3000000002281",
"zcrm_potential_id": "",
"zcrm_potential_name": "",
"customer_name": "a",
"email":"abc@zoho.com",
"customer_id": "3000000002259",
"order_status":"draft|pending|confirmed|closed|void|onhold|cancelled",
"invoiced_status": "null|partially_invoiced|invoiced|paid",
"paid_status": "null|unpaid|partially_paid|paid",
"shipped_status": "null|pending|partially_shipped|shipped|fulfilled",
"refund_status": "null|refund_pending|partially_refunded|refunded",
"return_status": "null|initiated|partially_returned|returned",
"return_shipment_status": "null|receive_pending|partially_received|received",
"salesorder_number": "SO-00001",
"reference_number": "",
"date": "2017-01-17",
"shipment_date": "",
"shipment_days": "",
"currency_id": "3000000000061",
"currency_code": "INR",
"total": 20,
"bcy_total": 20,
"created_time": "2017-01-17T20:03:09+0530",
"created_time_formatted": "17/01/2017 08:03 PM",//Date will be formatted according to org settings
"last_modified_time": "2017-01-17T20:03:09+0530",
"is_emailed": false,
"is_possible_fraud_transaction":false,
"fraud_transaction_reason" : "",
"Notes" : ""
}
],
"page_context": {...},
}