API文档

发货

三方ERP发货解决方案

业务场景

​ 供应商使用自研ERP/三方ERP管理订单和发货,针对其中兰亭下发的订单,需要同时在兰亭供应商门户系统中完成发货动作。

解决方案

ship1.png

接口推荐:

接口分类 接口详情 接口说明
同步采购单 批量获取采购单行列表(根据下单时间) 通过此接口,三方ERP可查询兰亭供应商门户系统的下达给当前供应商的采购单行信息
同步采购单 批量获取采购单行列表(根据采购单号) 通过此接口,三方ERP可查询兰亭供应商门户系统的下达给当前供应商的采购单行信息
依据采购单行发起发货 创建发货单 通过此接口,三方ERP可在兰亭供应商门户系统中生成草稿状态的发货单
依据采购单行发起发货 创建发货单(返回明细单行信息) 通过此接口,三方ERP可在兰亭供应商门户系统中生成草稿状态的发货单,并获得本次加入发货单的采购单行号和实发数量
发货单实发数量修改 发货单数量修改(草稿状态) 通过此接口,三方ERP可修改兰亭门户系统中草稿状态发货单中,具体单行明细的实发数量。如果修改后触发拆行,那么新单行(未发货)将退回到待处理采购单列表
确认发货 发货单状态修改(草稿状态->已发货) 通过此接口,三方ERP可在兰亭供应商门户系统完成发货动作,并进行发货单打印
确认发货 创建发货单&&变更发货单状态为已发货
打印发货单 发货单详情查询(PDF版详情) 通过此接口,三方ERP,可查询发货单详情,并进行发货单详情打印
打印发货单 发货单单号查询(根据快递单号) 三方ERP,可通过此接口,根据快递单号,查询发货单号,用于其他接口查询需要
发货后跟踪查询 发货单详情查询(质检&收货异常情形) 三方ERP,可通过此接口,查询发货单后续到仓后质检收货等情况
















发货单查询

发货单单号查询(根据快递单号)

说明:

	根据快递名称和快递单号,查询发货单号 

	1、能够查询发货单号的前提是:操作发货时,填写正确的快递信息 

请求描述:

HTTP请求方式:GET
HTTP请求头类型:Content-Type=application/json
API: /v1/sp/procurement/getShippingId

请求参数:

1、公共参数

​ 详情可查看在【开发规范】中的系统级参数中查看

2、业务参数

参数名 类型 是否必填 参数描述
expressId string 快递公司ID,参考下方支持的快递公司
expressCode string 快递单号

业务示例

{host}/v1/sp/procurement/getShippingId?
token=你的token
&businessId=你的业务id
&timestamp=发起请求的时间戳
&expressId=1
&expressCode=2022062001

响应参数

名称 类型 描述
success boolean 结果状态,true请求成功,false请求失败
detail string 错误信息
status int 错误码
data int 发货单号ID

响应示例(JSON)

{
  "success": "true",// 结果状态,true请求成功,false请求失败
  "detail": "",//错误信息
  "status": "3",//错误码  
  "data": ""//发货单号
}
















发货单详情查询(PDF版发货单详情)

说明:

	通过发货单号,查询PDF版本的发货单详情 

	1、PDF版本的发货单详情可用于打印发货单 

请求描述:

HTTP请求方式:GET
HTTP请求头类型:Content-Type=application/json
API: /v1/sp/procurement/shippingOrder

请求参数:

1、公共参数

​ 详情可查看在【开发规范】中的系统级参数中查看

2、业务参数

参数名 类型 是否必填 参数描述
shippingOrderId int 发货单号ID,可通过发货单单号查询API获取

业务示例

{host}/v1/sp/procurement/shippingOrder?
token=你的token
&businessId=你的业务id
&timestamp=发起请求的时间戳
&shippingOrderId=123456

响应参数

名称 类型 描述
success boolean 结果状态,true请求成功,false请求失败
detail string 错误信息
status int 错误码
data int 发货单PDF链接

响应示例(JSON)

{
  "success": "true",// 结果状态,true请求成功,false请求失败
  "detail": "",//错误信息
  "status": "3",//错误码  
  "data": ""//发货单PDF链接
}
















发货单详情查询(质检和收货异常清晰)

说明:

	通过发货单号,已发货的发货单的质检情况以及收货异常等情况 

请求描述:

HTTP请求方式:GET
HTTP请求头类型:Content-Type=application/json
API: /v1/sp/procurement/getShippedOrder

请求参数:

1、公共参数

详情可查看在【开发规范】中的系统级参数中查看

2、业务参数

参数名 类型 是否必填 参数描述
shippingOrderId int 发货单号ID,可通过发货单单号查询API获取

业务示例

{host}/v1/sp/procurement/getShippedOrder?
token=你的token
&businessId=你的业务id
&timestamp=发起请求的时间戳
&shippingOrderId=12345

响应参数

名称 类型 描述
success boolean 结果状态,true请求成功,false请求失败
detail string 错误信息
status int 错误码
data json 详情

data

名称 类型 描述
exception json 异常单行,含多货少货
normal json 正常单行,含质检信息

数据单行

名称 类型 描述
procurementOrderId int 采购单号
procurementOrderLineId int 采购单行号
sku string SKU
productName string 产品中文名称
productNameEn string 产品英文名称
skuAttribute string SKU属性
skuAttributeEn string SKU属性
quantity int SKU属性
receivedQuantity int 实际发货数量
quality string 质检
qtReason string 质检描述
responsibility string 责任方
memo string 备注

响应示例(JSON)

{
    "success": true,
    "detail": "请求成功",
    "data": {
        "exception": [
            {
                "procurementOrderId": 8830556,
                "procurementOrderLineId": 98608381,
                "sku": "S901553100004",
                "productName": "尺码表081503",
                "productNameEn": "55454546",
                "skuAttribute": "Size=S;Size=自定义测试;",
                "skuAttributeEn": "Size=S;Size(US)=custom size;",
                "receivedQuantity": 7,
                "quantity": 10,
                "quality": null,
                "qtReason": null,
                "memo": "少货-未按兰亭要求包装(无法更换包装)",
                "responsibility": "供应商原因"
            }
        ],
        "normal": null
    },
    "status": 0
}
















发货单创建

创建发货单

说明:

	创建草稿状态发货单(参照门户订单列表【立即发货】功能)

	1、仅支持将预  处理、延期发货和待发货采购单行,加入到发货单

	2、不同收货方式、不同到货地址的采购单行,不能加入到同一张发货单 

请求描述:

HTTP请求方式:POST
HTTP请求头类型:Content-Type=application/json
API: /v1/sp/procurement/deliver

请求参数:

1、公共参数

​ 详情可查看在【开发规范】中的系统级参数中查看

2、业务参数

参数名 类型 是否必填 参数描述
memo string 发货备注
lines Array 采购单行,使用数组表示,单次发货不能超过100条
expressId int 快递公司ID,参考下方支持的快递公司
expressCode string 快递单号
expectedDeliveryDate string 预计到货日期,格式yyyy-MM-dd

lines

参数名 类型 是否必填 参数描述
procurementOrderLineId int 采购单行号
procurementOrderId int 采购单号
merchantSkuCode string SKU商家编码
realQuantity int 实发数量
quantity int 行上数量,用于校验是否拆行,可以为空

业务示例(JSON)

{
  "memo": "",// 发货备注    
  "lines": [// 采购单行,使用数组表示,单次发货不能超过100条
    {
      "procurementOrderLineId": 0,//采购单行号   
      "procurementOrderId": 0,//采购单号    
      "merchantSkuCode": "",//SKU商家编码
      "realQuantity": 0,//实发数量,
      "quantity": 0//行上数量,用于校验是否拆行,可以为空
    }
  ],
  "expressId": 0,//快递公司ID,参考页面下方支持的快递公司
  "expressCode": "",//快递单号  
  "expectedDeliveryDate": ""//预计到货日期 ,格式yyyy-MM-dd, 非必填
}

响应参数

名称 类型 描述
success boolean 结果状态,true请求成功,false请求失败
detail string 错误信息
status int 错误码
data int 发货单号

响应示例(JSON)

{
  "success": "true",// 结果状态,true请求成功,false请求失败
  "detail": "",//错误信息
  "status": "3",//错误码  
  "data": ""//发货单号
}
















创建发货单(返回明细单行信息)

说明:

	创建草稿状态发货单(参照门户订单列表【立即发货】功能) 

	1、仅支持将预处理、延期发货和待发货采购单行,加入到发货单 

	2、不同收货方式、不同到货地址的采购单行,不能加入到同一张发货单 

	3、会返回当次加入发货单的采购单行和发货数量。如发生拆单,会返回新拆出的加入到发货单的单行号 

请求描述:

HTTP请求方式:POST
HTTP请求头类型:Content-Type=application/json
API: /v1/sp/procurement/deliverAndReturnLineInfo

请求参数:

1、公共参数

​ 详情可查看在【开发规范】中的系统级参数中查看

2、业务参数

参数名 类型 是否必填 参数描述
memo string 发货备注
lines Array 采购单行,使用数组表示,单次发货不能超过100条
expressId int 快递公司ID,参考下方支持的快递公司
expressCode string 快递单号
expectedDeliveryDate string 预计到货日期,格式yyyy-MM-dd

lines

参数名 类型 是否必填 参数描述
procurementOrderLineId int 采购单行号
procurementOrderId int 采购单号
merchantSkuCode string SKU商家编码
realQuantity int 实发数量
quantity int 行上数量,用于校验是否拆行,可以为空

业务示例(JSON)

{
  "memo": "",// 发货备注    
  "lines": [// 采购单行,使用数组表示,单次发货不能超过100条
    {
      "procurementOrderLineId": 0,//采购单行号   
      "procurementOrderId": 0,//采购单号    
      "merchantSkuCode": "",//SKU商家编码
      "realQuantity": 0,//实发数量,
      "quantity": 0//行上数量,用于校验是否拆行,可以为空
    }
  ],
  "expressId": 0,//快递公司ID,参考页面下方支持的快递公司
  "expressCode": "",//快递单号  
  "expectedDeliveryDate": ""//预计到货日期 ,格式yyyy-MM-dd, 非必填
}

响应参数

名称 类型 描述
success boolean 结果状态,true请求成功,false请求失败
detail string 错误信息
status int 错误码
data obj 发货单号

data

名称 类型 描述
shippingOrderId int 发货单号
lineInfos array 当次调用发货的单行信息数组,包含下面三个字段
originLineId int 原采购单行号
newLineId int 如拆行-拆出的加入发货单的新行,如不拆行-值是nul
quantity int 单行的实际发货数量

响应示例(JSON)

{
  "success": true,
  "detail": "请求成功",
  "data": {
    "shippingOrderId": 2614601,
    "lineInfos": [
      {
        "originLineId": 98609125,
        "newLineId": 98610539,
        "quantity": 3
      },
      {
        "originLineId": 98610009,
        "newLineId": null,
        "quantity": 2
      }
    ]
  },
  "status": 0
}
















变更发货单状态为已发货

说明:

	创建草稿状态发货单,并将发货单状态变更为已发货(参照门户订单列表的【立即发货】&发货单详情的【货物发出-确认发货】功能)

	1、仅支持将预处理、延期发货和待发货采购单行,加入到发货单 

	2、不同收货方式、不同到货地址的采购单行,不能加入到同一张发货单 

请求描述:

HTTP请求方式:POST
HTTP请求头类型:Content-Type=application/json
API: /v1/sp/procurement/deliverConfirm

请求参数:

1、公共参数

​ 详情可查看在【开发规范】中的系统级参数中查看

2、业务参数

参数名 类型 是否必填 参数描述
memo string 发货备注
lines Array 采购单行,使用数组表示,单次发货不能超过100条
expressId int 快递公司ID,参考下方支持的快递公司
expressCode string 快递单号
expectedDeliveryDate string 预计到货日期,格式yyyy-MM-dd

lines

参数名 类型 是否必填 参数描述
procurementOrderLineId int 采购单行号
procurementOrderId int 采购单号
merchantSkuCode string SKU商家编码
realQuantity int 实发数量

业务示例(JSON)

{
  "memo": "",// 发货备注    
  "lines": [// 采购单行,使用数组表示,单次发货不能超过100条
    {
      "procurementOrderLineId": 0,//采购单行号   
      "procurementOrderId": 0,//采购单号    
      "merchantSkuCode": "",//SKU商家编码
      "realQuantity": 0//实发数量,
    }
  ],
  "expressId": 0,//快递公司ID,参考页面下方支持的快递公司
  "expressCode": "",//快递单号  
  "expectedDeliveryDate": ""//预计到货日期 ,格式yyyy-MM-dd, 非必填
}

响应参数

名称 类型 描述
success boolean 结果状态,true请求成功,false请求失败
detail string 错误信息
status int 错误码

响应示例(JSON)

{
  "success": true,
  "detail": "请求成功",
  "status": 0
}
















发货单修改

发货单数量修改(草稿状态)

说明:

	修改草稿状态下,发货单上指定采购单行的发货数量。

	1、发货数量不能改大,只能改小。发货数量改小后,未发货部分,将被剔除发货单,并退回到【待发货】页面 

	2、仅支持对草稿状态下的发货单进行修改发货数量 

请求描述:

HTTP请求方式:POST
HTTP请求头类型:Content-Type=application/json
API: /v1/sp/procurement/decreaseLineQuantity

请求参数:

1、公共参数

​ 详情可查看在【开发规范】中的系统级参数中查看

2、业务参数

参数名 类型 是否必填 参数描述
shippingOrderId long 发货单号,发货单必须为草稿状态
procurementOrderLineId long 采购单行号
quantity int 实发数量

注:

	1、如果实发数量 ≥ 原单行数量则不处理; 

	2、如果实发数量 = 0, 相当于将该采购单行从发货单中删除,该单行返回待发货; 

	3、如果实发数量 < 原单行的采购数量,则将未发货数量(即未发货数量=原单行采购数量 - 实发数量)生成一个新的待发货的采购单行; 

业务示例

{host}/v1/sp/procurement/decreaseLineQuantity?
token=你的token
&businessId=你的业务id
&timestamp=发起请求的时间戳
&shippingOrderId=12345
&procurementOrderLineId=200001
&quantity=1

响应参数

名称 类型 描述
success boolean 结果状态,true请求成功,false请求失败
detail string 错误信息
data object 暂不返回信息
status int 错误码

响应示例(JSON)

{
  "success": true,
  "detail": "请求成功",
  "status": 0
}
















发货单状态修改(草稿状态 -> 已发货)

说明:

	发货单状态修改,将草稿状态修改为已发货状态。

	1、发货单变更为已发货状态后,将不能继续添加采购单行到发货单 

	2、修改成功后,将生成PDF格式发货单,并发挥PDF文件链接 

请求描述:

HTTP请求方式:GET
HTTP请求头类型:Content-Type=application/json
API: /v1/sp/procurement/shipping

请求参数:

1、公共参数

​ 详情可查看在【开发规范】中的系统级参数中查看

2、业务参数

参数名 类型 是否必填 参数描述
shippingOrderId int 发货单号,发货单必须为草稿状态
expressId int 快递公司ID,参考下述,支持的快递公司
expressCode int 快递单号

注:

​ 1、优先使用发货单号查询发货单;

​ 2、如果发货单号为空,使用快递公司Id和快递单号查询;

	3、两种方式二选一。使用快递方式查询时,快递公司ID和快递单号不能为空。; 

业务示例

{host}/v1/sp/procurement/shipping?
token=你的token
&businessId=你的业务id
&timestamp=发起请求的时间戳
&shippingOrderId=1234
&expressId=1
&expressCode=20221011

响应参数

名称 类型 描述
success boolean 结果状态,true请求成功,false请求失败
detail string 错误信息
status int 错误码
data string PDF链接地址

响应示例(JSON)

{
  "success": true,
  "detail": "请求成功",
  "status": 0,
  "data": "0"
}
















发货单相关枚举

支持的快递公司

ID 快递公司
1 申通快递
2 宅急便
3 自有物流
4 港中能达
5 鑫飞鸿(城市100)
6 快捷速递
7 权益快递
8 速尔快递
9 天天快递
10 优速快递
11 天地华宇
12 德邦物流
13 汇强快递
14 国通快递
15 新邦物流
16 中国邮政国内小包
17 中国邮政挂号信
19 EMS
20 安能物流
21 百世汇通
22 丰达
23 汇丰
24 汇通
25 加运美
26 跨越
27 联邦
28 联昊通
29 龙邦
30 民邦
31 平安达
32 全峰
33 全日通
34 全通
35 全一
36 世纪同城
37 顺丰
38 信丰
39 亚风
40 圆通
41 韵达
42 增益
43 宅急送
44 中通
45 凝聚力物流
46 中港运通快递
47 港快速递
48 旗航快递
49 顺业物流快递
50 星晨阿里速递
51 红马速运
52 京广速递
53 速腾快递
54 广达通同城快递
56 原飞航物流
57 首达速运
58 平安达
59 百世快递
60 邮政快递包裹
61 京东快递
62 德邦快递
63 安捷快递
64 阿里跨境电商物流
65 安迅物流
66 安邮美国
67 亚马逊物流
68 澳门邮政
69 澳多多
70 澳邮专线
71 安鲜达
72 安能快运
73 澳邦国际
74 八达通
75 百腾物流
76 北极星快运
77 奔腾物流
78 百福东方
79 贝海国际
80 八方安运
81 百世快运
82 帮帮发转运
83 百城通物流
84 春风物流
85 诚通物流
86 传喜物流
87 城市100
88 城际快递
89 CNPEX中邮快递
90 COE东方快递
91 长沙创一
92 成都善途速运
93 联合运通
94 疯狂快递
95 CBO钏博物流
96 佳吉快运
97 承诺达
98 畅顺通达
99 D速物流
100 到了港
101 大田物流
102 东骏快捷物流
103 德坤
104 德邦快运
105 大马鹿
106 丹鸟物流
107 E特快
108 EMS国内
109 EWE
110 飞康达
111 富腾达
112 凡宇货的
113 速派快递
114 飞豹快递
115 丰巢
116 飞狐快递
117 复融供应链
118 飞远配送
119 凡宇速递
120 丰通快运
121 冠达
122 广东邮政
123 共速达
124 广通
125 冠达快递
126 挂号信
127 广通速递
128 高铁快运
129 迦递快递
130 高铁速递
131 黑狗冷链
132 恒路物流
133 鸿桥供应链
134 海派通物流公司
135 华强物流
136 环球速运
137 华夏龙物流
138 河北建华
139 华航快递
140 华翰物流
141 黄马甲快递
142 海盟速递
143 华企快运
144 昊盛物流
145 户通物流
146 豪翔物流
147 合肥汇文
148 辉隆物流
149 华企快递
150 韩润物流
151 青岛恒通快递
152 货运皇物流
153 好来运快递
154 皇家物流
155 海信物流
156 捷安达
157 九曳供应链
158 急先达
159 晋越快递
160 佳成国际
161 捷特快递
162 精英速运
163 景光物流
164 佳怡物流
165 京东快运
166 金大物流
167 极兔速递
168 跨越速运
169 快服务
170 快速递物流
171 康力物流
172 快淘快递
173 快优达速递
174 跨越物流
175 快8速运
176 蓝弧快递
177 乐捷递
178 立即送
179 民航快递
180 美快
181 门对门快递
182 迈达
183 闽盛快递
184 迈隆递运
185 明亮物流
186 南方传媒物流
187 南京晟邦物流
188 能达速递
189 平安达腾飞快递
190 泛捷快递
191 品骏快递
192 陪行物流
193 PCA Express
194 全晨快递
195 快客快递
196 全信通
197 七曜中邮
198 如风达
199 荣庆物流
200 日日顺物流
201 日昱物流
202 瑞丰速递
203 赛澳递
204 苏宁物流
205 圣安物流
206 晟邦物流
207 上大物流
208 盛丰物流
209 速通物流
210 速必达物流
211 速递e站
212 速呈宅配
213 山东海红
214 顺丰国际
215 盛辉物流
216 穗佳物流
217 三态速递
218 山西红马甲
219 世运快递
220 闪送
221 盛通快递
222 郑州速捷
223 顺心捷达
224 商桥物流
225 佳旺达物流
226 台湾邮政
227 唐山申通
228 特急送
229 通用物流
230 华宇物流
231 通和天下
232 腾林物流
233 UBI
234 UEQ Express
235 万家康
236 万家物流
237 武汉同舟行
238 维普恩
239 中粮我买网
240 万象物流
241 微特派
242 温通物流
243 迅驰物流
244 希优特
245 祥龙运通
246 新杰物流
247 源安达快递
248 远成物流
249 远成快运
250 义达国际物流
251 易达通
252 运通快递
253 亿翔快递
254 运东西网
255 壹米滴答
256 邮政国内标快
257 一站通速运
258 驭丰速运
259 余氏东风
260 耀飞快递
261 韵达快运
262 云路
263 邮必佳
264 越丰物流
265 银捷速递
266 优联吉运
267 亿领速运
268 英脉物流
269 亿顺航
270 音素快运
271 易通达
272 一统飞鸿
273 圆通国际
274 宇鑫物流
275 包裹/平邮/挂号信
276 一智通
277 优拜物流
278 中睿速递
279 中铁快运
280 中天万运
281 中外运速递
282 澳转运
283 八达网
284 贝易购
285 赤兔马转运
286 CUL中美速递
287 ETD
288 风驰快递
289 风雷速递
290 皓晨优递
291 海带宝
292 汇丰美中速递
293 豪杰速递
294 华美快递
295 360hitao转运
296 海淘村
297 365海淘客
298 华通快运
299 海星桥快递
300 华兴速运
301 LogisticsY
302 领跑者快递
303 量子物流
304 明邦转运
305 美嘉快递
306 168 美中快递
307 欧e捷
308 欧洲疯
309 欧洲GO
310 全美通
311 SCS国际物流
312 SOHO苏豪国际
313 Sonic-Ex速递
314 通诚美中快递
315 TrakPak
316 天天海淘
317 天泽快递
318 迅达快递
319 信达速运
320 新干线快递
321 信捷转运
322 优购快递
323 友家速递(UCS)
324 云畔网
325 易送网
326 中运全速
327 中邮物流
328 众通快递
329 中通快运
330 中邮快递
331 芝麻开门
332 中骅物流
333 中铁物流
334 其他
335 定点专车物流
336 UPS
337 FEDEX联邦(国内件)
338 USPS美国邮政
339 DHL
340 亚马逊物流
341 ONTRAC