5.1 修改订单信息
### 1、接口描述
- API 方法 api.biaoju.order.update
- 接口支持多次调取更新订单数据。
- 关于返回面单标签的特别说明:
1)不管 10x10 或者 A4 标签,各个字段都不是必填字段。
2)如果通过接口返回标签 URL,请按实际情况返回到对应字段中。
3)对应尺寸的面单需回传至对应的尺寸字段。
4)举例
如果只有单一地址单 URL 和单一报关单 URL,请返回到"a"字段和"c"字段中,其他所有字段留空即可。
如果地址单和报关单在同一 URL地址,那么只需要传入"ac"字段中,其他所有字段留空即可。
### 2、字段说明
| 字段名称 | 字段类型 | 默认值 | 必填 | 备注 |
| ------ | --------| ----- | ----| -----|
| code | string | | true |内部订单号 |
| changeStatus | string | | true |修改订单状态 (参考订单状态详情)|
#### <b><i>订单状态详情</i></b>
|状态码|状态|备注|
|-----|-----|------|
|accept|已确认|供应商下载订单后:修改状态为已确认,并返回尾程单号。<br><br>supplierInnerCode=物流内部单号(必填)*= erp订单详情内部单号*, 物流内部单号也可传入物流尾程单号。<br>expressChannelCode=物流尾程单号 *= erp订单详情货运单号* <br><br> 此状态expressChannelCode未传值时将取 supplierInnerCode单号,<br> 示例:expressChannelCode = supplierInnerCode = 123456;<br><br>labelHTMLUrl,labelPDFUrl 标签地址结构基本相同<br><br>可传 a4,10x10 格式<br>可单独传地址单和报关单,也可合在PDF 和 HTML中一起传地址单和报关单。<br>地址单 a4 或 10x10 至少传一样。如果需要报关单也请传此面单|
|received|已入库|供应商收到包裹:修改状态、修改供应商入库时间、修改供应商内部单号、修改实际重量、修改实际运费<br><br>选填参数<br>supplierInnerCode = 物流内部单号 *= erp订单详情内部单号*,物流内部单号也可传入物流尾程单号。<br> expressChannelCode = 物流尾程单号,[物流货运单号](必填)。<br><br>如果传入物流内部单号,但没有传物流尾程单号,这里可更新订单成功<br> priceReal=订单实际价格,<br>weightReal=订单实际重量(单位:g 克)|
|sent|已出库|供应商发出包裹或者供应商系统生成正式运单号,修改状态、修改时间、修改正式运单号<br><br>选填参数<br>expressChannelCode=物流跟踪单号(必填)<br>weightReal=订单实际重量(单位:g 克)<br>priceReal=订单实际价格|
|exception|异常|用户提交的订单信息有异常<br><br>选填参数<br>processMessage=订单异常信息(必填) |
|cancel|订单取消|当订单状态为[待入库,已确认,已入库],可取消订单<br><br>选填参数<br>processMessage=取消备注(必填)|
### 3、encodeParams 数据 JSON 结构实例
- A. 修改状态为 accept
```json
{
"code": "内部订单号",
"changeStatus": "accept",
"supplierInnerCode": "物流内部单号",
"expressChannelCode":"物流跟踪单号",
"extetiona": "扩展字段 1 客户代码等",
"extetionb": "扩展字段 2 转单号等",
"flowCode": "扩展字段 3 流向码等",
"labelHTMLUrl": {
"b10_10": {
"a": "单一地址单 URL 地址",
"c": "单一报关单 URL 地址",
"p": "单一配货单 URL 地址",
"i": "单一发票 URL 地址",
"ac": "地址单和报关单同一 URL 地址"
},
"a4": {
"a": "单一地址单 URL 地址",
"c": "单一报关单 URL 地址",
"p": "单一配货单 URL 地址",
"i": "单一发票 URL 地址",
"ac": "地址单和报关单同一 URL 地址"
}
},
"labelPDFUrl": {
"b10_10": {
"a": "单一地址单 URL 地址",
"c": "单一报关单 URL 地址",
"p": "单一配货单 URL 地址",
"i": "单一发票 URL 地址",
"ac": "地址单和报关单同一 URL 地址"
},
"a4": {
"a": "单一地址单 URL 地址",
"c": "单一报关单 URL 地址",
"p": "单一配货单 URL 地址",
"i": "单一发票 URL 地址",
"ac": "地址单和报关单同一 URL 地址"
}
}
}
```
- B. 修改状态为 received
```json
{
"code": "内部订单号",
"changeStatus": "received",
"weightReal": "订单实际重量",
"priceReal": "订单实际运费",
"supplierInnerCode": "物流内部单号",
"expressChannelCode": "物流跟踪单号",
"labelHTMLUrl": "结构同例 1",
"labelPDFUrl": "结构同例 1"
}
```
- C. 修改状态为 sent
```json
{
"code": "内部订单号",
"changeStatus": " sent",
"supplierInnerCode": "物流内部单号",
"expressChannelCode": "物流跟踪单号",
"weightReal": "订单实际重量",
"priceReal": "订单实际运费",
"labelHTMLUrl": "结构同例 1",
"labelPDFUrl": "结构同例 1",
}
```
- D. 修改状态为 exception
```json
{
"code": "内部订单号",
"changeStatus": "exception",
"processMessage": "订单异常信息"
}
```
- E. 修改状态为 cancel
```json
{
"code": "内部订单号",
"changeStatus": "cancel",
"processMessage": "取消备注"
}
```
### 4、返回数据结构
```json
{
"code": "内部订单号"
}
```