当前位置: 文档中心


接口名:taobao.crm.order.detail.get(查询订单管理)    

 ¥标准    

1.接口说明  

1.1 接口描述:增量查询销售订单信息。                
1.2 适用版本:客户端 V2.4.5.0及以上版本
1.3 全量获取:该接口是增量获取销售订单数据(包含淘系数据)                            
1.4 接口说明:该接口与查询销售出库单method相同,通过扩展字段extendProps进行区分,具体查看字段说明

2.调用场景 

  2.1 暂无                            

3.请求参数说明        

  3.1 请求地址  

环境         HTTP地址            
测试环境            http://qimen.api.taobao.com/router/qmtest          
正式环境            http://qimen.api.taobao.com/router/qm      

   3.2 公共请求参数

名称字段类型长度必须描述

奇门授权应用

app_key

String


奇门授权应用,TOP分配给应用的Appkey

接口名

method

String           


API接口名称,同上面接口名说明(固定值):taobao.crm.order.detail.get

目标appkey

target_app_key

String          


目标appkey,由旺店通提供

签名

sign

String 


API输入参数签名结果,签名算法介绍请点击这里

授权信息

session

String 


用户登录授权成功后,TOP颁发给应用的授权信息,详细介绍请点击这里

时间戳

timestamp

String 


时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8。淘宝API服务端允许客户端请求最大时间误差为10分钟

响应格式

format

String 


响应格式(固定值):json

API协议版本

v

String 


API协议版本(固定值):2.0

  3.3 业务请求参数

名称字段类型长度必须描述

开始时间

startModified

String


开始时间,示例:2020-01-01 00:00:00

结束时间

endModified

String


结束时间,示例:2020-01-01 00:00:00

页号

pageNo

Int


页号,分页查询的页码

分页大小

pageSize

Int



分页大小,分页查询每页数据条数

店铺编号

sd_code

String


店铺编号

系统订单编号

orderSn

String


系统订单编号,JY开头

返回字段

fields

int

255


需要获取的字段名,用‘,’隔开。奇门接口限制,长度不得超过255
可选字段:
order_sn,deal_code,order_status,lylx,lylx_name,shipping_code,shipping_sn,shipping_fee,sd_code,last_update,fhck,add_time,shipping_time_fh,receiver_name,receiver_address,receiver_tel,receiver_mobile,receiver_country,receiver_province,receiver_city,receiver_district,shipping_name,seller_msg,weigh,order_amount,market_goods_amount,shop_goods_amount,pay_time,is_hh,goods_sn,barcode,size_code,size_name,goods_number,brand_id,brand_name,ckj,goods_price,discount,payment,share_price,is_largess,deal_code,extendProps

扩展字段

extendProps

String



扩展字段,可传wdt_interface(必传) sid(必传) status(选传),具体用法如下:

wdt_interface: trade (接口解析参数,trade代表查询销售订单)

status: 不传默认获取全部,(5已取消 10待付款 12待尾款 13待选仓 15等未付16延时审核 19预订单前处理 20前处理(赠品,合并,拆分)21委外前处理22抢单前处理 25预订单 27待抢单 30待客审 35待财审 40待递交仓库 45递交仓库中 50已递交仓库 53未确认 55已确认(已审核) 95已发货 105部分打款 110已完成 113异常发货)

sid:卖家账号(购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取)

示例:{"wdt_interface":"trade","status":"95","sid":"apidevnew2"}

路由参数

customerid

String



路由参数,淘宝平台发起上线后由下游自定义维护

4.响应参数

  4.1公共响应参数

名称字段类型长度必须描述
错误码            code            string        40            是            状态码:0表示成功,其他表示失败            
错误描述messageString

错误描述  
响应结果        status
String      
         
响应结果,success or failure
订单数据
datadata[ ]        

是            返回信息

   4.2 data[ ]响应参数

名称字段类型长度必须描述
分页信息   
pagedata[ ]

分页信息
单据明细信息 
orderListGet
data[ ]


单据明细信息



 


4.3 page[ ]响应参数

名称字段类型长度必须描述
当前页码                  
pageNoInt
                 
是       
当前页码
分页大小                  
pageSizeInt

是       
分页大小
总页数
pageTotalInt

是       
总页数
总条数
totalResult                  
Int

是       
总条数

4.4 orderListGet[ ]响应参数

名称字段类型长度必须描述
系统订单编号
order_snstring

是       
系统订单编号,默认JY开头
原始单号            
deal_codestring             
                  
是       
原始单号
订单状态
order_statusInt

是       
订单状态(5已取消 10待付款 12待尾款 13待选仓 15等未付16延时审核 19预订单前处理 20前处理(赠品,合并,拆分)21委外前处理22抢单前处理 25预订单 27待抢单 30待客审 35待财审 40待递交仓库 45递交仓库中 50已递交仓库 53未确认 55已确认 95已发货 100已签收 105部分打款 110已完成)
平台ID
lylxInt

是       
平台ID
快递公司编码
shipping_code
string

是       
快递公司编码
物流公司名称shipping_namestring
物流公司名称
物流单号
shipping_sn
string

是       
物流单号
物流费用
shipping_fee
string

是       
物流费用
店铺编号
sd_code
string

是       
店铺编号
应收金额order_amountstring
应收金额
平台支付帐号pay_codestring
平台支付帐号
下单时间pay_timestring
下单时间
退款状态pay_statusstring
退款状态
最后更新时间
last_update
string

是       
最后更新时间
仓库编号
fhck
string

是       
仓库编号
下单时间
add_time
string

是       
下单时间
买家网名
user_name
string

是       
买家网名
收件人姓名
receiver_name
string

是       
收件人姓名
收件人地址
receiver_address
string

是       
收件人地址
收件人电话
receiver_tel
string

是       
收件人电话
收件人手机
receiver_mobile
string

是       
收件人手机
国家
receiver_country
string

是       
国家,标准地址码
省份
receiver_province
string

是       
省份,标准地址码
城市
receiver_city
string

是       
城市,标准地址码
区县
receiver_district
string

是       
区县,标准地址码
客服备注
seller_msg
string

是       
客服备注

货品数量

num
string

是       
货品数量
实收金额shop_goods_amountstring
实收金额

重量

weigh
string

是       
重量

货品总金额

market_goods_amount
string

是       
货品总金额

扩展字段

extendProps
string

是       
扩展字段

订单商品明细信息

orderDetailGets
data[ ]

是       
订单商品明细信息

4.5 orderDetailGets[ ]响应参数

名称字段类型长度必须描述
商家编码                  
goods_snstring
                  
是       
商家编码
规格码
size_codestring

是       
规格码
规格名称
size_namestring

是       
规格名称
下单数量
goods_numberstring

是       
下单数量
订单明细价格            
ckj
string

是       
订单明细价格
成本价
goods_price
string

是       
成本价
折扣
discount
string

是       
折扣
金额
payment
string

是       
金额
实收金额
share_price
string

是       
实收金额
原始子订单编号
deal_code
string

是       
原始子订单编号
扩展字段
extendProps
string

是       
扩展字段

5.响应示例

   5.1 正常响应示例 

JSON
{
	"status":"success",
	"code":"0",
	"message":"OK",
	"data":{
		"page":{
		"totalResult":1,
		"pageSize":10,
		"pageNo":1,
		"pageTotal":1
		},
		"orderListGet":{
			"OrderListGets":[
				{
					"order_sn":"199909410001",
					"deal_code":"213121321",
					"order_status":0,
					"lylx":5,
					"shipping_code":"yto",
					"shipping_sn":"1232132",
					"shipping_fee":"12",
					"sd_code":"001",
					"last_update":"2011-12-11 08:00:00",
					"fhck":"001",
					"add_time":"2011-12-11 08:00:00",
					"receiver_name":"张三",
					"receiver_address":"上海 上海市 浦东新区 峨山路xxx",
					"receiver_tel":"02011111",
					"receiver_mobile":"15026687787",
					"receiver_country":"中国",
					"receiver_province":"浙江",
					"receiver_city":"杭州",
					"receiver_district":"余杭",
					"shipping_name":"货到付款",
					"seller_msg":"好评返券",
					"weigh":"3.0",
					"order_amount":"200.0",
					"market_goods_amount":"250.0",
					"num":"1",
					"pay_time":"2011-12-11 12:00:00",
					"extendProps":"",
					"orderDetailGets":{
						"OrderDetailGets":[
							{
								"goods_sn":"01S757",
								"barcode":"111111",
								"size_code":"M",
								"size_name":"M",
								"goods_number":"1",
								"brand_name":"耐克",
								"ckj":"200.0",
								"goods_price":"200.0",
								"discount":"0.8",
								"payment":"160.0",
								"share_price":"160.0",
								"deal_code":"22222",
								"extendProps":""
							}
					]
				}
				}
			]
		}
	}
}