当前位置: API文档

sales.LogisticsSync.getSyncListExt(待同步列表查询)

¥标准

1.接口说明

1.1 接口描查询待同步物流列表
1.2 适用版本:客户端 V1.2.5.6及以上版本
1.3 增量获取:不支持

1.4 注意事项:【权限校验】:店铺权限(仅支持自有平台)

1.5常见场景处理:                  

1.5.1拆分发货:商城推送过来的是一个订单,但是因为实际情况需要(例:库存不足有货先发),在ERP系统拆分开了,分开发货。

①:商城订单只有一条货品明细,且货品数量>=2被拆分成多个系统订单的

  •   一个tid对应一个oid,num>=2,拆分后的多个系统订单tid和oid相同,此情景下拆分后的多个系统单,只有一个系统订单可成功同步物流单号,其余系统单不同步。

②:商城订单有多条货品明细,被拆分成多个系统订单的

  • 一个tid对应多个oid,拆分后的多个系统订单tid相同、oid不同,此情景下拆分后的多个系统单,每个系统订单可以同步一个单号

③注意事项:

  • 物流同步时物流单号对应的最小维度是子订单(oid),一个子订单只能同步一个单号

  • 需要在客户端设置--系统设置--物流设置中勾选开启拆单发货的配置,否则一个平台订单编号只能回传一个物流单号

  • 平台(商城、官网等)必须支持拆分发货功能


1.5.2 多包裹发货:ERP系统内单个订单包含的货品数量过多或者重量过重,因实际包装需要或物流公司要求(例如:单个包裹不能超过5kg),此时单个订单需要打印多个物流单进行发货。

①:单个系统订单,实际多个包裹发货,每个包裹对应一个物流单号

  • 一个trade_no,对应多个logistics_no,此情景下与系统订单包含子订单(oid)条数无关,只能同步一个物流单号

2.调用场景

2.1 举例说明:自研商城、分销系统、全渠道等系统对接

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

名称字段类型长度
必须描述
店铺编号

shop_no

String

20n
店铺编号,不支持传入多个店铺编号
是否自有平台is_own_platformbool1n

是否自有平台(自有平台调用传true)

是:true  否:false

不填默认为false

原始单号

tid

String

40n原始单号
物流单号

logistics_no

String

40n物流单号
是否拆单发货

is_part_sync

Int1n1拆单发货,0非拆单发货  不传则不使用该条件

pager

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

Int

4n

分页大小(最大1000)

分页page_no

Int

4n

从0开始

4.响应参数

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

status

Int11y

状态码,0表示调用成功

总条数

total

Int11n总条数
错误信息

message

String

255n

无错误信息不返回

单据数据

data

List<Map<String, Object>>


n

单据数据

data

响应参数说明示例值或者格式、具体含义、使用方法及注意事项

名称字段类型长度
必须描述
物流同步id

sync_id

Int
11
物流同步id

原始单号

tid

String

40

原始单号

物流单号

logistics_no

String

40物流单号
物流公司编号logistics_code

String

60系统内自定义物流公司的编号,在ERP设置--基本设置--物流页面查看
物流公司名称
logistics_name

String

32通用物流公司名称,例如申通快递
是否拆单发货is_part_sync

int

1是:1  否:0     店铺下“拆单发货配置”需要为“子单拆分发货”或才可以正确标记拆分情况
原始子单号oids

String

208

原始子单号,仅拆单发货和部分退款成功的单据该字段有值。 

订单idtrade_id

Int

11

订单id

平台idplatform_id

Byte

4

平台id 

创建时间
created

String


格式: yyyy-MM-dd HH:mm:ss

5.请求示例

json格式请求报文
[{
       "shop_no": "fx_test",
       "is_own_platform": true
}]
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->shop_no = 'fx_test';
$parMap->is_own_platform = true;
 
$syncList = array();
array_push($syncList, $parMap);
 
$pager = new Pager(1, 0, true);
 
$data = $client->pageCall("sales.LogisticsSync.getSyncListExt", $pager, $parMap);
$php_json = json_encode($data);
echo $php_json;
?>
JAVA

C#

6.响应示

 6.1 正常响应示例 

JSON
{
    "status": 0,
    "total": 1,
    "data": [{
        "sync_id": 152650,
        "tid": "ceshi20220922001",
        "logistics_no": "2345676543223",
        "logistics_code": "YZBK",
        "logistics_name": "中国邮政",
        "is_part_sync": 0,
        "oids": "",
        "trade_id": 952727,
        "platform_id": 127,
        "created": "2022-09-22 15:15:00"
    }]
}

   6.2 异常响应示例

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



常用工具