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
Copied
Success Response
Copied
Show full
Show less