当前位置: API文档

sales.TradeQuery.queryWithDetail(订单查询)

¥标准

1.接口说明

1.1 接口描:获取ERP系统内订单信息
1.2 适用版本:客户端 V1.2.5.6及以上版本
1.3 增量获取:支持
1.4 时间跨度:start_time和end_time最大跨度为60分钟。

1.5注意事项:【权限校验】:店铺权限

为了达到保护用户隐私数据安全的目的本接口不返回淘系订单数据相关平台规则点击这里淘系数据获取办法点击这里

本接口中涉及到用户隐私的字段数据仅自有平台订单返回,具体字段详见下述“隐私字段列表”


通过从后往前翻页的方式可以避免漏单问题。

字段描述字段名
买家昵称buyer_nick
收件人姓名receiver_name
收件地址receiver_address
收件人手机receiver_mobile
收件人固话
receiver_telno
客户姓名customer_name
证件号码id_card

2.调用场景

2.1 举例说明:财务系统、SAP、数据分析等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境http://wdt.wangdian.cn/openapi

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
卖家账号, 由旺店通分配
接口账号keyString
由旺店通分配appkey, 在发送的数据中对应 key 字段
saltString
由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
调用的接口名称
版本号vString
1.0
秒级时间戳timestampint
秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
签名
分页大小page_sizeint
分页大小,分页查询必传
分页编号page_noint
分页编号,分页查询必传,标准接口page_no从0开始
是否计算查询结果的总条数calc_totalint
是否计算查询结果的总条数, 需要计算则1, 否则填0         

    3.3 业务请求参数

名称字段类型长度
必须描述
查询参数

params

Map<String, Object>
y

查询参数

分页

pager

Pager


y

分页

params

名称字段类型长度
必须描述
开始时间

start_time

String

40y修改起始时间,若无订单号,则为必填。
结束时间end_timeString40y
修改结束时间,上同开始时间
仓库编号

warehouse_no

String

40n仓库编号
订单状态

status

String

255n

若多个状态则以“,”隔开。

订单状态:  

4 线下退款

5已取消

6 待确认订单, 导入放入这个状态  待转预订单(待审核)

7待确认订单,导入时先放到这个状态(此状态不占用库存,可删除,离开这个状态就不能删除了)

10待付款

12待尾款

15等未付

16延时审核

19预订单前处理

20前处理(赠品,合并,拆分)

21委外前处理

23 异常预订单

24 换货预订单

25待处理预订单

26 待激活预订单

27待分配预订单 

30待客审

35待财审

55已确认

95已发货

96 成本确认(待录入计划成本,订单结算时有货品无计划成本

101 已过账

110已完成

订单编号

trade_no

String40n订单编号
店铺编号

shop_no

String20n店铺编号
物流单号
logistics_noString40n物流单号
原始单号src_tidString40n原始单号, 多个原始单号之间使用英文逗号分隔

pager

名称字段类型长度
必须描述
分页大小

page_size

Int4n

分页大小

页号

page_no

Int

4n

从0开始

4.响应参数

   4.1 公共响应参数

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

status

Int
y

状态码,0表示调用成功

错误信息

message

String


y

无错误信息不返回

单据数据

data

Map<String, Object>


y

单据数据

data

响应参数说明示例值或者格式、具体含义、使用方法及注意事项(如隐私数据淘系平台不返回,其他平台正常返回

名称字段类型长度
必须描述
单据数据orderList<Map<String, Object>>
y订单相关数据
总数total_countInt11n查询条件总单据数
order




订单号trade_noString40
订单号
平台IDplatform_idInt4
平台ID(请点击平台代码表查看对应关系
仓库类型warehouse_typeInt4
仓库类型:

1、普通仓库,大于1为委外仓库(如京东仓储,物流宝等)

原始单号src_tidsString255
原始单号,如果有多个,以","分隔,且以增序排列,不重复,过长将被裁剪
平台支付帐号pay_accountString128

平台支付帐号, 淘系平台不返回

订单状态trade_statusString255

订单状态:  

4 线下退款

5已取消

6 待确认订单, 导入放入这个状态  待转预订单(待审核)

7待确认订单,导入时先放到这个状态(此状态不占用库存,可删除,离开这个状态就不能删除了)

10待付款

12待尾款

15等未付

16延时审核

19预订单前处理

20前处理(赠品,合并,拆分)

21委外前处理

23 异常预订单

24 换货预订单

25待处理预订单

26 待激活预订单

27待分配预订单 

30待客审

35待财审

55已确认

95已发货

96 成本确认(待录入计划成本,订单结算时有货品无计划成本)

101 已过账

110已完成

订单类型trade_typeInt4

订单类型:

1、网店销售

2、线下订单

3、售后换货

4、批发业务

7、现款销售

8、分销

101、自定义类型一

102、自定义类型二

103、自定义类型三

104、自定义类型四

105、自定义类型五

106、自定义类型六

发货条件delivery_termInt4
发货条件:

1、款到发货 2、货到付款(包含部分货到付款)

3、分期付款

冻结原因freeze_reasonString6
冻结原因
退款状态refund_statusInt4

退款状态:

0、无退款

1、申请退款

2、部分退款

3、全部退款

分销类别fenxiao_typeInt4

分销类别:

0、非分销订单

1、代销

2、经销

分销商名fenxiao_nickString40

分销商名
下单时间trade_timeString40
下单时间
支付时间pay_timeString40
支付时间
发货时间consign_timeString40
发货时间,订单未发货不返回该字段
买家网名buyer_nickString100

卖家网名, 淘系平台不返回

收货人姓名receiver_nameString40

收货人姓名, 淘系平台不返回

省份idreceiver_provinceInt11
省份id
城市idreceiver_cityInt11
城市id
地区idreceiver_districtInt11
地区id
收件人地址receiver_addressString256

收件人地址, 淘系平台不返回

手机receiver_mobileString40
手机, 淘系平台不返回
固话receiver_telnoString40

固话, 淘系平台不返回

邮编receiver_zipString20
邮编
省市区空格分隔receiver_areaString128
省市区空格分隔
京东几环receiver_ringString20
京东几环
大头笔receiver_dtbString128
大头笔
配送时间to_deliver_timeString20
配送时间,如周一至周五,上午
异常订单原因bad_reasonInt11

异常订单原因(位运算):

2、修改地址

4、修改发票

8、更换仓库

16、修改备注

32、更换货品

128、拦截赠品

256、拦截换货

512、买家留言变化

1024、拦截平台已发货

物流单号logistics_noString40
物流单号
客户备注buyer_messageString1024
客户备注
客服备注cs_remarkString1024
客服备注
客服备注旗子remark_flagInt4
客服备注旗子
打印备注print_remarkString1024
打印备注
货品种类数goods_type_countDecimal(19,4)

货品种类数
货品总数goods_countDecimal(19,4)

货品总数
货品总额goods_amountDecimal(19,4)

货品总额
邮费post_amountDecimal(19,4)

邮费
其他收费other_amountDecimal(19,4)

其他收费
优惠金额discountDecimal(19,4)

优惠金额
应收金额receivableDecimal(19,4)

应收金额
货到付款金额cod_amountDecimal(19,4)

货到付款金额
买家COD费用ext_cod_feeDecimal(19,4)

买家COD费用
货款预估成本goods_costDecimal(19,4)

货款预估成本
预估邮费成本post_costDecimal(19,4)

预估邮费成本
预估称重kgweightDecimal(19,4)

预估称重kg
预估利润profitDecimal(19,4)

预估利润
税额taxDecimal(19,4)

税额
税率tax_rateDecimal(19,4)

税率
佣金commissionDecimal(19,4)

佣金
发票类别invoice_typeInt4

发票类别:

0、不需要

1、普通发票

2、普通增值税发票

3、专用增值税发票

发票标题invoice_titleString1024
发票标题
发票内容invoice_contentString1024
发票内容
业务员

salesman_name

String40
业务员
审核员checker_nameString40
审核员
财审员fchecker_nameString40
财审员
签出员

checkouter_name

String40
签出员
出库单号stockout_noString40
出库单号
标记名称flag_nameString32
标记名称
订单来源trade_fromInt4

订单来源:

1、API抓单

2、手工建单

3、导入

4、复制订单

5、接口推送

6、补发订单

7、PDA选货开单

单一货品商家编码single_spec_noString40
单一货品商家编码,多种货品为空,组合装时为组合装编码
原货品数量raw_goods_countDecimal(19,4)

原货品数量
原货品种类数raw_goods_type_countInt6
原货品种类数
币种currencyString20
币种
发票IDinvoice_idInt11
发票ID,目前只设0-1,1表示已开发票
版本号version_idInt6
版本号
修改时间modifiedString40
修改时间
创建时间createdString40

创建时间
证件类别id_card_typeInt4
证件类别
证件号码id_card
String40
证件号码
店铺编号shop_noString20
店铺编号
店铺名称shop_nameString128
店铺名称
店铺备注shop_remarkString255
店铺备注
仓库编号warehouse_noString40
仓库编号
买家姓名customer_nameString40
买家姓名
客户编码customer_noString40
客户编码
物流IDlogistics_idInt11
物流ID
物流名称logistics_nameString40
物流名称
物流公司编号logistics_codeString60
物流公司编号
物流类型logistics_typeInt4
物流类型
预计发货时间delay_to_timeString40
预计发货时间
订单标签trade_label
String40
订单标签
订单明细detail_listList<Map<String, Object>>

订单明细
detail_list




平台ID platform_idInt4y平台ID
原始子订单号src_oidString40y原始子订单号
原始订单号src_tidString40y
是否是赠品gift_typeInt4
y

是否是赠品 0、非赠品

1、自动赠送 2、手工赠送 4、周期购赠送 8、平台赠送

退款状态refund_statusInt4y

退款状态:

0、无退款

1、已取消

2、已申请退款

3、待退款,平台已退款,系统未退款,但订单已审核,不能直接改成,除非驳回

4、等待取消,平台上取消退款,系统已退款,但订单已审核,不能直接改成,除非驳回

5、退款成功

6、未付款关闭,未付款的取消了

退款模式guarantee_modeInt4y

退款模式:

1、担保

2、非担保

3、在线非担保

子单平台状态platform_statusInt4
y

如果没有对应的原始单明细,则返回0.

平台状态:

10、未确认

20、待尾款

30、待发货

40、部分发货

50、已发货

60、已签收

70、已完成

80、已退款

90、已关闭

发货条件delivery_termInt4y发货条件:1、款到发货 2、货到付款(包含部分货到付款)

3、分期付款

货品数量numDecimal(19,4)
y货品数量
销售单价priceDecimal(19,4)
y销售单价,手工新建时使用货品属性中的“零售价”
售后退款数量refund_numDecimal(19,4)
y售后退款数量
成交价order_priceDecimal(19,4)
y成交价,原始单折扣及分摊之后的价格
调整后价格share_priceDecimal(19,4)
y进入ERP后再次调整的价格,默认值与order_price一致
手工调整价adjustDecimal(19,4)
y手工调整价,正数为加价,负数为减价,暂未处理
总折扣金额discountDecimal(19,4)
y总折扣金额
分摊后合计应收share_amountDecimal(19,4)
y分摊后合计应收=share_price*num
税率tax_rateDecimal(19,4)
y税率
货品名称goods_nameString255y货品名称
货品编码goods_noString40y货品编码
规格名spec_nameString100y规格名
商家编码spec_noString40y商家编码
规格码spec_codeString40y规格码
组合装商家编码suite_noString40y组合装商家编码
组合装名称suite_nameString255y如果是组合装拆分的,此为组合装名称
组合装数量suite_numDecimal(19,4)
y组合装数量,不受拆分合并影响
组合装分摊后总价suite_amountDecimal(19,4)
y组合装分摊后总价
组合装优惠suite_discount Decimal(19,4)
y组合装优惠
平台货品名称api_goods_nameString255y平台货品名称
平台规格名api_spec_nameString100y平台规格名
平台货品idapi_goods_idString40Y平台货品id
平台规格idapi_spec_idString40Y平台规格id
佣金commissionDecimal(19,4)
y佣金
货品类型goods_typeInt4y

货品类

1销售商品 

2原材料

3包装

4周转材料

5虚拟商品

6固定资产 

0其它

订单内部来源from_maskInt11y订单内部来源: 1、手机

2、聚划算

子单备注remarkString255y子单备注
修改时间modifiedString40y修改时间
创建时间createdString40y创建时间
自定义属性2prop2String255y自定义属性2
子单预估总重量weightDecimal(19,4)
y子单预估总重量
图片路径img_urlString255y图片路径

5.请求示例

JSON

[{
"start_time": "2020-01-01 00:00:00",
"end_time": "2020-01-20 00:00:00"
}]
PHP
<?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
require_once('wdtsdk.php');
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret");
 
$parMap = new stdClass();
$parMap->start_time = "2020-01-01 00:00:00";
$parMap->end_time = "2020-01-20 00:00:00";
 
$pager = new Pager(1, 0, true);
 
$response = $client->pageCall("sales.TradeQuery.queryWithDetail", $pager, $parMap);
 
?>
JAVA

C#

6.响应示  

 6.1 正常响应示例 

JSON
{
	"status": 0,
	"data": {
		"total_count": 211,
		"order": [{
			"logistics_name": "other",
			"warehouse_type": 1,
			"fenxiao_nick": "",
			"post_amount": 0.0000,
			"trade_time": 1584433067000,
			"receiver_ring": "",
			"raw_goods_type_count": 1,
			"remark_flag": 0,
			"receiver_dtb": "西安市 新城区",
			"detail_list": [{
				"platform_id": 0,
				"src_oid": "AD202003170001",
				"src_tid": "43434343246",
				"gift_type": 0,
				"refund_status": 0,
				"guarantee_mode": 2,
				"delivery_term": 1,
				"num": 1.0000,
				"price": 39.8000,
				"refund_num": 0.0000,
				"order_price": 100.0000,
				"share_price": 100.0000,
				"adjust": 0.0000,
				"discount": -60.2000,
				"share_amount": 100.0000,
				"goods_name": "傲游猫-整理箱认知书(4册)-哇哦!好好玩",
				"tax_rate": 0.0000,
				"goods_no": "001.01.1307",
				"spec_name": "傲游猫-整理箱认知书(4册)-哇哦!好好玩",
				"spec_no": "9787545061963",
				"spec_code": "本",
				"suite_no": "",
				"suite_name": "",
				"suite_num": 0.0000,
				"suite_amount": 0.0000,
				"suite_discount": 0.0000,
				"api_goods_name": "",
				"api_spec_name": "",
				"api_goods_id": "",
				"api_spec_id": "",
				"commission": 0.0000,
				"goods_type": 1,
				"from_mask": 268566528,
				"remark": "",
				"modified": 1584433242000,
				"img_url": "",
				"created": 1584433084000,
				"prop2": "null",
				"weight": 0.0000
			}],
			"bad_reason": 0,
			"print_remark": "",
			"discount": -60.2000,
			"other_amount": 0.0000,
			"pay_account": "",
			"tax_rate": 0.0000,
			"raw_goods_count": 1.0000,
			"to_deliver_time": "",
			"fchecker_name": "系统",
			"shop_remark": "",
			"invoice_id": 0,
			"modified": "2020-01-01 00:00:00",
			"shop_no": "qzmw",
			"checker_name": "zmz",
			"receiver_area": "陕西省 西安市 新城区",
			"customer_no": "KH201905080127",
			"refund_status": 0,
			"receiver_province": 610000,
			"buyer_message": "",
			"created": 1584433084000,
			"weight": 0.0000,
			"tax": 0.0000,
			"logistics_code": "otherone",
			"shop_name": "qzmw测试店",
			"pay_time": "2020-03-17 16:17:47",
			"src_tids": "",
			"checkouter_name": "系统",
			"trade_no": "ORDER2003170007",
			"id_card_type": 0,
			"freeze_reason": 0,
			"single_spec_no": "9787545061963",
			"salesman_name": "zmz",
			"receiver_city": 610100,
			"invoice_title": "",
			"goods_type_count": 1,
			"goods_count": 1.0000,
			"cod_amount": 0.0000,
			"flag_name": "无",
			"receiver_telno": "",
			"receiver_zip": "",
			"warehouse_no": "08",
			"invoice_content": "",
			"trade_status": 55,
			"post_cost": 0.0000,
			"receiver_name": "测试4",
			"commission": 0.0000,
			"invoice_type": 0,
			"currency": "",
			"profit": 100.0000,
			"trade_from": 4,
			"delivery_term": 1,
			"logistics_no": "e865654654",
			"goods_amount": 39.8000,
			"goods_cost": 0.0000,
			"receiver_district": 610102,
			"stockout_no": "CKDH202003174",
			"receivable": 100.0000,
			"version_id": 3,
			"receiver_mobile": "13186011990",
			"buyer_nick": "测试4",
			"fenxiao_type": 0,
			"cs_remark": "",
			"platform_id": 0,
			"trade_type": 2,
			"receiver_address": "陕西省西安市新城区长乐大厦004",
			"logistics_type_name": "其他",
			"ext_cod_fee": 0.0000,
			"customer_name": "测试4"
		}]
	}
}

   6.2 异常响应示例

JSON
{
"status": 100,
"message": "参数中必须包含起止时间"
}



常用工具