当前位置： API文档

 sales.RawTrade.search（原始单查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP原始订单信息
1.2 适用版本：客户端 V1.5.3.9及以上版本
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店铺编号（暂不支持批量查询）
是否使用从库查询

is_slave

boolean1n

使用:true  不使用:false

(仅对开通从库配置客户生效)

优惠明细掩码


detail_mask

Int
1n

默认为0，

1：返回优惠明细

0：不返回优惠明细

pager

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

page_size

Int4n

分页大小（单量较大的卖家，page_size建议200以下）

页号

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:刷卡

7:支付宝
8:微信支付

退款状态
refund_statusInt4y

0无退款

1申请退款 

2部分退款 

3全部退款

递交失败原因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应收
已收receivedBigDecimal(19,4)
y已从平台收款金额
买家已付金额
paidBigDecimal(19,4)
y买家已付金额
平台费用
platform_costBigDecimal(19,4)
y平台费用
外部仓库编号warehouse_noString20y外部仓库编号
是否自流转

is_auto_wms

bool
y是否自流转
最后修改时间
modifiedString40y最后修改时间
给消费者开票金额consumer_amountBigDecimal(19,4)
y给消费者开票金额，数值来源于订单平台，若平台未传递给旺店通对应的值，该字段不返回
给平台开票金额platform_amountBigDecimal(19,4)
y给平台开票金额，数值来源于订单平台，若平台未传递给旺店通对应的值，该字段不返回
创建时间
createdString 40y创建时间
发货条件
delivery_termInt4
y发货条件

1:款到发货 2:货到付款(包含部分货到付款) 3:分期付款

担保方式
guarantee_modeInt
4
y担保方式

1:担保交易 2:非担保交易 3:非担保在线交易（ecshop）

币种
currencyString 
y币种
子平台id
sub_platform_idInt
y子平台id
店铺平台id
shop_platform_idInt
y店铺平台id
分销昵称
fenxiao_nickString
40
y分销昵称
抓单返回的平台订单的最后修改时间
pre_charge_timeString
20
y抓单返回的平台订单的最后修改时间
收件人邮编
receiver_zipString
20
y收件人邮编
退款金额
refund_amountBigDecimal(19,4)

y退款金额
订单来源
trade_frombyte

y

订单来源

1：api抓单

2：手工建单

6：补发订单

7：PDA选货开单

分销类型
fenxiao_typebyte

y

分销类型

2：拼多多分销待打

标旗
remark_flagInt
4
y

标旗

0：无

1：红

2：黄

3：绿

4：蓝

5：紫

原始单明细
trade_orders

List<Map<String, Object>>


y原始单明细
优惠明细

discount_list

List<Map<String, Object>>


y

优惠明细, 不存在金额明细时金额明细为空数组

trade_orders

名称字段类型长度
必须描述
系统原始单明细idrec_idInt
20y系统原始单明细id
原始单号tidString 40
y原始单号
原始子单号
oidString 
40y原始子单号 
退款单编号
refund_idString 
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
平台规格码
spec_codeString40y平台规格码
数量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创建时间
子单完成时间end_timeString40y

子单完成时间

仓库编号
warehouse_noString
40
y仓库编号|前N有礼活动ID
货品类型
order_typebyte

y

货品类型

0：正常货品

1：虚拟货品

2：服务

物流单号
logistics_noString
40
y发货后物流单号
佣金
commissionDecimal(19,4)
y

佣金

平台类目
cidString
40
y平台类目
bind_oidbind_oidString
40
ybind_oid

discount_list

名称字段类型长度
必须描述
优惠明细id
rec_idInt6y优惠明细id
原始单号
tidString40
y原始单号
原始子单号
oidString40
y原始子单号
平台id
platform_idInt
y平台id
优惠名称nameString
50y
优惠名称
详情
detail
String
128
y详情
金额
amountDecimal(19,4)
y
金额
类型typeString
60
y

对应平台上的优惠id

是否优惠券
is_bonusInt4y

是否优惠券

0：否
1：是

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": "",
                "post_amount": 0,
                "fenxiao_nick": "",
                "trade_time": "2024-08-21 00:00:00",
                "receiver_ring": "",
                "remark_flag": 0,
                "bad_reason": "",
                "buyer_name": "",
                "discount": 0,
                "other_amount": 0,
                "pay_account": "",
                "tid": "20240821006",
                "to_deliver_time": "",
                "platform_cost": 0,
                "modified": "2024-08-21 15:34:12",
                "receiver_country": 0,
                "pre_charge_time": "",
                "shop_no": "wdtapi3-test",
                "buyer_email": "",
                "receiver_area": "天津 天津市 滨海新区",
                "refund_status": 0,
                "buyer_message": "",
                "receiver_province": 120000,
                "created": "2024-08-21 15:34:10",
                "received": 0,
                "trade_orders": [
                    {
                        "rec_id": 8081413,
                        "tid": "20240821006",
                        "oid": "20240821006",
                        "platform_id": 127,
                        "status": 30,
                        "process_status": 20,
                        "refund_status": 0,
                        "goods_name": "wangdiantong",
                        "goods_no": "wangdiantong",
                        "goods_id": "wangdiantong",
                        "spec_no": "wangdiantong",
                        "spec_name": "",
                        "spec_id": "wangdiantong",
                        "spec_code": "",
                        "num": 10,
                        "price": 10,
                        "discount": 0,
                        "adjust_amount": 0,
                        "share_discount": 0,
                        "total_amount": 100,
                        "share_amount": 100,
                        "refund_amount": 0,
                        "remark": "",
                        "warehouse_no": "",
                        "refund_id": "",
                        "order_type": 0,
                        "logistics_no": "",
                        "commission": 0,
                        "cid": "",
                        "bind_oid": "",
                        "modified": "2024-08-21 15:34:12",
                        "created": "2024-08-21 15:34:10",
                        "end_time": ""
                    }
                ],
                "shop_platform_id": 127,
                "pay_time": "",
                "shop_id": 290,
                "is_auto_wms": false,
                "process_status": 20,
                "pay_id": "",
                "receiver_city": 120100,
                "remark": "",
                "sub_platform_id": 0,
                "goods_count": 10,
                "discount_list": [],
                "pay_status": 2,
                "receiver_telno": "",
                "warehouse_no": "",
                "receiver_zip": "",
                "trade_status": 30,
                "receiver_name": "aaa",
                "refund_amount": 0,
                "currency": "",
                "guarantee_mode": 1,
                "trade_from": 1,
                "order_count": 1,
                "delivery_term": 1,
                "goods_amount": 100,
                "receiver_district": 120116,
                "end_time": "",
                "pay_method": 1,
                "receivable": 100,
                "rec_id": 5765719,
                "receiver_mobile": "11111111111",
                "buyer_nick": "aaa",
                "fenxiao_type": 0,
                "platform_id": 127,
                "paid": 0,
                "receiver_address": "1"
            }
        ]
    }
}

   6.2 异常响应示例

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



常用工具