Retrieve a Sales Order

HTTP Request

GET https://commerce.zoho.com/store/api/v1/salesorders/order_id 

 

OAuth Scope

ZohoCommerce.salesorders.READ

Request Example

Copiedcurl -i -L -X GET
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:58927961"
'https://commerce.zoho.com/store/api/v1/salesorders/51128000000118027'

Success Response

Copied{
"code": 0,
"message": "success",
"salesorder": {
"customer_id": "3000000002259",
"customer_name": "a",
"contact_persons": [
{
"contact_person_id": "1620000000141009",
"first_name": "Selva",
"last_name": "",
"email": "selvaraj.p@zohocorp.com",
"phone": "",
"mobile": ""
}
],
"billing_address": {
"city": "HI",
"country": "HI",
"state": "HI",
"street": "HI",
"zip": "HI"
},
"shipping_address": {
"city": "Chennai",
"country": "IN",
"state": "IN-TN",
"street": "HI",
"zip": "123"
},
"checkout_ip": "127.0.0.17",
"coupon_id": "32030303011",
"coupon_code": "JAN2018"
"salesorder_id": "3000000003001",
"salesorder_number": "SO-00002",
"date": "2017-01-18",
"is_update_required": false,
"order_status": "pending|confirmed|completed|returned|cancelled|declined",
"invoiced_status": "paid|unpaid|refunded|cancelled|declined",
"shipped_status": "pending|processing|shipped|delivered|returned",
"salesperson_id": "",
"salesperson_name": "",
"reference_number": "",
"currency_id": "3000000000061",
"currency_code": "INR",
"currency_symbol": "Rs.",
"exchange_rate": 1,
"discount": 0,
"discount_applied_on_amount": 0,
"is_discount_before_tax": true,
"discount_type": "item_level",
"delivery_method": "",
"delivery_method_id": "",
"is_inclusive_tax": false,
"sales_channel": "direct_sales",
"payment_mode":"Cash On Delivery|Razorpay|Stripe",
"is_offline_payment":true|false,
"line_items": [
{
"line_item_id": "3000000003003",
"item_id": "3000000002269",
"name": "",
"description": "asdf",
"item_order": 1,
"bcy_rate": 20,
"rate": 20,
"quantity": 1,
"unit": "",
"discount_amount": 0,
"discount": 0,
"attribute_name1": "A1",
"attribute_name2": "A2",
"attribute_name3": "A2",
"attribute_option_name1": "N1",
"attribute_option_name2": "N2",
"attribute_option_name3": "N3",
"attribute_option_data1": "#000000",
"attribute_option_data2": "#111111",
"attribute_option_data3": "#222222",
"quantity_invoiced": 0,
"quantity_packed": 0,
"quantity_shipped": 0,
"tax_id": "",
"tax_name": "",
"tax_type": "tax",
"tax_percentage": 0,
"item_total": 20,
"is_invoiced": false,
"is_unconfirmed_product": false,
"image_id": "3000000003065",
"image_name": "test.jpeg",
"image_type": "jpeg",
"item_custom_fields": [
]
}
],
"shipping_charge": 0,
"is_tax_on_shipping_enabled": true,
"shipping_charges":
{
"description": "Shipping charge",
"bcy_rate": 250.0,
"bcy_rate_formatted": "Rs.250.00",
"rate": 250.0,
"rate_formatted": "Rs.250.00",
"tax_id": "33914000000091663",
"tax_name": "GST12",
"tax_type": "tax_group",
"tax_percentage": 12,
"tax_total_fcy": 30.0,
"tax_total_fcy_formatted": "Rs.30.00",
"item_total": 250.0,
"item_total_formatted": "Rs.250.00",
"item_total_inclusive_of_tax": 280.0,
"item_total_inclusive_of_tax_formatted": "Rs.280.00"
},
"adjustment": 0,
"adjustment_description": "",
"sub_total": 20,
"tax_total": 0,
"total": 20,
"taxes": [
],
"price_precision": 2,
"is_emailed": false,
"purchaseorders": [
],
"notes": "",
"terms": "",
"custom_fields": [
],
"template_id": "3000000000103",
"template_name": "Standard Template",
"template_type": "standard",
"created_time": "2017-01-18T11:06:58+0530",
"created_time_formatted": "18 Jan 2017 11:06 AM",//Create time will be formatted according to org profile settings
"last_modified_time": "2017-01-18T11:06:58+0530",
"created_by_id": "3000000002236",
"attachment_name": "",
"can_send_in_mail": false,
"packages": [
{
"package_id": "1620000000557001",
"package_number": "TYR",
"date": "2017-01-20",
"date_formatted": "20 Jan 2017",
"status": "delivered",
"status_formatted": "Delivered",
"detailed_status": "",
"status_message": "",
"shipment_id": "1620000000557015",
"shipment_number": "HG",
"shipment_status": "3",
"shipment_status_formatted": "3",
"carrier": "CI",
"service": "",
"tracking_number": "GH-44",
"shipment_date": "2017-01-20",
"shipment_date_formatted": "20 Jan 2017",
"delivery_days": "",
"delivery_guarantee": false,
"shipment_order": {
"shipment_id": "1620000000557015",
"shipment_number": "HG",
"shipment_date": "2017-01-20",
"shipment_date_formatted": "20 Jan 2017",
"tracking_number": "GH-44",
"carrier": "CI",
"service": "",
"delivery_days": "",
"delivery_date": "2017-01-20",
"delivery_guarantee": false
}
}
],
"payments": [
{
"payment_id": "2000000006029",
"payment_number": "1",
"payment_mode": "Bank Transfer",
"invoice_payment_id": "2000000006031",
"description": "",
"date": "2017-02-03",
"reference_number": "",
"exchange_rate": 1,
"amount": 501,
"is_single_invoice_payment": true,
"last_four_digits": "",
"online_transaction_id": "8B193203G8002061R"
}
],
"is_test_order":true,
"can_process_in_store":true,
"fraud_transaction_reason" : [] //deprecated will be removed in next build
"fraud_analysis": { //deprecated
"manual": "Verified Manually",// If user enter some reason to mark as fraud
"system": [
"Checkout location and shipping location not from same region",
"System detected IP score as 3"
],
"ip_city": "Chennai",
"ip_region": "Tamil Nadu",
"ip_countrycode": "IN",
"ip_countryname": "India",
"ip_latitude":"56.121960",
"ip_longitude":"12.310560",
"ip_zip": "603202",
"ip_score":3,
"is_ip_location_and_shipinng_location_matches":true/false,
"payment_retry_count":1
},
"risks" : [
{
"message" : "This order was placed from ip address: <some ip>"
},
{
"message" : "The ip score is 0"
},
{
"message" : "There was 1 payment attempt"
},
{
"message" : "Location of IP address used to place the order is Chennai"
},
{
"message" : "Billing country does not match the country from which the order was placed"
}
]
}
}
}
Retrieves details of an existing Sales Order.