合同订单更新
请求地址
POST /v1/mid-open-api/material/contract-order/update需要验证签名
接口描述
当合同订单发生更新,需要更新信息,可以使用该接口。材料提交成功后,更新结果异步通知
提示
更新一般贸易的合同订单
- 当合同订单尚未关联入账时,可以更新所有信息。
- 当合同订单已关联入账时,只可以更新物流信息以及新增贸易证明材料。
- 如果合同订单有关联的入账正在审核中,则不允许更新。
- 如果更新字段不为空,则此次更新会覆盖上一次提交的值。因此不需要更新的字段只需要excel表格中该列不传值,需要更新的字段带上要更新后的新值。
请求方式
POST请求头
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | string | M | access_token |
| Content-Type | string | M | application/json |
请求参数
| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string(64) | M | 客户编号 |
| contract_order | object | M | 合同订单 |
contract_order【合同订单】
| Parameter | Type | Required | Description |
|---|---|---|---|
| trade_order_no | string(64) | M | 贸易订单号,用户需要保证唯一,可以基于它做更新。 |
| business_type | string(16) | O | 业务类型:SELF_STATION-自建站,T_TRADE-一般贸易 |
| settlement_type | int | O | 结汇类型:1-结汇,0-不结汇 |
| trade_code | string(16) | O | 贸易编码:122030-未纳入海关统计的货物贸易,121010-一般贸易 |
| amount | decimal(18,2) | O | 订单金额 |
| currency | string(3) | O | 订单交易币种,另见附录 |
| order_time | long | O | 订单时间,时间戳 |
| store_url | string(128) | O | 店铺链接,122030&结汇必填 |
| payment_method | string(2) | O | 付款方式:00-全款,01-预付款+尾款 |
| trading_terms | string(16) | O | 国际贸易约定交货方式,见下方说明 |
| declaration_no | string(128) | O | 报关单号,trade_code为121010,payment_method为00时必填 |
| new_buyer | string(2) | O | 是否新买家: 00-新买家,01-老买家,未发货必填 |
| category | string(2) | O | 商品类型,另见附录 |
| consignee_country_code | string(3) | O | 收货国别,另见附录 |
| buyer_name | string(128) | O | 买家英文姓名 |
| buyer_country | string(3) | O | 买家国别,另见附录 |
| buyer_email | string(128) | O | 买家邮箱 |
| doc_info_list | array | O | 贸易证明材料文件列表,见下方doc_info; 更新时可以新增,不支持删除已提交文件 |
| goods_info_list | array | O | 订单中商品信息,见下方goods_info |
doc_info
| Parameter | Type | Required | Description |
|---|---|---|---|
| doc_type | string(16) | M | 文件类型,见下方说明 |
| doc_id | string(64) | M | 文档ID |
| file_id | string(64) | M | 文件上传返回ID,文件上传接口 |
| file_name | string(128) | M | 文件名称 |
goods_info
| Parameter | Type | Required | Description |
|---|---|---|---|
| goods_en_name | string(255) | M | 商品英文名 |
| goods_quantity | int | M | 商品数量 |
| goods_unit | string(16) | M | 商品单位 |
| goods_unit_price | decimal(18,2) | M | 商品单价 |
| shipped | string(2) | M | 是否发货:00-已发货,01-未发货 ; 只可以未发货更新为已发货 |
| shipping_method | string(128) | C | 物流方式:空运、海运、陆运、快递、邮政、其他,已发货必填; 入账已关联后可更新 |
| estimated_delivery_date | string(128) | C | 预估发货时间,未发货必填; 入账已关联后可更新 |
| logistics_company | string(128) | C | 物流公司,已发货必填; 入账已关联后可更新 |
| actual_delivery_date | string(128) | C | 实际发货时间,已发货必填; 入账已关联后可更新 |
| tracking_id_list | array | C | 物流单号,已发货必填; 入账已关联后可更新 |
返回响应
| Parameter | Type | Required | Description |
|---|---|---|---|
| trade_order_no | string(64) | M | 贸易订单号 |
| status | string(64) | M | 审核状态:PENDING-审核中,SUCCESS-成功,FAILED-失败 |
返回示例
- 成功
- 失败
{
"code": 200,
"message": "SUCCESS",
"data": {
"trade_order_no":"202405011389"
"status": "PENDING"
}
}
{
"code": 900002,
"message": "illegal param",
"data": null
}
错误码
| 错误码 | 描述 | 解决方案 |
|---|---|---|
| 900000 | system error | 系统错误,请联系PingPong技术人员核查 |
| 900002 | illegal param | 参数有误,请根据提示更正信息 |
| 900004 | order not exist | 请检查单号是否正确 |
| 900005 | there is a processing inbound relation record used this order,can't be update! | 有关联入账正在处理中,不能更新 |