ECJiaWiki:Api:admin/orders/list

来自ECJiaWiki
跳转至: 导航搜索

应用场景

 订单列表

接口名称

 admin/orders/list

Header请求参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
设备唯一ID device-udid String a46d663d675d4858ea7d0a21c2de06e9 设备的唯一编号 1.3.0
设备客户端类型 device-client String android,iphone,h5,weapp 设备类型的描述 1.3.0
产品编号 device-code String 6015 产品编号 1.3.0
API版本 api-version String 1.6 API接口版本号 1.3.0

举例如下

{
    "device-udid" : "a46d663d675d4858ea7d0a21c2de06e9",
    "device-client" : "weapp",
    "device-code " : "6015",
    "api-version" : "1.6",
}

Body请求参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
token请求凭证 token String d122e3c72332c5af12a71d77c9f1462f5901d276 调用接口凭证 1.3.0
分页 pagination Json 分页 1.3.0
└ 一页最多多少条 count Int 10 一页最多多少条 1.3.0
└ 分页当前页码 page Int 1 分页当前页码 1.3.0
状态 type String 1 await_pay/待付款,await_ship/待发货,shipped/已发货,finished/已完成,refund/退款(退货),closed/已关闭(无效) 1.3.0
关键字 keywords String 1 收货人或订单编号 1.3.0

举例如下

{
    "token" : "d122e3c72332c5af12a71d77c9f1462f5901d276",	
    "pagination" : {
    	"count": 10,		//一页最多多少条
    	"page" : 1 		//分页当前页码
    }
    "type" :  "await_pay"      //await_pay/待付款,await_ship/待发货,shipped/已发货,finished/已完成,refund/退款(退货),closed/已关闭(无效)
    "keywords" : "陈先生"      //收货人或订单编号
}

返回参数

字段名 变量名 必填 类型 示例值 描述 since deprecated
返回状态码 status Json {"succeed" : 1} 返回请求接口后的数据,succeed为1代表成功,0则为失败,失败后则返回error_code(错误code)及error_desc(错误说明) 1.3.0
返回信息 data Array 请求接口提供的返回信息 1.3.0
└ 订单id order_id Int 306 订单id 1.3.0
└ 订单编号 order_sn Int 2015042708648 订单编号 1.3.0
└ 订单费用 total_fee Float 70.00 订单费用 1.3.0
└ 总费用 formated_total_fee String ¥70.00元 总费用 1.3.0
└ 使用积分费用 formated_integral_money String ¥0.00元 使用积分费用 1.3.0
└ 红包费用 formated_bonus String ¥0.00元 红包费用 1.3.0
└ 运费费用 formated_shipping_fee String ¥60.00元 运费费用 1.3.0
└ 折扣 formated_discount String ¥0.00元 折扣 1.3.0
└ 订单状态 status String 已确认,未付款,未发货 订单状态 1.3.0
└ 商品件数 goods_number Int 1 商品件数 1.3.0
└ 下单时间 create_time String 2015-04-27 下单时间 1.3.0
└ 商品列表 goods_list Array 商品列表 1.3.0
  └ 商品Id goods_id Int 5 商品Id 1.3.0
  └ 商品名称 name String 索爱原装M2卡读卡器 商品名称 1.3.0
  └ 商品图片信息 img Array 商品图片信息 1.3.0
    └商品图片信息url img String 5_G_1241422518470.jpg 商品图片信息url 1.3.0
    └商品图片信息thumb thumb String 5_G_1241422518773.jpg 商品图片信息thumb 1.3.0
    └商品图片信息small small String 5_thumb_G_1241422518886.jpg 商品图片信息small 1.3.0

成功举例如下

{
	"data" : {		//数据
            "order_id": "306",                         //订单id
            "order_sn": "2015042708648",               //订单编号
            "total_fee": "70.00",                      //订单费用
            "formated_total_fee": "¥70.00元",        
            "formated_integral_money": "¥0.00元",     //使用积分费用
            "formated_bonus": "¥0.00元",              //红包费用
            "formated_shipping_fee": "¥60.00元",      //运费费用
            "formated_discount": "¥0.00元",           //折扣
            "status": "已确认,未付款,未发货",          //订单状态
            "goods_number": "1",                       //商品件数
            "create_time": "2015-04-27",               //下单时间
            "goods_list": {                  
                "goods_id": "5", 
                "name": "索爱原装M2卡读卡器",
                "img": {
                    "thumb": "http://192.168.1.55/ecmoban-admin/content/uploads/images/200905/goods_img/5_G_1241422518773.jpg",
                    "url": "http://192.168.1.55/ecmoban-admin/content/uploads/images/200905/source_img/5_G_1241422518470.jpg",
                    "small": "http://192.168.1.55/ecmoban-admin/content/uploads/images/200905/thumb_img/5_thumb_G_1241422518886.jpg"
                }
            }
        },
	"status" : {		//状态
		"succeed" : 1		//是否成功(0.失败;1.成功)
	}
}

失败举例如下

{
  "status" : {		//状态
        "succeed" : 0;		        //是否成功
        "error_code" : 100;		//错误编码
        "error_desc" : "Invalid session";		//错误信息
  }
}


注:错误编码