韵达 API
  • 接口简介
  • API 鉴权说明
  • 电子面单
  • 散件下单
  • 物流轨迹
  • 国际件
    • 国际进口下单接口POST
  • 页面嵌入
logoPowered by Apifox
  1. 国际件

国际进口下单接口

POST/outer/api/v1/order/push

  • 接口描述

    国际进口下单接口，客户下单至国际订单系统，四段码以及落地配单号

pdfInfo说明

1.pdfInfo为加密报文时，可以联系开通大客户网点配置为不加密
2.部分用户解析pdfInfo取三段码困难，可在帮助中心搜索电子面单接口如何取出三段码，参考给出java示例

参数 参数说明
position 一段码
position_no 二段码和三段码
tp_status 四段码
package_wdjc 集包地

附录

货币代码

货币 货币代码
Australia AUD
Brazil BRL
Canada CAD
Switzerland CHF
China CNY
Denmark DKK
Eurozone EUR
United Kingdom GBP
Hong Kong HKD
Indonesia IDR
Israel ILS
India INR
Japan JPY
South Korea KRW
Malaysia MYR
New Zealand NZD
Philippines PHP
Russia RUB
Singapore SGD
Thailand THB
Taiwan TWD
United States USD
Vietnam VND

危险品代码

字段描述 危险品类别代码
Does not contain Lithium Batteries 00
Non Rechargeable batteries in Item 01
Lithium Batteries packed with item 02
Lithium Batteries Only 03
Lithium Batteries in item 04
Rechargeable Batteries packed with item 05
Rechargeable Batteries only 06

请求参数

Body 参数application/json
account
string 
国际接口账号
必需
orders
array [object {37}] 
订单列表
必需
codValue
number 
可选

货到付款金额，isCOD为Y时填写

currencyCode
string 
必需

货币代码，见货币代码附录

duties
number 
关税金额
可选
freight
number 
运费
可选
insurance
number 
必需

保价金额，isInsured为Y时填写

isCOD
string 
必需

是否货到付款 是：Y，否：N 默认N

isInsured
string 
必需

是否保价 是：Y，否：N 默认N

items
array [object {11}] 
货物列表
必需
orderStatus
string 
必需

订单类别 下单：A，修改订单：M，取消订单：X，绑单：B

orderType
string 
可选

业务类别（不填默认获取779单号，common获取31单号）

salesChannel
string 
可选

销售渠道（订单来源）

<= 50 字符
parcelType
string 
必需

包裹类别 文件：DOC 包裹：SPX

receiver
object (Person) 
收件人详情
可选
sender
object (Person) 
发件人详情
可选
shipmentHeight
number 
包裹高度（cm
可选
shipmentLength
number 
包裹长度（cm）
可选
shipmentOrderNO
string 
客户订单号
必需
shipmentVolume
number 
可选
包裹体积（cm3）
shipmentWeight
number 
包裹重量（kg）
可选
shipmentWidth
number 
包裹宽度（cm）
可选
taxes
number 
税
可选
totalDeclaredValue
number 
包裹总申报价值
必需
trackingNumber
string 
韵达运单号
可选
warehouseCode
string 
可选

客户仓库代码,长度10

customerReference1
string 
客户参考号1
必需
customerReference2
string 
客户参考号2
必需
remarks
string 
备注，长度50
必需
recipientIDType
string 
可选

证件类型 身份证：zj01 护照：zj02 其他：zj03

recipientID
string 
可选

证件号码，证件类型不为空时填写，长度30

cusArea1
string 
可选

面单自定义区域内容，长度255

cusArea2
string 
可选

面单自定义区域内容，长度255

returnShippingServiceCode
string 
退回件服务代码
可选
returnInfo
object (Person) 
退回人详情
必需
ebpCode
string 
可选

电商平台编码（申报使用）

ebpName
string 
可选

电商平台名称（申报使用）

ebpCiqCode
string 
电商平台国检编码
可选
ebpCiqName
string 
电商平台国检名称
可选
reqType
string 
必需

业务类别 CHINA_IMPORT：进口业务

secret
string 
必需

国际接口秘钥32位小写 md5(account+password)

示例
{
  "appid": "999999",
  "partner_id": "201700101001",
  "secret": "123456789",
  "orders": [
    {
      "collect_branch": "",
      "collection_value": 126.5,
      "cus_area1": "",
      "cus_area2": "",
      "isProtectPrivacy": "",
      "items": [
        {
          "name": "衣服",
          "number": 1,
          "remark": "袜子"
        }
      ],
      "khddh": 2012121715001,
      "node_id": "350",
      "order_serial_no": 2012121715001,
      "order_type": "common",
      "platform_source": "",
      "receiver": {
        "address": "上海市，青浦区，盈港东路 6679 号",
        "city": "上海市",
        "company": "",
        "county": "青浦区",
        "mobile": "17601206977",
        "name": "李四",
        "province": "上海市"
      },
      "remark": "",
      "sender": {
        "address": "上海市，青浦区，盈港东路 7766 号",
        "city": "上海市",
        "company": "",
        "county": "青浦区",
        "mobile": "17601206977",
        "name": "张三",
        "province": "上海市"
      },
      "size": "0.12,0.23,0.11",
      "special": 0,
      "value": 126.5,
      "weight": 0,
      "multi_pack": {
        "mulpck": "",
        "total": 0,
        "endmark": 0
      },
      "markingInfos": [
        {
          "type": "INSURED",
          "markingValue": {
            "value": 2100
          }
        },
        {
          "type": "DF",
          "markingValue": {
            "value": 15
          }
        },
        {
          "type": "COD",
          "markingValue": {
            "value": 15
          }
        },
        {
          "type": "RETURN",
          "markingValue": {
            "value": "1,2"
          }
        },
        {
          "type": "PRI"
        },
        {
          "type": "VIR"
        },
        {
          "type": "MUL",
          "markingValue": {
            "value": 10
          }
        },
        {
          "type": "CONTACT"
        }
      ]
    }
  ]
}

示例代码

返回响应

成功(200)
失败(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
string 
必需

响应编码，200为成功，429为订单已存在，其他为失败

message
string 
描述
必需
result
boolean 
必需
data
array [object {6}] 
结果集
必需
shipmentOrderNO
string 
客户订单号
必需
trackingNumber
string 
必需

韵达运单号（成功才返回）

code
integer 
必需

状态码，200为成功，其他为失败

msg
string 
描述
必需
pdfInfo
array [array]  | string 
面单数据
必需
errorFileds
array [object {2}] 
错误字段array
可选
示例
失败
{
  "result": false,
  "code": "7777",
  "message": "内部接口服务失败",
  "sub_code": "s10",
  "sub_msg": "参数校验不合法"
}
最后修改时间： 3 年前