Get User Orders
HTTP Request
GET https://zylkerfashionstore.zohostore.com/portaluser/orders?filterDate=3
Query Parameters
| Parameter | Description |
| filterDate | string: Represents the number of months for which the orders need to be displayed. |
Request Example
Copiedcurl -i -X GET \
-H "Cookie:_iamadt_client_portalId= *****;_iambdt_client_portalId= *****;" \
'https://zylkerfashionstore.zohostore.com/portaluser/orders?filterDate=3'Success Response
Copied{
"status_code": "0",
"status_message": "success",
"api_kind": "kind#get_user_orders_list",
"payload": {
"salesorders_zos_response": {
"salesorders": [
{
"date": "2020-02-11",
"is_return_waiting_for_approval": false,
"due_by_days": "",
"shipment_date": "",
"line_items": [
{
"bcy_rate": 1200,
"quantity_shipped": 0,
"quantity_returned": "1787495000000363001",
"line_item_id": "1787495000000454021",
"product_url": "/products/test-prod/1787495000000363005?variant=1787495000000363001",
"quantity_invoiced_cancelled": 0,
"alternate_text": "Test_prod",
"attribute_option_data3": "",
"description": "",
"discount": 0,
"attribute_option_data2": "",
"attribute_option_data1": "",
"quantity_cancelled": 0,
"document_id": "1787495000000364005",
"title": "Test_prod",
"item_order": 1,
"is_unconfirmed_product": false,
"image_name": "Screen Shot 1941-04-01 at 12.38.45 PM.png",
"variant_id": "1787495000000363001",
"rate": 1200,
"product_id": "1787495000000363005",
"attribute_option_name2": "",
"attribute_option_name3": "",
"quantity_packed": 0,
"sku": "",
"is_returnable": true,
"image_type": "png",
"attribute_name2": "",
"attribute_name3": "",
"quantity": 1,
"quantity_manuallyfulfilled": 0,
"image_document_id": "1787495000000364005",
"item_id": "1787495000000363001",
"image_alter_text": "Test_prod",
"attribute_name1": "",
"attribute_option_name1": "",
"item_total": 1200,
"is_invoiced": false,
"url": "test_prod",
"stock_on_hand": 19,
"unit": "",
"product_type": "",
"quantity_invoiced": 0,
"name": "Test_prod",
"image_id": "7619835000000030001"
}
],
"order_status_formatted": "Pending",
"order_status": "pending",
"bcy_total_formatted": "Rs.1,200.00",
"balance": 1200,
"refund_status_formatted": "",
"created_time_formatted": "11/02/2020 03:14 PM",
"created_time": "2020-02-11T15:14:57+0530",
"refund_status": "",
"sales_channel": "zstore",
"status_formatted": "Pending",
"reference_number": "",
"delivery_date": "",
"shipped_status_formatted": "",
"returns": [
],
"is_backorder": false,
"status": "pending",
"is_cancel_item_waiting_for_approval": false,
"quantity_shipped": 0,
"invoiced_status": "16",
"shipped_status": ""
"balance_formatted": "Rs.1,200.00",
"salesorder_id": "1787495000000454013",
"currency_code": "INR",
"refunds": [
],
"return_shipment_status_formatted": "",
"shipment_date_formatted": "",
"bcy_total": 1200,
"total": 1200,
"date_formatted": "11/02/2020",
"quantity_packed": 0,
"email": "commerce@zoho.com",
"quantity": 1,
"last_modified_time": "2020-02-11T15:14:57+0530",
"return_status_formatted": "",
"is_manually_fulfilled": false,
"shipment_days": "",
"due_in_days": "",
"currency_symbol": "Rs.",
"is_emailed": false,
"is_drop_shipment": false,
"sales_channel_formatted": "Zoho Commerce",
"delivery_date_formatted": "",
"quantity_invoiced": 0,
"return_status": "",
"salesorder_number": "SO-00008",
"customer_name": "Ramakrishna",
"customer_id": "1787495000000390001",
"total_formatted": "Rs.1,200.00",
"currency_id": "1787495000000000099",
"invoiced_status_formatted": "16",
"return_shipment_status": ""
}
],
"code": 0,
"message": "success",
"page_context": {
"per_page": 200,
"sort_column": "created_time",
"applied_filter": "Status.All",
"has_more_page": false,
"page": 1,
"report_name": "Sales Orders",
"sort_order": "D",
"search_criteria": [
{
"comparator": "range",
"column_name": "date",
"column_name_formatted": "Order Date",
"search_text_0": "2019-11-11",
"search_text_formatted_0": "2019-11-11",
"search_text_formatted_1": "2020-02-11",
"search_text_1": "2020-02-11"
}
]
}
}
}
}Show full
Show less
Failure Response
Copied{
"status_code": "1",
"status_message": "failure",
"api_kind": "kind#get_user_orders_list",
"error": {
"code": 37014,
"message": "Invalid entries"
},
"developer_message": "Invalid entries"
}Use this API to get the list of orders with statuses that were purchased from an user account.