当前位置: API文档
sales.RawTrade.searchSelfOrder(原始单查询--仅返回自有平台、线下平台订单)
1.接口说明
| 1.1 接口描述:获取ERP自有平台及线下平台的原始订单信息 |
| 1.2 适用版本:客户端 V1.5.9.2及以上版本 |
| 1.3 增量获取:支持 |
| 1.4 时间跨度:start_time和end_time最大跨度为30天。 |
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
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 原始单号 | tid | String | 40 | n | 原始单号 |
| 开始时间 | start_time | String | 40 | n | 修改起始时间 |
| 结束时间 | end_time | String | 40 | n | 修改结束时间 |
| 店铺编号 | shop_no | String | 20 | n | 店铺编号(暂不支持批量查询) |
| 是否使用从库查询 | is_slave | boolean | 1 | n | 使用:true 不使用:false (仅对开通从库配置客户生效) |
| 优惠明细掩码 | detail_mask | Int | 1 | n | 默认为0, 1:返回优惠明细 0:不返回优惠明细 |
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
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 唯一键 | rec_id | Int | 20 | y | 唯一键 |
| 平台ID | platform_id | Int | 6 | y | 平台ID(请点击平台代码表查看对应关系) |
| 原始单号 | tid | String | 40 | y | 原始单号 |
| 店铺id | shop_id | Int | 6 | y | 店铺id |
| 店铺编号 | shop_no | String | 20 | y | 店铺编号 |
| 系统状态 | process_status | Int | 4 | y | 10:待递交 15:部分发货待递交 20:已递交 30:部分发货 40:已发货 60:已完成 70:已取消 |
| 平台状态 | trade_status | Int | 4 | y | 10:未确认 20:待尾款 30:待发货 40:部分发货 50:已发货 60:已签收 70:已完成 80:已退款 90:已关闭 |
| 支付状态 | pay_status | Int | 4 | y | 0:未付款 1:部分付款 2:已付款 |
| 支付方式 | pay_method | Int | 4 | y | 1:在线转账 2:现金 3:银行转账 4:邮局汇款 5:预付款 6:刷卡 7:支付宝 |
| 退款状态 | refund_status | Int | 4 | y | 0无退款 1申请退款 2部分退款 3全部退款 |
| 递交失败原因 | bad_reason | String | y | 递交失败原因 | |
| 子单数量 | order_count | BigDecimal(19,4) | y | 子单数量 | |
| 货品数量 | goods_count | BigDecimal(19,4) | y | 货品数量 | |
| 下单时间 | trade_time | String | 40 | y | 下单时间 |
| 支付时间 | pay_time | String | 40 | y | 支付时间 |
| 结束时间 | end_time | String | 40 | y | 结束时间 |
| 买家留言 | buyer_message | String | 1024 | y | 买家留言 |
| 客服备注 | remark | String | 1024 | y | 客服备注 |
| 客户网名 | buyer_nick | String | 100 | y | 客户网名 |
| 邮箱 | buyer_email | String | 100 | y | 邮箱 |
| 买家姓名 | buyer_name | String | 100 | y | 买家姓名 |
| 买家区域 | buyer_area | String | 100 | y | 买家区域 |
| 平台支付单号 | pay_id | String | 40 | y | 平台支付单号 |
| 买家支付账号 | pay_account | String | 128 | y | 买家支付账号 |
| 收件人姓名 | receiver_name | String | 100 | y | 收件人姓名 |
| 收件人国家 | receiver_country | Int | 6 | y | 收件人国家 |
| 收件人省份 | receiver_province | Int | 11 | y | 见城市代码表 |
| 市 | receiver_city | Int | 11 | y | 见城市代码表 |
| 区 | receiver_district | Int | 11 | y | 见城市代码表 |
| 收件人地址 | receiver_address | String | 255 | y | 收件人地址 |
| 收件人手机 | receiver_mobile | String | 40 | y | 收件人手机 |
| 收件人电话 | receiver_telno | String | 100 | y | 收件人电话 |
| 收件人省市区 | receiver_area | String | 128 | y | 收件人省市区 |
| 区域(京东几环) | receiver_ring | String | 20 | y | 区域(京东几环) |
| 送货时间 | to_deliver_time | String | 20 | y | 送货时间 |
| 货款 | goods_amount | BigDecimal(19,4) | y | 货款 | |
| 邮费 | post_amount | BigDecimal(19,4) | y | 邮费 | |
| 其他收费 | other_amount | BigDecimal(19,4) | y | 其他收费 | |
| 优惠 | discount | BigDecimal(19,4) | y | 优惠 | |
| 应收 | receivable | BigDecimal(19,4) | y | 应收 | |
| 已收 | received | BigDecimal(19,4) | y | 已从平台收款金额 | |
| 买家已付金额 | paid | BigDecimal(19,4) | y | 买家已付金额 | |
| 平台费用 | platform_cost | BigDecimal(19,4) | y | 平台费用 | |
| 外部仓库编号 | warehouse_no | String | 20 | y | 外部仓库编号 |
| 是否自流转 | is_auto_wms | bool | y | 是否自流转 | |
| 最后修改时间 | modified | String | 40 | y | 最后修改时间 |
| 给消费者开票金额 | consumer_amount | BigDecimal(19,4) | y | 给消费者开票金额,数值来源于订单平台,若平台未传递给旺店通对应的值,该字段不返回 客户端名称: 消费者实付金额 | |
| 给平台开票金额 | platform_amount | BigDecimal(19,4) | y | 给平台开票金额,数值来源于订单平台,若平台未传递给旺店通对应的值,该字段不返回 客户端名称: 平台承担优惠金额 | |
| 创建时间 | created | String | 40 | y | 创建时间 |
| 发货条件 | delivery_term | Int | 4 | y | 发货条件 1:款到发货 2:货到付款(包含部分货到付款) 3:分期付款 |
| 担保方式 | guarantee_mode | Int | 4 | y | 担保方式 1:担保交易 2:非担保交易 3:非担保在线交易(ecshop) |
| 币种 | currency | String | y | 币种 | |
| 子平台id | sub_platform_id | Int | y | 子平台id | |
| 店铺平台id | shop_platform_id | Int | y | 店铺平台id | |
| 分销昵称 | fenxiao_nick | String | 40 | y | 分销昵称 |
| 抓单返回的平台订单的最后修改时间 | pre_charge_time | String | 20 | y | 抓单返回的平台订单的最后修改时间 |
| 收件人邮编 | receiver_zip | String | 20 | y | 收件人邮编 |
| 退款金额 | refund_amount | BigDecimal(19,4) | y | 退款金额 | |
| 订单来源 | trade_from | byte | y | 订单来源 1:api抓单 2:手工建单 6:补发订单 7:PDA选货开单 | |
| 分销类型 | fenxiao_type | byte | y | 分销类型 2:拼多多分销待打 | |
| 标旗 | remark_flag | Int | 4 | y | 标旗 0:无 1:红 2:黄 3:绿 4:蓝 5:紫 6:橙 7:浅蓝 8:浅粉 9:深绿 10:桃红 |
| 国补订单标识 | platform_label | String | 国补订单标识 | ||
| 京东sendpay | reserve_field1 | String | 京东sendpay | ||
| 外部单号 | outer_no | String | 40 | 外部单号 | |
| 原始单明细 | trade_orders | List<Map<String, Object>> | y | 原始单明细 | |
| 优惠明细 | discount_list | List<Map<String, Object>> | y | 优惠明细, 不存在金额明细时金额明细为空数组 |
trade_orders
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 系统原始单明细id | rec_id | Int | 20 | y | 系统原始单明细id |
| 原始单号 | tid | String | 40 | y | 原始单号 |
| 原始子单号 | oid | String | 40 | y | 原始子单号 |
| 退款单编号 | refund_id | String | 40 | y | 退款单编号 |
| 平台id | platform_id | Int | 6 | y | 平台id |
| 状态 | status | Int | 4 | y | 10:未确认 20:待尾款 30:待发货 40:部分发货 50:已发货 60:已签收 70:已完成 80:已退款 90:已关闭 |
| 处理状态 | process_status | Int | 4 | y | 10:待递交 15:部分发货待递交 20:已递交 30:部分发货 40:已发货 60:已完成 70:已取消 |
| 退款状态 | refund_status | Int | 4 | y | 0:无退款 1:取消退款 2:已申请退款 3:等待退货 4:等待收货 5:退款成功 6:未付款关闭 |
| 平台货品名称 | goods_name | String | 255 | y | 平台货品名称 |
| 平台货品编号 | goods_no | String | 40 | y | 平台货品编号 |
| 平台货品id | goods_id | String | 40 | y | 平台货品id |
| 平台规格编码 | spec_no | String | 40 | y | 平台规格编码 |
| 平台规格名称 | spec_name | String | 255 | y | 平台规格名称 |
| 平台规格id | spec_id | String | 40 | y | 平台规格id |
| 平台规格码 | spec_code | String | 40 | y | 平台规格码 |
| 数量 | num | Decimal(19,4) | y | 数量 | |
| 单价 | price | Decimal(19,4) | y | 单价 | |
| 优惠 | discount | Decimal(19,4) | y | 优惠 | |
| 调整 | adjust_amount | Decimal(19,4) | y | 调整 | |
| 分摊优惠 | share_discount | Decimal(19,4) | y | 分摊优惠 | |
| 总价 | total_amount | Decimal(19,4) | y | 总价 | |
| 分摊后应收 | share_amount | Decimal(19,4) | y | 分摊后应收 | |
| 退款金额 | refund_amount | Decimal(19,4) | y | 退款金额 | |
| 备注 | remark | String | 255 | y | 备注 |
| 最后变更时间 | modified | String | 40 | y | 最后变更时间 |
| 创建时间 | created | String | 40 | y | 创建时间 |
| 子单完成时间 | end_time | String | 40 | y | 子单完成时间 |
| 仓库编号 | warehouse_no | String | 40 | y | 仓库编号|前N有礼活动ID |
| 货品类型 | order_type | byte | y | 货品类型 0:正常货品 1:虚拟货品 2:服务 | |
| 物流单号 | logistics_no | String | 40 | y | 发货后物流单号 |
| 佣金 | commission | Decimal(19,4) | y | 佣金 | |
| 平台类目 | cid | String | 40 | y | 平台类目 |
| bind_oid | bind_oid | String | 40 | y | bind_oid |
discount_list
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 优惠明细id | rec_id | Int | 6 | y | 优惠明细id |
| 原始单号 | tid | String | 40 | y | 原始单号 |
| 原始子单号 | oid | String | 40 | y | 原始子单号 |
| 平台id | platform_id | Int | y | 平台id | |
| 优惠名称 | name | String | 50 | y | 优惠名称 |
| 详情 | detail | String | 128 | y | 详情 |
| 金额 | amount | Decimal(19,4) | y | 金额 | |
| 类型 | type | String | 60 | y | 对应平台上的优惠id |
| 是否优惠券 | is_bonus | Int | 4 | y | 是否优惠券 0:否 |
5.请求示例
[{"tid":"TID-TgKngjNFhj"}] | |
<?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.searchSelfOrder", $pager, $parMap);
}catch(WdtErpException $e)
{
echo $e->getMessage();
}
?> | |
| JAVA | |
| C# |
6.响应示例
6.1 正常响应示例
{
"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 异常响应示例
{"status":100,"message":"您的查询时间过宽,查询时间不能大于30天"} |