createDelivery需要签名验签
集成商可调用此接口进行订单发货。
在调用此接口之前,调用 uploadAttachment 接口以获取发货所需的 fileName 和 fileKey 参数。
报文结构
万里汇接口的报文结构包括:请求头、请求体、响应头和响应体。该章节主要介绍请求体和响应体的结构。关于请求头和响应头的更多信息,参见:
入参
requestId String REQUIRED
针对本次发货请求,由集成商指定的唯一请求号。
更多信息:
- 此为幂等字段。
- 最大长度:64 字符
tradeId String REQUIRED
WorldTrade系统生成的订单ID。
更多信息:
- 最大长度:64 字符
relateProductList Array<RelateProduct> REQUIRED
本次发货关联的商品列表。
logisticsVoucherType String REQUIRED
物流凭证类型。可取值范围:
LOGISTICS_BILL
物流单ENTRY_BILL
报关单
- 当您订单的发货地为
MAINLAND
且订单金额大于 10000 USD时,此字段取值必须为ENTRY_BILL
。- 当您订单的发货地为
OVERSEAS
时,此字段取值必须为LOGISTICS_BILL
。
logisticsTrackingNo String CONDITIONAL
物流单号。
更多信息:
- 字符长度范围:4 - 64 字符
- 字母或数字不可完全重复
当 logisticsVoucherType 字段取值为
LOGISTICS_BILL
时,此字段为必传。
logisticsWaybillList Array<File> CONDITIONAL
物流面单附件。
当 logisticsVoucherType 字段取值为
LOGISTICS_BILL
时,此字段为必传。
fileList Array<File> CONDITIONAL
其他附件。
当 logisticsVoucherType 字段取值为
LOGISTICS_BILL
时,此字段可按需传入。
entryOrderNo String CONDITIONAL
报关单号。
更多信息:
- 字符长度范围:4 - 64 字符
当 logisticsVoucherType 字段取值为
ENTRY_BILL
时,此字段为必传。
entryOrderList Array<File> CONDITIONAL
报关单附件。
当 logisticsVoucherType 字段取值为
ENTRY_BILL
时,此字段为必传。
superviseType String CONDITIONAL
监管方式。可取值范围:
9710
跨境电商B2B出口0110
一般贸易B2B出口
当 logisticsVoucherType 字段取值为
ENTRY_BILL
时,此字段为必传。
carrierCode String CONDITIONAL
承运商编码。
取值包括:KY479
,KY176
等,完整取值详见:ProviderKey。
当 logisticsVoucherType 字段取值为
LOGISTICS_BILL
时,此字段为必传。
更多信息:
- 最大长度:32 字符
carrierName String CONDITIONAL
承运商名称。完整取值详见:ProviderKey。
当 logisticsVoucherType 字段取值为
LOGISTICS_BILL
时,此字段为必传。
更多信息:
- 最大长度:64 字符
出参
result Result REQUIRED
代表 API 接口调用结果。
requestId String REQUIRED
针对本次发货请求,由集成商指定的唯一请求号。
更多信息:
- 最大长度:64 字符
deliveryBatchId String REQUIRED
发货批次单号。
更多信息:
- 最大长度:64 字符
请求
响应
响应处理
集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus 字段取值范围为:
result.resultCode:系统结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | Success | |
PROCESS_FAIL | F | A general business failure occurred. Do Not retry. | 需要人工介入,联系万里汇技术支持以解决此问题 |
PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 确认请求正确加签 |
INVALID_SIGNATURE | F | The signature is invalid. | 确认请求正确加签 |
REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | 重试请求不一致,需保证所有请求参数均相同 |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题 |
FILE_SIZE_EXCEED_LIMIT | F | The file size has exceeded the limit. | 文件大小需在允许范围内 |
CONTRACT_CHECK_FAIL | F | The contract check has failed. | 检查合约状态后重试 |
result.resultCode:业务结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SYSTEM_EXCEPTION | F | System exception. | 需要人工介入,联系WorldTrade客户服务经理以解决此问题 |
PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 请检查参数后重试 |
OPERATION_PROHIBITED | F | The current order status does not allow operation of the shipment batch. | 此订单无法发货。调用 queryTradeOrder 接口查询当前订单状态。 |
BATCH_EXCEED_LIMIT | F | The number of delivery batches exceeds limit. | 需要人工介入,联系WorldTrade客户服务经理以解决此问题 |
PRODUCT_NOT_EXIST | F | The product does not exist . | 确认 relateProductList.productId 参数传值正确后重试 |
PRODUCT_TYPE_ERROR | F | The product type is incorrect. | 请检查参数后重试 |
INCORRECT_PRODUCT_QUANTITY | F | The product quantity is incorrect. | 修改relateProductList.productQuantity 参数中的关联商品数量,并使用新的requestId 重试 |
INCORRECT_VOUCHER_TYPE | F | The voucher type is incorrect. | 使用正确的logisticsVoucherType 参数后重试 |
SUPERVISE_TYPE_EMPTY | F | The supervise type is empty . | 传入superviseType 参数后重试 |
SUPERVISE_TYPE_ERROR | F | The supervise type is incorrect. | 修改superviseType 参数后重试 |
CARRIER_NAME_EMPTY | F | The carrier name is empty. | 使用有效的 carrierName 参数后重试 |
TRACKING_NUMBER_ERROR | F | The logistics tracking number is incorrect. | 使用正确的 logisticsTrackingNo 参数后重试 |
ORDER_NOT_EXIST | F | The order does not exist . | 修改 tradeId 参数后重试 |
USER_ERROR | F | This order does not belong to the current user . | 修改 tradeId 参数后重试 |