当前位置: API文档

 sales.RawTrade.search(原始单查询)

¥标准

1.接口说明

1.1 接口描:获取ERP原始订单信息
1.2 适用版本:客户端 V1.2.7.3及以上版本
1.3 增量获取:支持
1.4 时间跨度:start_time和end_time最大跨度为30天。

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

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

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


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

字段描述字段名
买家昵称buyer_nick
邮箱buyer_email
买家姓名buyer_name
买家支付账号pay_account
收件人姓名receiver_name
收件地址receiver_address
收件人手机receiver_mobile
收件人电话
receiver_telno

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

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

start_time

String

40n修改起始时间
结束时间end_timeString40n修改结束时间
店铺编号

shop_no

String20n店铺编号

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




唯一键rec_idInt20
y唯一键
平台IDplatform_idInt6
y
平台ID(请点击平台代码表查看对应关系
原始单号tidString
40y

原始单号


店铺id
shop_idInt
6y店铺id
店铺编号shop_noString20y店铺编号
处理状态process_status
Int4y

10:待递交

15:部分发货待递交

20:已递交

30:部分发货

40:已发货

60:已完成

70:已取消

平台状态trade_statusInt4y10:未确认

20:待尾款

30:待发货

40:部分发货

50:已发货

60:已签收

70:已完成

80:已退款

90:已关闭

支付状态pay_statusInt4y

0:未付款

1:部分付款

2:已付款

支付方式pay_methodInt4y1:在线转账

2:现金

3:银行转账

4:邮局汇款

5:预付款

6:刷卡

退款状态
refund_statusInt4y0:无退款

1:取消退款

2:已申请退款

3:等待退货

4:等待收货

5:退款成功

6:未付款关闭

递交失败原因bad_reasonString
y递交失败原因
子单数量
order_count

BigDecimal(19,4)


y子单数量
货品数量goods_count
BigDecimal(19,4)
y货品数量
下单时间
trade_time
String 40y下单时间
支付时间pay_timeString40y支付时间
交易结束时间
end_timeString 40y交易结束时间
买家留言buyer_messageString1024y买家留言
客服备注
remarkString 1024
y客服备注
买家昵称
buyer_nick String100y 买家昵称
邮箱
buyer_email
String 100y邮箱
买家姓名
buyer_nameString100
y买家姓名
买家区域
buyer_areaString 100y买家区域
平台支付单号
pay_id
String
40y平台支付单号
买家支付账号
pay_accountString 128y买家支付账号
收件人姓名
receiver_name
String100y收件人姓名
收件人国家receiver_countryInt6y见城市代码表
收件人省份
receiver_provinceInt11y见城市代码表

receiver_city
Int11y见城市代码表

receiver_district
Int11y见城市代码表
收件地址receiver_addressString
255
y收件地址
收件人手机receiver_mobile
String40y收件人手机
收件人电话
receiver_telnoString
100y收件人电话
收件人省市区receiver_areaString
128y收件人省市区
区域(京东几环)
receiver_ringString20y区域(京东几环)
送货时间
to_deliver_time
String 20y送货时间
货款
goods_amount
BigDecimal(19,4)
y货款
邮费post_amount
BigDecimal(19,4)
y邮费
其他收费
other_amountBigDecimal(19,4)
y其他收费
优惠discount
BigDecimal(19,4)
y优惠
应收
receivableBigDecimal(19,4)
y应收
买家已付金额
paidBigDecimal(19,4)
y买家已付金额
平台费用
platform_costBigDecimal(19,4)
y平台费用
自流转仓库编号warehouse_noString20y自流转仓库编号
是否自流转

is_auto_wms

bool
y是否自流转
最后修改时间
modifiedString40y最后修改时间
创建时间
createdString 40y创建时间
原始单明细
trade_orders

List<Map<String, Object>>


y原始单明细
trade_orders




系统原始单明细idrec_idInt
20y系统原始单明细id
原始单号tidString 40
y原始单号
原始子单号
oidString 
40y原始子单号 
平台id
platform_idInt6y平台id
状态statusInt4y10:未确认

20:待尾款

30:待发货

40:部分发货

50:已发货

60:已签收

70:已完成

80:已退款

90:已关闭

处理状态
process_statusInt 4y

10:待递交

15:部分发货待递交

20:已递交

30:部分发货

40:已发货

60:已完成

70:已取消

退款状态
refund_statusInt4y0:无退款

1:取消退款

2:已申请退款

3:等待退货

4:等待收货

5:退款成功

6:未付款关闭

平台货品名称
goods_nameString 255y平台货品名称
平台货品编号
goods_noString 40y平台货品编号
平台货品id
goods_idString40y平台货品id
平台规格编码spec_noString40y平台规格编码
平台规格名称
spec_nameString255y平台规格名称
平台规格id
spec_idString40y平台规格id
数量numDecimal(19,4)
y数量
单价
priceDecimal(19,4)
y单价
优惠
discountDecimal(19,4)
y优惠
调整
adjust_amountDecimal(19,4)
y调整 
分摊优惠
share_discount
Decimal(19,4)
y分摊优惠
总价
total_amountDecimal(19,4)
y总价
分摊后金额
share_amount
Decimal(19,4)
y分摊后金额
退款金额
refund_amountDecimal(19,4)
y退款金额
备注
remarkString255y备注
最后变更时间
modified
String40y最后变更时间
创建时间createdString40y创建时间

5.请求示例

JSON

[{"tid":"TID-TgKngjNFhj"}]
PHP
<?php
include 'wdtsdk.php';
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret")
 
$parMap = new stdClass();
$parMap->tid = 'TID-TgKngjNFhj';
 
$pager = new Pager(2, 0, true);
 
try {
    $data = $client->pageCall("sales.RawTrade.search", $pager, $parMap);
}catch(WdtErpException $e)
{
    echo $e->getMessage();
}
?>
JAVA
C#

6.响应示  

 6.1 正常响应示例 

JSON
{
"status": 0,
"data": {
"total_count": 1,
"order": [
{
"buyer_area": "xxxxxx",
"post_amount": 10.0000,
"trade_time": "2019-06-25 18:17:00",
"receiver_ring": "",
"bad_reason": "无货品记录",
"buye r_name": "",
"discount": 0.0000,
"other_amount": 0.0000,
"pay_account": "",
"tid": "TID-TgKngjNFhj",
"to_deliver_time": "",
"platform_cost": 0.0000,
"modified": "2021-04-08 05:44:28",
"receiver_countr y": 0,
"shop_no": "POS",
"buyer_email": "",
"receiver_area": "北京 北京市 海淀区",
"refund_status": 0,
"buyer_message": "买家留言言O(∩_∩)O",
"receiver_province": 110000,
"created": "2021-04-06 16:5 0:16",
"trade_orders": [
{
"rec_id": 18988,
"tid": "TID-TgKngjNFhj",
"oid": "d396d00a36d2",
"platform_id": 127,
"status": 30,
"process_status": 10,
"refund_status": 0,
"goods_name": "笔记本 新品 测试勿拍 ",
"goods_no": "notebook",
"goods_id": "578208424251",
"spec_no": "nb-yellow",
"spec_name": "颜色分类:黄色",
"spec_id": "3830638324377",
"num": 6.0000,
"price": 1.0000,
"discount": 0.0000,
"adjust_amou nt": 0.0000,
"share_discount": 0.0000,
"total_amount": 6.0000,
"share_amount": 50.0000,
"refund_amount": 0.0000,
"remark": "",
"modified": "2021-04-08 05:44:28",
"created": "2021-04-06 16:50:17"
}
],
"s hop_platform_id": 127,
"pay_time": "2019-06-25 18:18:10",
"shop_id": 20,
"is_auto_wms": false,
"process_status": 10,
"pay_id": "",
"receiver_city": 110100,
"remark": "",
"sub_platform_id": 0,
"goods_cou nt": 6.0000,
"pay_status": 2,
"receiver_telno": "+86-1234567",
"warehouse_no": "",
"trade_status": 30,
"receiver_name": "网名名O(∩_∩)O",
"order_count": 1,
"goods_amount": 50.0000,
"receiver_district ": 110108,
"pay_method": 1,
"receivable": 16.0000,
"rec_id": 119162,
"receiver_mobile": "15265500816",
"buyer_nick": "买家昵称称O(∩_∩)O",
"platform_id": 127,
"paid": 0.0000,
"receiver_address": "详细 地址址O(∩_∩)O"
}
]
}
}

   6.2 异常响应示例

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



常用工具