1.1 Description
| path | http://www.your_website_domain.com/FeiEditor/api_v1/shop/orders |
| method | GET/POST |
| illustrate | Obtain the order list according to the query conditions. |
1.2 parameters
| name | must | type | describe |
| status | no | string | Query according to the order status, which can be one of: pending, on-hold, processing, completed, refunded, failed, and canceled. For example: status=pending. |
| filter[] | no | array | filter. Click here for how to use . |
| filter[limit] | no | int | The number of orders returned by a query, the default is 10. The valid range is 1 to 1000. |
| page | no | int | The number of pages currently queried, used in conjunction with filter[limit]. Used to implement paging queries. |
1.3 return result
| correct result |
| Return format: JSON |
| { "orders" : [ { "completed_at" : "2013-12-10T18:59:30Z", "tax_lines" : [], "status" : "processing", "total" : "100.00", "cart_discount" : "0.00", "customer_ip" : "127.0.0.1", "total_discount" : "0.00", "updated_at" : "2016-10-10T18:00:00Z", "currency" : "RMB", "total_shipping" : "0.00", "customer_user_agent" : "Chrome/31.0.1650.63 Safari/537.36", "line_items" :[ { "product_id" : 101, "quantity" : 1, "id" : 1, "subtotal" : "100.00", "tax_class" : null, "sku" : "", "total" : "100.00", "name" : "DEMO PRODUCT", "total_tax" : "0.00" } ], "customer_id" : "1", "total_tax " : "0.00", "order_number" : "#113", "shipping_methods" : "Free Shipping", "shipping_address" : { "city" : "Suzhou", "country" : "CN", "address_1" : " A side street", "last_name" :"Mr", "company" : "Qada", "postcode" : "12345", "address_2" : "", "state" : "Jiangsu", "first_name" : "Dong" }, "payment_details" : { "method_title" : "Cheque Payment", "method_id" : "cheque", "paid" : false }, "id" : 188, "shipping_tax" : "0.00", "cart_tax" : " 0.00", "fee_lines" : [], "total_line_items_quantity" : 1, "shipping_lines" : [ { "method_title" : "Free Shipping", "id" : 8, "method_id" : "free_shipping", "total" : " 0.00" } ], "customer" : { "id" : 4, "last_order_date" : "2017-10-01T18:00:00Z", "avatar_url" : "", "total_spent" : "0.00", "created_at" : "2017-10-01T18:00:00Z", "orders_count" : 0, "billing_address" : { "phone" : "123456789", "city" : "Suzhou", "country" : "CN", "address_1" : "Damalu", "last_name" : "Mr", "company" : "Kada", "postcode" : "12345", "email" : "demo@example.com", "address_2" : "", "state" : "Jiangsu", "first_name" : "Dong" }, "shipping_address" : { "city" : "Suzhou", "country" : "CN", "address_1" : "Damalu", "last_name" : "Mr", "company" : "Kada", "postcode" : "12345", "email" : "demo@example .com", "address_2" : "", "state" : "Jiangsu", "first_name" : "Dong" }, "first_name" : "Dong", "username" : "demouser", "last_name" : "Mr. ", "last_order_id" : "1", "email" : "demo@example.com" }, "note" : "", "coupon_lines" : [], "order_discount" : "0.00", "created_at" : "2017-10-01T18:00:00Z" , "view_order_url" : "https://www.example.com/my-account/view-order/188", "billing_address" : { "phone" : "123456789", "city" : "Suzhou", "country" : "CN", "address_1" : "Big Road", "last_name" : "Mr", "company" : "Kada", "postcode" : "12345", "email" : "demo@example.com" , "address_2" : "", "state" : "Jiangsu", "first_name" :"Dong" } } ] } |