API文档

sales.TradeQuery.queryHistorySelfOrderWithDetail（历史订单查询--仅返回自有平台、线下平台订单）

¥标准

1.接口说明

1.1 接口描述：获取ERP自有平台及线下的历史销售订单信息

1.2 适用版本：客户端 V1.5.6.6及以上版本

1.3 增量获取：支持

1.4 时间跨度：start_time和end_time最大跨度为60分钟。

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

仅返回自有平台、线下平台订单信息

2.调用场景

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

3.请求参数说明

3.1 请求地址

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

3.2 公共请求参数

名称	字段	类型	必须	描述
卖家账号	sid	String	是	卖家账号, 由旺店通分配
接口账号	key	String	是	由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里
盐	salt	String	是	由旺店通分配appsecret，是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称	method	String	是	调用的接口名称
版本号	v	String	是	1.0
秒级时间戳	timestamp	int	是	秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名	sign	String	是	签名
分页大小	page_size	int	否	分页大小，分页查询必传
分页编号	page_no	int	否	分页编号，分页查询必传，标准接口page_no从0开始
是否计算查询结果的总条数	calc_total	int	否	是否计算查询结果的总条数, 需要计算则1, 否则填0

3.3 业务请求参数

名称	字段	类型	长度	必须	描述
查询参数	params	Map<String, Object>		y	查询参数
分页	pager	Pager		y	分页

params

名称	字段	类型	长度	必须	描述
开始时间	start_time	String	40	y	修改起始时间，若无订单号，则为必填。
结束时间	end_time	String	40	y	修改结束时间，上同开始时间
仓库编号	warehouse_no	String	40	n	仓库编号
订单状态	status	String	255	n	若多个状态则以“，”隔开。订单状态: 4 线下退款 5已取消 6 待转预订单(待审核) 7 待转已完成 10未付款 12待尾款 15等未付 16延时审核 19预订单前处理 20 审核前处理 21自流转待发货 23 异常预订单 24 换货预订单 25 待处理预订单 27待分配预订单 30待客审 35待财审 55已审核 95已发货 96 成本确认（待录入计划成本，订单结算时有货品无计划成本） 101 已过账 110已完成
订单编号	trade_no	String	40	n	订单编号
店铺编号	shop_no	String	20	n	店铺编号
物流单号	logistics_no	String	40	n	物流单号
原始单号	src_tid	String	40	n	原始单号, 多个原始单号之间使用英文逗号分隔
是否使用从库查询	is_slave	boolean	1	n	使用：true 不使用：false (仅对开通从库配置客户生效)
是否需要查询分摊邮费	cal_share_post_amount	boolean	1	n	需要：true 不需要：false

pager

名称	字段	类型	长度	必须	描述
分页大小	page_size	Int	4	n	分页大小（单量较大的卖家，page_size建议200以下）
页号	page_no	Int	4	n	从0开始

4.响应参数

4.1 公共响应参数

名称	字段	类型	必须	描述
状态码	status	Int	y	状态码,0表示调用成功
错误信息	message	String	y	无错误信息不返回
单据数据	data	Map<String, Object>	y	单据数据

data

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

order

名称	字段	类型	长度	描述
订单唯一键	trade_id	long		订单唯一键
订单号	trade_no	String	40	订单号
平台ID	platform_id	Int	4	平台ID（请点击平台代码表查看对应关系）
仓库类型	warehouse_type	Int	4	仓库类型: 1、普通仓库,大于1为委外仓库(如京东仓储,物流宝等)
原始单号	src_tids	String	255	原始单号，如果有多个，以","分隔，且以增序排列,不重复,过长将被裁剪
平台支付帐号	pay_account	String	128	平台支付帐号
订单状态	trade_status	int	255	订单状态： 4 线下退款 5已取消 6 待转预订单(待审核) 7 待转已完成 10未付款 12待尾款 15等未付 16延时审核 19预订单前处理 20 审核前处理 21自流转待发货 23 异常预订单 24 换货预订单 25 待处理预订单 27待分配预订单 30待客审 35待财审 55已审核 95已发货 96 成本确认（待录入计划成本，订单结算时有货品无计划成本） 101 已过账 110已完成
订单类型	trade_type	Int	4	订单类型: 1、网店销售 2、线下订单 3、售后换货 4、批发业务 7、现款销售 8、分销 101、自定义类型一 102、自定义类型二 103、自定义类型三 104、自定义类型四 105、自定义类型五 106、自定义类型六
发货条件	delivery_term	Int	4	发货条件: 1、款到发货 2、货到付款(包含部分货到付款) 3、分期付款
冻结原因	freeze_reason	String	6	冻结原因
退款状态	refund_status	Int	4	退款状态: 0、无退款 1、申请退款 2、部分退款 3、全部退款
分销类别	fenxiao_type	Int	4	分销类别: 0、非分销订单 1、代销 2、经销
分销商昵称	fenxiao_nick	String	40	分销商昵称
下单时间	trade_time	String	40	下单时间（毫秒级时间戳，例如：1631861379000）
付款时间	pay_time	String	40	付款时间，例如：2020-01-19 17:48:12
发货时间	consign_time	String	40	发货时间（毫秒级时间戳，例如：1631861379000）
客户网名	buyer_nick	String	100	客户网名
收货人/收件人	receiver_name	String	100	收货人/收件人
省份id	receiver_province	Int	11	省份id，可参考城市代码表
城市id	receiver_city	Int	11	城市id，可参考城市代码表
地区id	receiver_district	Int	11	地区id，可参考城市代码表
地址	receiver_address	String	256	收件人地址
手机	receiver_mobile	String	40	手机
固话	receiver_telno	String	40	固话
邮编	receiver_zip	String	20	邮编
省市县	receiver_area	String	128	省市县
京东几环	receiver_ring	String	20	京东几环
大头笔	receiver_dtb	String	128	大头笔
送货时间	to_deliver_time	String	20	送货时间,例如：2020-10-19 00:00:00
异常订单原因	bad_reason	Int	11	异常订单原因（位运算）: 2、修改地址 4、修改发票 8、更换仓库 16、修改备注 32、更换货品 128、拦截赠品 256、拦截换货 512、买家留言变化 1024、拦截平台已发货
物流单号	logistics_no	String	40	物流单号
买家留言	buyer_message	String	1024	买家留言
客服备注	cs_remark	String	1024	客服备注
标旗	remark_flag	Int	4	标旗（1 红、2 黄、3 绿、4 蓝、5 紫）
打印备注	print_remark	String	1024	打印备注
货品种类数	goods_type_count	Decimal(19,4)		货品种类数
货品总量	goods_count	Decimal(19,4)		货品总量
货品总额	goods_amount	Decimal(19,4)		货品总额
邮资	post_amount	Decimal(19,4)		邮资（买家支付邮费）
其它费用	other_amount	Decimal(19,4)		其它费用
优惠	discount	Decimal(19,4)		优惠
应收金额	receivable	Decimal(19,4)		应收金额
COD金额	cod_amount	Decimal(19,4)		货到付款金额/COD金额
买家COD费用	ext_cod_fee	Decimal(19,4)		买家COD费用
预估货品成本	goods_cost	Decimal(19,4)		预估货品成本
预估邮资成本	post_cost	Decimal(19,4)		预估邮资成本
预估称重	weight	Decimal(19,4)		预估称重kg
预估毛利	profit	Decimal(19,4)		预估毛利
税额	tax	Decimal(19,4)		税额
税率	tax_rate	Decimal(19,4)		税率
佣金	commission	Decimal(19,4)		佣金
发票类别	invoice_type	Int	4	发票类别: 0、不需要 1、普通发票 2、普通增值税发票 3、专用增值税发票
发票抬头	invoice_title	String	1024	发票抬头
发票内容	invoice_content	String	1024	发票内容
业务员	salesman_name	String	40	业务员
审核人	checker_name	String	40	审核人
财审人	fchecker_name	String	40	财审人
签出人	checkouter_name	String	40	签出人
出库单号	stockout_no	String	40	出库单号（系统产生的出库单号）
标记名称	flag_name	String	32	标记名称
订单来源	trade_from	Int	4	订单来源: 1、API抓单 2、手工建单 3、导入 4、复制订单 5、接口推送 6、补发订单 7、PDA选货开单
货品商家编码	single_spec_no	String	40	单一货品商家编码,多种货品为空,组合装时为组合装编码
原始货品数量	raw_goods_count	Decimal(19,4)		原始货品数量
原始货品种类数	raw_goods_type_count	Int	6	原始货品种类数
币种	currency	String	20	币种
发票ID	invoice_id	Int	11	发票ID(自增生成)，0代表没有发票或已取消/已冲红
版本号	version_id	Int	6	版本号
修改时间	modified	String	40	修改时间，例如：2021-01-29 01:49:40
递交时间	created	String	40	递交时间（毫秒级时间戳，例如：1631861379000）
证件类别	id_card_type	Int	4	证件类别
店铺编号	shop_no	String	20	店铺编号
店铺名称	shop_name	String	128	店铺名称
店铺备注	shop_remark	String	255	店铺备注
仓库编号	warehouse_no	String	40	仓库编号
客户姓名	customer_name	String	40	客户姓名
客户编码	customer_no	String	40	客户编码
物流公司名称	logistics_name	String	40	物流公司名称
物流公司编号	logistics_code	String	60	物流公司编号
物流类型	logistics_type_name	String		物流类型
计划发货时间	delay_to_time	String	40	计划发货时间
订单标签	trade_label	String	40	订单标签
店铺id	shop_id	Int	11	店铺id
店铺平台id	shop_platform_id	Int	11	店铺平台id
子平台id	sub_platform_id	Int	11	子平台id
订单明细	detail_list	List<Map<String, Object>>		订单明细

detail_list

名称	字段	类型	长度	必须	描述
订单唯一键	trade_id	long		y	订单唯一键
订单明细唯一键	rec_id	long		y	订单明细唯一键
平台ID	platform_id	Int	4	y	平台ID
原始子单号	src_oid	String	40	y	原始子单号
原始单号	src_tid	String	40	y	原始单号
赠品方式	gift_type	Int	4	y	赠品方式 0、非赠品 1、自动赠送 2、手工赠送 4、周期购赠送 8、平台赠送
退款状态	refund_status	Int	4	y	退款状态: 0、无退款 1、已取消 2、已申请退款 3、待退款，平台已退款,系统未退款,但订单已审核,不能直接改成,除非驳回 4、等待取消,平台上取消退款,系统已退款,但订单已审核,不能直接改成,除非驳回 5、退款成功 6、未付款关闭，未付款的取消了
退款模式	guarantee_mode	Int	4	y	平台状态: 10、未确认 20、待尾款 30、待发货 40、部分发货 50、已发货 60、已签收 70、已完成 80、已退款 90、已关闭
子单平台状态	platform_status	Int	4	y	如果没有对应的原始单明细,则返回0. 平台状态: 10、未确认 20、待尾款 30、待发货 40、部分发货 50、已发货 60、已签收 70、已完成 80、已退款 90、已关闭
发货条件	delivery_term	Int	4	y	发货条件:1、款到发货 2、货到付款(包含部分货到付款) 3、分期付款
货品数量	num	Decimal(19,4)		y	货品数量
标价	price	Decimal(19,4)		y	标价，手工新建时使用货品属性中的“零售价”
售后退款数量	refund_num	Decimal(19,4)		y	售后退款数量
成交价	order_price	Decimal(19,4)		y	成交价,原始单折扣及分摊之后的价格
分摊后价格	share_price	Decimal(19,4)		y	分摊后价格,进入ERP后再次调整的价格，默认值与order_price一致
手工调整价	adjust	Decimal(19,4)		y	手工调整价,正数为加价,负数为减价,暂未处理
优惠	discount	Decimal(19,4)		y	优惠
分摊后总价	share_amount	Decimal(19,4)		y	分摊后总价=share_price*num
税率	tax_rate	Decimal(19,4)		y	税率
已支付金额	paid	Decimal(19,4)		y	已支付金额
货品名称	goods_name	String	255	y	货品名称
货品编号	goods_no	String	40	y	货品编号
规格名称	spec_name	String	100	y	规格名称
商家编码	spec_no	String	40	y	商家编码
规格码	spec_code	String	40	y	规格码
组合装编码	suite_no	String	40	y	组合装编码
组合装名称	suite_name	String	255	y	如果是组合装拆分的，此为组合装名称
组合装数量	suite_num	Decimal(19,4)		y	组合装数量,不受拆分合并影响
组合装分摊后总价	suite_amount	Decimal(19,4)		y	组合装分摊后总价
组合装优惠	suite_discount	Decimal(19,4)		y	组合装优惠
平台货品名称	api_goods_name	String	255	y	平台货品名称
平台规格名称	api_spec_name	String	100	y	平台规格名称
平台货品id	api_goods_id	String	40	Y	平台货品id
平台规格id	api_spec_id	String	40	Y	平台规格id
佣金	commission	Decimal(19,4)		y	佣金
货品类型	goods_type	Int	4	y	货品类型
订单内部来源	from_mask	Int	11	y	订单内部来源: 0：无来源 1：手机 2：聚划算 32：开具电子发票 2048：当日达 4096：次日达 8192：承诺时效 2097152：区域零售 4194304：拼多多厂家代打 8388608：周期购 1048576：预售单 33554432：前N有礼 524288：天猫物流升级 64：按需配送 256：承诺结构化/QIC 16384：商仓鸟配
子单备注	remark	String	255	y	子单备注
修改时间	modified	String	40	y	修改时间（毫秒级时间戳，例如：1631861379000）
创建时间	created	String		y	创建时间（毫秒级时间戳，例如：1631861379000）
自定义属性2	prop2	String	255	y	自定义属性2
货品重量	weight	Decimal(19,4)		y	货品重量（子单货品预估总重量）
图片路径	img_url	String	255	y	图片路径
分摊邮费	share_post_amount	Decimal(19,4)		y	非退款成功/非未付款取消的订单中，(分摊后合计/分摊后合计之和)/对应原始单的邮费之和,相同原始单邮费不累加

5.请求示例

JSON	[{"start_time":"2018-10-05 14:21:41","end_time":"2018-10-20 14:21:41"}]
PHP	<?php include 'wdtsdk.php'; $client = new WdtErpClient("url", "wdtapi3", "appkey", "secret") $pars = array ( 'start_time' => '2020-06-15 10:05:36', 'end_time' => '2020-06-17 11:05:36' ); $pager = new Pager(50, 0, true); $data = $client->pageCall("sales.TradeQuery.queryHistorySelfOrderWithDetail", $pager, $pars);//分页方法 $php_json = json_encode($data); echo $php_json; ?>
JAVA
C#

6.响应示例

6.1 正常响应示例

JSON

{
    "status": 0,
    "data": {
        "total_count": 1,
        "order": [
            {
                "logistics_name": "邮政123",
                "warehouse_type": 1,
                "fenxiao_nick": "",
                "consign_time": 1611821521000,
                "post_amount": 0.0000,
                "trade_time": 1611049692000,
                "receiver_ring": "",
                "raw_goods_type_count": 1,
                "remark_flag": 0,
                "receiver_dtb": "杭州市 江干区",
                "detail_list": [
                    {
                        "rec_id": 1045331,
                        "trade_id": 842375,
                        "platform_id": 0,
                        "src_oid": "AD202101190001",
                        "src_tid": "ZY202012240121",
                        "gift_type": 0,
                        "refund_status": 0,
                        "guarantee_mode": 2,
                        "delivery_term": 1,
                        "num": 1.0000,
                        "price": 0.0000,
                        "refund_num": 0.0000,
                        "order_price": 0.0000,
                        "share_price": 0.0000,
                        "adjust": 0.0000,
                        "discount": 0.0000,
                        "share_amount": 0.0000,
                        "paid": 0.0000,
                        "goods_name": "老爸推荐--检测合格304不锈钢儿童筷子(1双)",
                        "tax_rate": 0.0000,
                        "goods_no": "BC00000101",
                        "spec_name": "老爸推荐--检测合格304不锈钢儿童筷子(1双)",
                        "spec_no": "BC00000101",
                        "spec_code": "shuang",
                        "suite_no": "",
                        "suite_name": "",
                        "suite_num": 0.0000,
                        "suite_amount": 0.0000,
                        "suite_discount": 0.0000,
                        "api_goods_name": "老爸推荐--检测合格304不锈钢儿童筷子(1双)",
                        "api_spec_name": "老爸推荐--检测合格304不锈钢儿童筷子(1双)",
                        "commission": 0.0000,
                        "goods_type": 1,
                        "from_mask": 0,
                        "remark": "",
                        "modified": 1611821521000,
                        "img_url": "",
                        "platform_status": 0,
                        "created": 1611049724000,
                        "prop2": "",
                        "weight": 0.0000,
                        "api_goods_id": "",
                        "api_spec_id": ""
                    }
                ],
                "bad_reason": 0,
                "print_remark": "",
                "discount": 0.0000,
                "other_amount": 0.0000,
                "pay_account": "",
                "tax_rate": 0.0000,
                "raw_goods_count": 1.0000,
                "to_deliver_time": "",
                "fchecker_name": "系统",
                "trade_id": 842375,
                "trade_label": "",
                "shop_remark": "1",
                "invoice_id": 0,
                "modified": "2021-01-29 01:49:40",
                "shop_no": "wdtapi3-test",
                "checker_name": "admin",
                "receiver_area": "浙江省 杭州市 江干区",
                "customer_no": "KH202101150020",
                "refund_status": 0,
                "receiver_province": 330000,
                "buyer_message": "",
                "created": 1611049724000,
                "weight": 0.0000,
                "tax": 0.0000,
                "logistics_code": "wtt123",
                "shop_name": "wdtapi3-test",
                "shop_platform_id": 127,
                "pay_time": "2021-01-19 17:48:12",
                "src_tids": "ZY202012240121",
                "shop_id": 290,
                "checkouter_name": "系统",
                "trade_no": "ORDER202101190014",
                "id_card_type": 0,
                "freeze_reason": "无",
                "single_spec_no": "BC00000101",
                "salesman_name": "admin",
                "receiver_city": 330100,
                "invoice_title": "",
                "goods_type_count": 1,
                "sub_platform_id": 0,
                "goods_count": 1.0000,
                "cod_amount": 0.0000,
                "flag_name": "无",
                "receiver_telno": "",
                "receiver_zip": "",
                "warehouse_no": "wdtapi3-test",
                "invoice_content": "",
                "trade_status": 110,
                "post_cost": 0.0000,
                "receiver_name": "chend270",
                "commission": 0.0000,
                "invoice_type": 0,
                "currency": "",
                "profit": 0.0000,
                "trade_from": 2,
                "delivery_term": 1,
                "logistics_no": "765432342323232",
                "goods_amount": 0.0000,
                "goods_cost": 0.0000,
                "receiver_district": 330104,
                "stockout_no": "CKDH2021012820",
                "receivable": 0.0000,
                "version_id": 3,
                "receiver_mobile": "132222222228",
                "buyer_nick": "MO2",
                "fenxiao_type": 0,
                "cs_remark": "",
                "platform_id": 0,
                "trade_type": 2,
                "receiver_address": "绿谷",
                "logistics_type_name": "中国邮政",
                "ext_cod_fee": 0.0000,
                "customer_name": "chend270",
                "delay_to_time": ""
            }
        ]
    }
}

6.2 异常响应示例

JSON	{"status":100,"message":"您的查询时间过宽,查询时间不能大于60分钟"}