开发者必读

基础信息获取

订单管理

订单创建

资源中心

1．资源中心是跨鲸开放平台开发者所需所有相关资源的汇集地，包括：

（1）测试地址：https://sbx-lfms.eminxing.com

（2）正式地址：https://www.kjing.com

2．获取AppToken和AppKey

（1）为了用户接收消息时验证请求合法性，其中AppToken用于标识用户需具有唯一性,完成注册后，在系统的个人中心中获取AppToken和Appkey

更新日志

2021-01-12

1.更新空运、海运散货下单接口，具体更新如下：

删除 fba_refercode_arr、fba_refercode2_arr、box_num_arr 字段
pack_infos 字段类型为数组对象，其子元素增加 box_number 属性（即原 fba_refercode_arr 字段，移动到 pack_infos）、fba_reference_id 属性（即原 fba_refercode2_arr字段，移动到 pack_infos）
pack_infos.unit 字段限制数据格式

2.快递下单接口的 pack_infos.unit 字段限制数据格式

3.预期上线时间：2021-01-17

2021-11-24

1.更新空运、快递、海运散货下单接口中shipping_id、destination_address字段的描述

2.更新空运、快递、海运散货下单接口中third_company_name、third_first_name、third_phone、third_email字段的限制描述

3.移除海运散货下单接口ISF类型字段（isf_type）描述

4.海运整柜下单接口增加ISF类型字段（isf_type）描述

2021-11-02

1.补充文档数组类型子元素字段描述

2.更新【获取额外服务】接口返回内容描述

3.创建空运、快递、整柜、海运散货订单接口，当订单目的地址为第三方仓库时，增加第三方联系人信息字段（third_company_name，third_first_name，third_phone，third_email）

4.创建空运、快递、整柜、海运散货订单接口，私人地址：邮箱、联系电话修改为必填项

2021-10-25

海运散货接口增加对自定义报关抬头的支持（customs_title）

2021-06-24

空运、快递、海运散货接口增加对自定义私人地址的支持（shipping_location）
修正返回接口参数必要性说明

2021-06-18

补充了商品信息中箱数（pack_infos.box_count）格式的说明
补充了FBA参考号（fba_refercode2_arr）必填说明
新增整柜海运下单接口
新增获取港口信息接口
新增获取整柜增值服务接口

接入指南

接入API对接平台开发，开发者需要按照如下步骤完成：

1.注册跨鲸账号，在发起注册后联系跨鲸工作人员审核账户后既可登录跨鲸平台

2．访问https://www.kjing.com/login 登录跨鲸平台

3．进入菜单栏【信息管理】-【个人信息】，即可获得账号AppToken和AppKey

4．接入认证

（1）本API基于Basic认证，在请求头Head中需添加Authorization参数,Authorization 值为："Basic用户名和密码的base64加密字符串"；

示例代码如下：


						string username="AppToken";  //系统个人信息中的AppToken
						string password="AppKey";    //系统个人信息中的AppKey
						string usernamePassword = username + ":" + password; //注意这里的格式，为 "username:password"
						CredentialCache mycache = new CredentialCache();
						mycache.Add(new Uri(url), "Basic", new NetworkCredential(username, password));
						myReq.Credentials = mycache;
						myReq.Headers.Add("Authorization", "Basic " + Convert.ToBase64String(new ASCIIEncoding().GetBytes(usernamePassword)));

（2）JSON格式传输，需在请求头Head增加参数 Content-Type参数，值为“application/json” ；

公共请求信息

请求参数

Headers

参数名称	类型	参数值	是否必须	描述
Content-Type	String	Basic *******	是	请求认证
Authorization	String	application/json	是	请求内容类型

Query

参数名称	类型	参数值	是否必须	描述
dataType	String	json	是	提交的数据类型

Body

参数	类型	值	必填项	描述
Data	object	{}	必须	提交数据类型
Version	string	0.03 \|0.0.4\|0.0.5	必须	接口版本号
RequestTime	Numbe	1577084088	必须	请求发起时间
RequestId	string	fa0b38da-271f-41c0-87c9-b057a41bba07	必须	唯一请求标识符（无限制格式）

response公共参数

参数	类型	是否必须	描述
Version	string	必须	请求版本
ResponseTime	Number	必须	响应时间
RequestId	string	必须	请求ID
ResponseId	string	必须	响应ID
ResponseResult	number	必须	响应状态
ResponseError	string/object	必须	错误信息
ResponseError.code	string		错误长代码
ResponseError.ShortMessage	string		错误短信息
ResponseError.LongMessage	String		错误长信息
Data	string/object	必须	返回数据

最佳实践

说明：跨鲸开放服务平台提供完善的API接口服务，客户系统与跨鲸国际头程物流系统无缝衔接

客户系统只需对接与跨鲸国际头程物流系统创建订单、货物测量信息、获取物流轨迹等信息接口即可完成相关操作或信息获取。

1．获取基本信息：

（1）服务方式、额外服务、海运整柜增值服务、港口信息

（2）FBA仓库地址、第三方仓库地址、私人收货地址

（3）上传文件：装箱单、退税报关文件

（4）获取上门提货地址、获取自送仓库地址

2．创建订单

3．获取货物测量信息

4．获取物流轨迹信息

获取服务方式

基本信息

Path： /api/get_service?dataType=json

Method： POST

接口描述：

该接口用于获取不同运输方式下的服务方式

请求体：

{
  "Data": {
    "product_code": "KY"
  },
  "Version": "0.0.3",
  "RequestTime": "1577084088",
  "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": [
        {
            "id": 330,
            "cnname": "美国FBA空运+卡（FTW1特价专线）-美西E",
            "country": [
                "US"
            ]
        }
    ]
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		提交数据
├─ product_code	string	必须		运输方式代码	枚举: SHHY,KY,KD,SHFBA,KYFBA,KDFBA 枚举备注: SHHY=海运散货； KY=空运； KD=快递； SHFBA=FBA海运散货； KYFBA=FBA空运； KDFBA=FBA快递； mock: SHHY
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3,0.0.4 mock: 0.0.3
RequestTime	string	必须		请求发起时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号	mock: 0.0.3
ResponseTime	string	必须		响应时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须		唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须		请求响应ID	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须		简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须		详细错误信息	mock: 服务器异常，请稍后重试
Data	object []	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集	item 类型: object
├─ id	number	非必须		数据id	mock: 333
├─ cnname	string	非必须		服务中文名称	mock: KA01-美国空加派（普货）
├─ country	string []	非必须		服务国家二字代码集合	item 类型: string
├─		非必须		服务国家二字代码

获取额外服务

基本信息

Path： /api/get_extraservice?dataType=json

Method： POST

接口描述：

获取不同运输方式所拥有的额外服务包括但不限于报关方式、打托服务、清关方式、派车服务、增值服务等

请求体：

{
    "Data": {
        "product_code": "SHHY"
    },
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616573452,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "8c509f52-5b9f-d143-d6e2-62d5916060ca",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": {
        "customs": [
            "EDI declar"
        ],
        "value-add": [
            "departure"
        ],
        "clearance": [
            "own-tax"
        ],
        "trailer": [
            "pick-door"
        ],
        "others": [
            "fumigation"
        ]
    }
}

响应失败示例：

{
    "Version":"0.0.3",
    "ResponseTime":1616570759,
    "RequestId":"fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId":"28dc5200-4d10-f3d0-cfe5-1ee151639c2e",
    "Data":"",
    "ResponseResult":0,
    "ResponseError":{
        "Code":"0x00999999",
        "ShortMessage":"服务器异常，请稍后重试",
        "LongMessage":"服务器异常，请稍后重试"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		提交数据
├─ product_code	string	必须		运输方式代码	枚举: ZGHY,SHHY,KY,KD,SHFBA,KYFBA,KDFBA 枚举备注: ZGHY=海运整柜； SHHY=海运散货； KY=空运； KD=快递； SHFBA=FBA海运散货； KYFBA=FBA空运； KDFBA=FBA快递；
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3,0.0.4
RequestTime	string	必须	1618899866	请求发起时间
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	唯一请求标识

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号
ResponseTime	string	必须		响应时间
RequestId	string	必须		唯一请求标识
ResponseId	string	必须		唯一响应标识
ResponseResult	number	必须		响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待；
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码
├─ ShortMessage	string	非必须		简短错误信息
├─ LongMessage	string	非必须		详细错误信息
Data	object	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ customs	string []	必须		报关方式	item 类型: string
├─		非必须			枚举: EDI declar,commission,pay_tax,themselves 枚举备注: EDI declar=买单报关；commission=退税报关；pay_tax=买单+退税报关；themselves=报关自理
├─ value-add	string []	必须		打托服务	item 类型: string
├─		非必须			枚举: departure,destion,tariff-pre 枚举备注: departure=起运港打托；destion=目的港打托；tariff-pre=关税预付；
├─ clearance	string []	必须		清关方式	item 类型: string
├─		非必须			枚举: own-tax,edi-tax 枚举备注: own-tax=自有税号清关；edi-tax=跨鲸税号清关；
├─ trailer	string []	必须		派车服务	item 类型: string
├─		非必须			枚举: pick-door,self_drive 枚举备注: pick-door=上门提货；self_drive=自送
├─ others	string []	必须		增值服务	item 类型: string
├─		非必须			枚举: fumigation,origin_crt,world_ease, post_check,make_appointment,carry,check_fee, tax_fee,up_fee,addr_type_commercial, addr_type_residential, business_fee,commodity_inspection, isf_report 枚举备注: fumigation=熏蒸；origin_crt=产地证；world_ease=world_ease服务；post_check=偏远邮编校；make_appointment=预约送货；carry=搬运服务；check_fee=包查验费；tax_fee=包税费；up_fee=保险服务；addr_type_commercial=商业地址；addr_type_residential=住宅地址；business_fee=商检服务；commodity_inspection=商检服务；isf_report=ISF申报

获取整柜增值服务

基本信息

Path： /api/get_hyzg_others?dataType=json

Method： POST

接口描述：

获取整柜海运下不同服务方式所拥有的增值服务（区别于额外服务，额外服务包含增值服务）

请求体：

{
  "Data": {
    "service_id": 127
  },
  "Version": "0.0.3",
  "RequestTime": "1618899866",
  "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616573452,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "8c509f52-5b9f-d143-d6e2-62d5916060ca",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": {
        "others": [
            "order",
            "transfer_order"
        ]
    }
}

响应失败示例：

{
    "Version":"0.0.3",
    "ResponseTime":1616570759,
    "RequestId":"fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId":"28dc5200-4d10-f3d0-cfe5-1ee151639c2e",
    "Data":"",
    "ResponseResult":0,
    "ResponseError":{
        "Code":"0x00999999",
        "ShortMessage":"服务器异常，请稍后重试",
        "LongMessage":"服务器异常，请稍后重试"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		提交数据
├─ service_id	number	必须	127	服务方式id
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3
RequestTime	string	必须	1618899866	请求发起时间
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	唯一请求标识

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号
ResponseTime	string	必须		响应时间
RequestId	string	必须		唯一请求标识
ResponseId	string	必须		唯一响应标识
ResponseResult	number	必须		响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待；
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码
├─ ShortMessage	string	非必须		简短错误信息
├─ LongMessage	string	非必须		详细错误信息
Data	object	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ others	string []	必须		增值服务集合	item 类型: string
├─		非必须		增值服务	枚举: fumigation,origin_crt,world_ease,post_check,make_appointment, carry,check_fee,tax_fee,up_fee,addr_type_commercial, addr_type_residential,business_fee, commodity_inspection,isf_report 枚举备注: fumigation=熏蒸；origin_crt=产地证；world_ease=world_ease服务；post_check=偏远邮编校；make_appointment=预约送货；carry=搬运服务；check_fee=包查验费；tax_fee=包税费；up_fee=保险服务；addr_type_commercial=商业地址；addr_type_residential=住宅地址；business_fee=商检服务；commodity_inspection=商检服务；isf_report=ISF申报

获取自送仓库地址

基本信息

Path： /api/get_freight_depot?dataType=json

Method： POST

接口描述：

获取自送货物（将货物由私有仓库运送到跨鲸国内仓库）仓库信息

请求体：

{
    "Data": {},
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": [
        {
            "id": 7,
            "contact": "欧阳",
            "province": "广东省",
            "city": "深圳市",
            "address": "深圳市龙华新区民治大道20号",
            "postcode": "83455",
            "cellphone": "14789837087",
            "depot_name": "深圳仓库"
        }
    ]
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3,0.0.4 mock: 0.0.3
RequestTime	string	必须		请求发起时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	备注	其他信息
Version	string	必须	接口版本号	mock: 0.0.3
ResponseTime	number	必须	响应时间	mock: 1618899866
RequestId	string	必须	唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须	唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须	响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须	响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须	错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须	简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须	详细错误信息	mock: 服务器异常，请稍后重试
Data	object []	必须	响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集	item 类型: object
├─ id	number	非必须	数据id	mock: 7
├─ contact	string	非必须	联系人	mock: 欧阳
├─ province	string	非必须	仓库所在省	mock: 广东省
├─ city	string	非必须	仓库所在市	mock: 深圳市
├─ address	string	非必须	详细地址	mock: 深圳市龙华新区民治大道20号
├─ postcode	string	非必须	邮编	mock: 83455
├─ cellphone	string	非必须	联系电话	mock: 14789837087
├─ depot_name	string	非必须	仓库名称	mock: 深圳仓库

获取FBA仓库地址（目的地）

基本信息

Path： /api/get_fbawarehouse?dataType=json

Method： POST

接口描述：

获取目的地FBA仓库（亚马逊运营的仓库）地址信息

请求体：

{
    "Data": {},
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": [
        {
            "id": 1,
            "name": "深圳坂田仓库",
            "country_cnname": "中国",
            "province": "广东省",
            "city": "深圳市",
            "postcode": "54553",
            "address": "深圳市龙华新区民治街道20号向南商业大厦6楼601室"
        }
    ]
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须
Version	string	必须	0.0.1	接口版本号	枚举: 0.0.3,0.0.4 mock: 0.0.3
RequestTime	string	必须		请求发起时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.1	接口版本号	mock: 0.0.3
ResponseTime	number	必须		响应时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须		唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须		响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须		简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须		详细错误信息	mock: 服务器异常，请稍后重试
Data	object []	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集	item 类型: object
├─ id	number	非必须		数据id	mock: 1
├─ name	string	非必须		仓库名称	mock: 深圳坂田仓库
├─ country_cnname	string	非必须		仓库所在国家中文成名	mock: 中国
├─ province	string	非必须		所在省	mock: 广东省
├─ city	string	非必须		所在市	mock: 深圳市
├─ postcode	string	非必须		邮编	mock: 54553
├─ address	string	非必须		详细地址	mock: 深圳市龙华新区民治街道20号向南商业大厦6楼601室

获取第三方仓库信息（目的地）

基本信息

Path： /api/get_thirdwarehouse?dataType=json

Method： POST

接口描述：

获取目的地第三方仓库（谷仓等其他第三方运营的仓库）地址信息

请求体：

{
    "Data": {},
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": [
        {
        	"id": 3,
            "depot_name": "澳洲仓",
            "country_cnname": "美国",
            "country_code": "US",
            "depot_province": "澳大利亚联邦",
            "depot_city": "Commonwealth of Australia",
            "depot_address": "3/70 Rowland AveWollongong  NSW 2500Australia",
            "depot_post_code": "748541"
        }
    ]
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		请求提交的数据
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3 枚举备注: format: 0.0.3 mock: 0.0.3
RequestTime	string	必须	1618899866	请求的时间戳	最大长度: 10 最小长度: 10 mock: 1618899866
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	请求的唯一标识符	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3 mock: 0.0.3
ResponseTime	number	必须	1618899866	响应时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须		唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须		响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须		简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须		详细错误信息	mock: 服务器异常，请稍后重试
Data	object []	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集	item 类型: object
├─ id	number	非必须		数据id	mock: 3
├─ depot_name	string	非必须		仓库名称	mock: 澳洲仓
├─ country_cnname	string	非必须		仓库所在国家中文成名	mock: 美国
├─ country_code	string	非必须		仓库所在国家二字代码	mock: US
├─ depot_province	string	非必须		仓库所在省	mock: 澳大利亚联邦
├─ depot_city	string	非必须		仓库所在市	mock: Commonwealth of Australia
├─ depot_address	string	非必须		仓库所在详细地址	mock: 3/70 Rowland AveWollongong NSW 2500Australia
├─ depot_post_code	string	非必须		仓库所在地址邮编	mock: 748541

获取私人收货地址（目的地）

基本信息

Path： /api/get_shipping_location?dataType=json

Method： POST

接口描述：

获取私人目的地地址详情

请求体：

{
    "Data": {},
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": [
        {
            "id": 6256,
            "company_name": "测试",
            "country_cnname": "美国",
            "first_name": "测试",
            "phone": "18802537024",
            "address": "DFG",
            "postcode": "10001",
            "city": "SDFG",
            "province": "洛杉矶",
            "email": ""
        }
    ]
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		请求提交数据
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3,0.0.4 mock: 0.0.3
RequestTime	string	必须	1618899866	请求发起时间（Unix时间戳）	最大长度: 10 最小长度: 10 mock: 1618899866
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	请求唯一标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号	mock: 0.0.3
ResponseTime	number	必须		响应时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须		唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须	1	响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须		简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须		详细错误信息	mock: 服务器异常，请稍后重试
Data	object []	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集	item 类型: object
├─ id	number	非必须		数据id	mock: 5760
├─ company_name	string	非必须		收件公司名称	mock: 纵腾网络有限公司
├─ country_cnname	string	非必须		收件地址所在国家中文成名	mock: 安道尔
├─ first_name	string	非必须		收件人名字	mock: 纵腾
├─ phone	string	非必须		联系电话	mock: 0755-23769793
├─ address	string	非必须		详细地址	mock: 深圳民治地铁站
├─ postcode	string	非必须		邮编	mock: 95249
├─ city	string	非必须		所在市	mock: 深圳市
├─ province	string	非必须		所在省	mock: 广东
├─ email	string	非必须		邮箱	mock: zongteng@163.com

获取提货地址

基本信息

Path： /api/get_pickup_location?dataType=json

Method： POST

接口描述：

获取上门提货的地址详情

请求体：

{
    "Data": {},
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": [
        {
            "id": 140,
            "name": "爱丽丝",
            "phone": "13522002200",
            "address": "深圳市罗湖区深南大道26778号京基100"
        }
    ]
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		请求提交数据
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3,0.0.4 mock: 0.0.3
RequestTime	string	必须	1618899866	请求发起时间（Unix时间戳）	最大长度: 10 最小长度: 10 mock: 1618899866
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	请求唯一标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3,0.0.4 mock: 0.0.3
ResponseTime	number	必须		响应时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须		唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须		响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须		简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须		详细错误信息	mock: 服务器异常，请稍后重试
Data	object []	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集	item 类型: object
├─ id	number	非必须		数据id	mock: 89
├─ name	string	非必须		提货人姓名	mock: 李世民
├─ phone	string	非必须		联系电话	mock: 15888888888
├─ address	string	非必须		详细地址	mock: 西安大明宫

获取港口信息

基本信息

Path： /api/get_port?dataType=json

Method： POST

接口描述：

获取海运整柜运输方式下的港口信息（包括始发港和目的港）

请求体：

{
  "Data": {
    "type": "2",
    "country_code": "AD"
  },
  "Version": "0.0.3",
  "RequestTime": "1618899866",
  "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616573452,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "8c509f52-5b9f-d143-d6e2-62d5916060ca",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": [
        {
            "id": 2,
            "type": 1,
            "port_enname": null,
            "port_name": "深圳蛇口港",
            "port_country": "MO",
            "port_province": "澳大",
            "port_city": "澳洲",
            "port_address": "澳门赌场",
            "port_post_code": "32125615"
        }
    ]
}

响应失败示例：

{
    "Version":"0.0.3",
    "ResponseTime":1616570759,
    "RequestId":"fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId":"28dc5200-4d10-f3d0-cfe5-1ee151639c2e",
    "Data":"",
    "ResponseResult":0,
    "ResponseError":{
        "Code":"0x00999999",
        "ShortMessage":"服务器异常，请稍后重试",
        "LongMessage":"服务器异常，请稍后重试"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		提交数据
├─ type	string	必须	1	港口类型	枚举: 1,2 枚举备注: 1=起运港；2=目的港 mock: 1
├─ country_code	string	非必须	AD	仓库所在国家二字代码	mock: AD
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3 mock: 0.0.3
RequestTime	string	必须	1618899866	请求发起时间	mock: 1618899866
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.1	接口版本号	mock: 0.0.3
ResponseTime	string	必须		响应时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须		唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须		请求响应ID	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须		简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须		详细错误信息	mock: 服务器异常，请稍后重试
Data	object []	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集	item 类型: object
├─ id	number	非必须		数据id
├─ type	number	非必须		港口类型	枚举: 1 枚举备注: 1=起运港；2=目的港
├─ port_enname	string	非必须		港口英文名
├─ port_name	string	非必须		港口中文名
├─ port_country	string	非必须		港口所在国家二字代码
├─ port_province	string	非必须		港口所在省
├─ port_city	string	非必须		港口所在市
├─ port_address	string	非必须		港口详细地址
├─ port_post_code	string	非必须		港口邮编

上传文件接口

基本信息

Path： /api/upload_file?dataType=json

Method： POST

接口描述：

上传附件，并返回附件ID，配合其他业务接口使用

请求体：

{
    "Data": {
        "file_type": 12,
        "file_extension": "xlsx",
        "file_data": "Base64_str"  //此处替换base64文件流
    },
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version":"0.0.3",
    "ResponseTime":1616572880,
    "RequestId":"fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId":"a2e6e148-6990-155b-6909-f19f0c8a40a4",
    "ResponseResult":1,
    "ResponseError":"",
    "Data":{
        "file_id":33436
    }
}

响应失败示例：

{
    "Version":"0.0.3",
    "ResponseTime":1616570759,
    "RequestId":"fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId":"28dc5200-4d10-f3d0-cfe5-1ee151639c2e",
    "Data":"",
    "ResponseResult":0,
    "ResponseError":{
        "Code":"0x00999999",
        "ShortMessage":"服务器异常，请稍后重试",
        "LongMessage":"服务器异常，请稍后重试"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	备注	其他信息
Data	object	必须
├─ file_type	string	必须	文件类型	枚举: 0,1,9,12 枚举备注: 0=报关资料；1=发票；9=装箱单；12=买单报关 mock: 0
├─ file_extension	string	必须	文件后缀	枚举: zip,rar,xls,xlsx 枚举备注: 报关资料=[zip,rar]，不超过3M；发票=[xls,xlsx]，不超过3M；装箱单=[xls,xlsx]，不超过3M mock: rar
├─ file_data	string	必须	base64文件流
Version	string	必须	接口版本号	枚举: 0.0.3,0.0.4 mock: 0.0.3
RequestTime	string	必须	请求发起时间	mock: 1577084088
RequestId	string	必须	唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	备注	其他信息
Version	string	必须	接口版本号	枚举: 0.0.3,0.0.4 mock: 0.0.3
ResponseTime	number	必须	响应时间	mock: 1577084088
RequestId	string	必须	唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须	唯一响应标识	mock: a2e6e148-6990-155b-6909-f19f0c8a40a4
ResponseResult	number	必须	指请求是否被成功执行：Failure=0 失败；Success=1 成功；Pending=2 等待	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须	响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须	错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须	简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须	详细错误信息	mock: 服务器异常，请稍后重试
Data	object	必须	响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ file_id	number	非必须	文件上传成功后返回的文件信息ID	mock: 33436

创建空运订单

基本信息

Path： /api/createByAir?dataType=json

Method： POST

接口描述：

空运订单下单接口

请求体：

{
  "Data": {
    "product_code": "KY",
    "country": "AD",
    "service_id": "148",
    "weight": "111",
    "volume": "222",
    "mail_cargo_type": [
      "1",
      "5"
    ],
    "battery_type": [],
    "battery_model": [],
    "battery_volume": [],
    "battery_voltage": [],
    "fba_warehouseid": "",
    "shipping_id": "",
    "customs": "EDI declar",
    "clea_id": "",
    "clearance": "edi-tax",
    "tax_file_number": "跨鲸",
    "clearance_company": "跨鲸",
    "clearance_contact_information": "跨鲸",
    "clearance_company_address":'',
    "extra_tax_number" : {
        "IRS税号" : "GB297025190000",
        "VAT税号": "GB297025190",
        "EORI税号": "GB297025190000",
        "增值税号" : "GB297025190",
        "欧盟税号" : "GB297025190000",
    },
    "others": [],
    "trailer": "self_drive",
    "pick_id": [],
    "pick_time": "",
    "freight_id": "",
    "self_delivery_freight_id": "7",
    "destination_address": "THIRDPARTY",
    "shipping_warehouseid": "9",
    "note": "",
    "is_pva":'0',
    'pva_id':'',
    "pack_infos": [
      {
        "box_number": "aaa",
        "fba_reference_id": "fbassa",
        "box_count": "1-90",
        "cargo_enname": "英文名称11",
        "cargo_cnname": "中文名称1",
        "num": "1100",
        "unit": "pcs(个)",
        "price": "12.5",
        "ner_weight": "17.5",
        "rough_weight": "100.2",
        "volume":"12.3",
        "texture": "材质1",
        "brand": "品牌1",
        "model": "用途1",
        "purpose": "用途1",
        "hs_code": "124151",
        "image": "",
        "company_enname": "",
        "company_enaddress": "",
        "volume": 12.3,
        "remark": "备注1",
      },
      {
        "box_number": "aaa",
        "fba_reference_id": "",
        "box_count": "1-88",
        "cargo_enname": "英文名称11",
        "cargo_cnname": "中文名称1",
        "num": "1100",
        "unit": "pcs(个)",
        "price": "12.5",
        "ner_weight": "17.5",
        "rough_weight": "100.2",
        "volume":"12.3",
        "texture": "材质1",
        "brand": "品牌1",
        "model": "用途1",
        "purpose": "用途1",
        "hs_code": "111111.5",
        "image": "",
        "company_enname": "",
        "company_enaddress": "公司地址1",
        "volume": 12.3,
        "remark": "备注2",
      }
    ],
    "third_company_name": "dolor officia pariatur commodo minim",
    "third_first_name": "aliqua non qui dolore",
    "third_phone": "15966555853",
    "third_email": "iii@136.com"
  },
  "Version": "0.0.3",
  "RequestTime": "1577084088",
  "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": {
        "shipper_hawbcode": "KJF82712103246731G"
    }
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是	Basic MGIyNjU4ZTgzZmEzMmU2Y2U2NmQ3OWQ3YzdlNGU2NGM6ZTA3NGMxMTQ2OTNmZTM4OTM0YWQyNjgyYmM4M2Y4YjU=	认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须
├─ product_code	string	必须	KY	运输方式代码	枚举: KY,KYFBA 枚举备注: KY=空运； KYFBA=FBA空运；
├─ country	string	必须	us	收件人的国家二字码；例：美国填写US	枚举备注:
├─ service_id	string	必须	339	服务方式id：获取服务方式接口返回的id
├─ volume	number	必须		预报体积（单位：m³）	最大值: 1000 最小值: 0.01
├─ weight	number	必须		预报重量（单位：kg）	最大值: 100000 最小值: 0.01
├─ mail_cargo_type	string []	必须		货物类型：可传多个值 1=普货； 2=内置电池； 3=配套电池； 4=纯电池； 5=易碎物品； 6=纺织品； 7=带磁；	item 类型: string
├─		非必须	1	货物类型
├─ battery_type	string []	非必须		电池类型集合：当货物类型包含内置电池，配套电池或纯电池三个中的任何一种时必填 1=PI965； 2=PI966； 3=PI967； 4=PI969； 5=PI970； 6=UN3480； 7=UN3481； 8=UN3090； 9=UN3091； 10=其他；	item 类型: string
├─		非必须	1	电池类型
├─ battery_model	string []	非必须		电池型号集合子元素字符限制：0 ~ 20个字	item 类型: string
├─		非必须	南孚	电池型号
├─ battery_volume	string []	非必须		电池容量集合	item 类型: string
├─		非必须	240AM	电池容量
├─ battery_voltage	string []	非必须		电池容量集合元素字符限制：0 ~ 20个字	item 类型: string
├─		非必须	240v	电池伏数
├─ pickup_type	number	非必须	5	提单类型（海运散货和FBA海运散货必填，空运、快递、FBA空运、FBA快递非必填）	最大值: 999 最小值: 0
├─ fba_warehouseid	string	非必须	13	FBA仓库地址id，FBA订单（即product_code为FBA海运散货、FBA空运、FBA快递）时，该参数必填
├─ shipping_id	string	非必须	5695	目的地私人收货地址id：调用获取私人收货地址（目的地）接口返回的地址id，destination_address =PERSONAL时，该参数或shipping_location必填其一
├─ shipping_location	object	非必须		私人收货地址集合(新增私人收货地址)：当该值存在时则shipping_id无效
├─ company_name	string	必须	Geek X Technology Inc.	收货公司	最大长度: 100 最小长度: 0
├─ first_name	string	必须	Derek Chen	收件人名	最大长度: 100 最小长度: 0
├─ phone	string	必须	+1 (469) 545-4888	收件人联系方式	最大长度: 50 最小长度: 0
├─ email	string	必须	adamx0413@gmail.com	收件人邮箱	最大长度: 100 最小长度: 0
├─ postcode	string	必须	75229	收件地址邮编（国家为美国时，填写的格式为5位数字/5位数字-4位）	最大长度: 50 最小长度: 0
├─ country_code	string	必须	us	收件地址所在国家二字代码	最大长度: 2 最小长度: 0
├─ province	string	必须	ASPV-洛杉矶	收件地址所在省	最大长度: 50 最小长度: 0
├─ city	string	必须	Dallas	收件地址所在市	最大长度: 50 最小长度: 0
├─ address	string	必须	11410 Grissom ln	收件详细地址	最大长度: 200 最小长度: 0
├─ customs	string	必须	EDI declar	报关方式	枚举: EDI declar,commission 枚举备注: EDI declar=买单报关； commission=退税报关；
├─ clea_id	string	非必须	23154	报关资料id上传退税报关资料返回的id（类型：报关资料）；customs包含退税报关时必填，支持zip、rar文档上传
├─ clearance	string	必须	edi-tax	清关方式	枚举: own-tax,edi-tax 枚举备注: own-tax=自有税号清关； edi-tax=跨鲸税号清关；
├─ tax_file_number	string	非必须	跨鲸	清关税号：清关方式为own-tax时，填写自有清关税号；清关方式为edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_company	string	非必须	跨鲸	清关公司名称：清关方式为own-tax时，填写自有清关公司名称；清关方式为edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_contact_information	string	非必须	跨鲸	税号公司联系方式：清关方式为own-tax时，填写公司联系方式；清关方式为edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_company_address	string	非必须	跨鲸	税号公司地址：清关方式为own-tax时，填写公司地址；	最大长度: 200 最小长度: 0
├─ others	string []	必须		增值服务集合：无需增值服务时，该参数置空既："others" = [] fumigation=熏蒸； origin_crt=产地证； world_ease=world_ease服务； post_check=偏远邮编校； make_appointment=预约送货； carry=搬运服务； check_fee=包查验费； tax_fee=包税费； up_fee=保险服务； addr_type_commercial=商业地址； addr_type_residential=住宅地址； business_fee=商检服务； commodity_inspection=商检服务； isf_report=ISF申报	item 类型: string
├─		非必须	fumigation	增值服务
├─ trailer	string	必须	self_drive	派车服务	枚举: pick-door,self_drive 枚举备注: pick-door=上门提货； self_drive=自送；
├─ pick_id	number []	非必须		提货地址id：获取提货地址中的接口返回的id，如果派车服务选择上门提货（pick-door），则该字段为必填，可传多个值	item 类型: number
├─		非必须	89
├─ pick_time	string	非必须	2022-12-24 17:21:10	提货时间：如果派车服务选择上门提货（pick-door），则该字段为必填，格式“2019-12-24 17:21:10”
├─ freight_id	string	非必须	1	送货仓库id：获取仓库地址接口中返回的仓库id，如果派车服务选择上门提货（pick-door），则该字段为必填
├─ self_delivery_freight_id	string	非必须	7	自送仓库id：获取仓库地址接口中返回的仓库id，派车服务选择自送（self_drive），则该字段为必填
├─ note	string	非必须	自动化测试	备注信息	最大长度: 200 最小长度: 0
├─ destination_address	string	必须	PERSONAL	目的地址类型；FBA订单时，该值只能为FBA	枚举: FBA,THIRDPARTY,PERSONAL 枚举备注: FBA=FBA地址； THIRDPARTY=第三方仓库； PERSONAL=私人地址；
├─ shipping_warehouseid	string	非必须	95614	目的地第三方仓库id：调用获取第三方仓库地址接口返回的仓库id，destination_address =THIRDPARTY时，该参数必填
├─ pack_infos	object []	非必须		货物详细信息集合：运输方式为KY=空运、KYFBA=FBA空运、SHHY=海运、SHFBA=FBA海运时，若使用pack_info传递商品信息则pack_id=""即可	最小数量: 1 item 类型: object
├─ box_count	string	必须	1-90	箱号：支持格式如下：n1-n2或n1-n1或n1（n1,n2...均为正整数）
├─ cargo_enname	string	必须	shipping labels	商品英文名称
├─ cargo_cnname	string	必须	标签纸	商品中文名称
├─ num	string	必须	1	数量
├─ unit	string	必须		计量单位	枚举: bag(包/袋),set(台),set(座),set(架),set(套),set(部),set(亿),unit(辆/艘),pcs(个),pcs(只),pcs(件),pcs(支),pcs(枝),pcs(把),head(头),sheet(张),stick(根),bar(条),block(块),coil(卷/盘),pair(副/双),group(组),ration(份),couple(对),komg(井),meter(米),square meter(平方米),cubic meter(立方米),cone(筒),cone(筒),g(克),basin(盆),ten thousand(万个),hundred pairs(百副/百双),hundred pcs(百支/百把/百个/百片),bolt(疋/匹),quintal(公担),thousand pcs(千只/千枝/千个),thousand block(千块),thousand box(千盒),hundred million pcs(亿支/亿个),hundred million set(万套),thousand sheet(千张),thousand sheet(千张),kilowatt-ampere(千伏安),kilowatt(千瓦),kilowatt-hour(千瓦时),thousand liter(千升),foot(英尺),metric ton(吨),long ton(长吨),short ton(短吨),picul(司马担),jin(斤),pound(磅),hundred pounds(担),uk hundred-weight(英担),short hundred weight(短担),liang(两),dan(市担),ounce(盎司),carat(克拉),chi(市尺),yard(码),cun(寸),liter(升),milliliter(毫升),uk gallon(英加仑),us gallon(美加仑),cubic foot(立英方尺),cubic chi(立方尺),square yard(平方码),square foot(平方英尺),square chi(平方尺),uk horsepower(英制马力),metric horsepower(公制马力),link(令),box(箱/盒),batch(批),can(罐),barrel(桶),bundle(扎/捆),basket(萝/筐),dozen(打),gross(罗),book(册/本),sheel(发),grain(粒),he(合),bottle(瓶),ten thousand pair(万双),ten thousand grain(万粒),thousand grain(千粒),km(千米),thousand feet(千英尺),million ba(百万贝可)
├─ price	string	必须	250	申报单价
├─ ner_weight	number	必须		商品总净重（单位：kg）
├─ rough_weight	number	必须		整箱毛重（单位：kg）
├─ texture	string	必须	纸	材质
├─ brand	string	必须	飞书	品牌
├─ model	string	必须	2564	型号
├─ purpose	string	必须	打印	用途
├─ hs_code	string	必须	56415616	海关编码
├─ image	string	非必须	http://10.100.1.158/#/cases	商品链接
├─ company_enname	string	非必须	彼得纸业	工厂名
├─ company_enaddress	string	非必须	银河系地球村	工厂地址
├─ box_number	string	必须		客户参考号（目的国家为美国且目的地址为FBA地址时，箱唛格式为FBA+9个英文数字）
├─ fba_reference_id	string	非必须		FBA参考号（部分服务方式要求必填）
├─ third_company_name	string	非必须	爱豆传媒影视有限公司	第三方仓库联系方式信息-公司名（当「destination_address」参数值为「THIRDPARTY」时必填）	最大长度: 100 最小长度: 0
├─ third_first_name	string	非必须	波哥	第三方仓库联系方式信息-姓名（当「destination_address」参数值为「THIRDPARTY」可以传值，也可为空）	最大长度: 100 最小长度: 0
├─ third_phone	string	非必须	13734884521	第三方仓库联系方式信息-电话（当「destination_address」参数值为「THIRDPARTY」可以传值，也可为空）	最大长度: 50 最小长度: 0
├─ third_email	string	非必须	admin@163.com	第三方仓库联系方式信息-邮箱，值必须为正确的邮箱格式（当「destination_address」参数值为「THIRDPARTY」时必填）	format: email
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3
RequestTime	string	必须	1611626055	请求发起时间
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	唯一请求标识

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号
ResponseTime	string	必须		响应时间
RequestId	string	必须		唯一请求标识
ResponseId	string	必须		唯一响应标识
ResponseResult	number	必须		请求响应结果	枚举: 0,1,2 枚举备注: 0：失败 1：成功 2：等待
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码
├─ ShortMessage	string	非必须		简短错误信息
├─ LongMessage	string	非必须		详细错误信息
Data	object	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ shipper_hawbcode	string	必须		运单号（订单号）

创建快递订单

基本信息

Path： /api/createExpress?dataType=json

Method： POST

接口描述：

快递订单下单接口

请求体：

{
    "Data": {
        "product_code": "KD",
        "country": "US",
        "service_id": "335",
        "fba_refercode_arr": ["FBAT5Uwd108133", "FBAT5Uwd108134"],
        "fba_refercode2_arr": ["FBA15G1"],
        "box_num_arr": ["90", "92"],
        "volume_arr": ["12.35", "15"],
        "weight_arr": ["25.66", "20"],
        "mail_cargo_type": ["1", "5"],
        "battery_type": ["1", "2"],
        "battery_model": ["model1", "model2"],
        "battery_volume": ["4000", "4200"],
        "battery_voltage": ["4.73", "3.7"],
        "fba_warehouseid": "78",
        "shipping_id": "",
        "customs": "EDI declar",
        "clea_id": "",
        "clearance": "edi-tax",
        "tax_file_number": "跨鲸",
        "clearance_company": "跨鲸",
        "clearance_contact_information": "跨鲸",
        "clearance_company_address":'',
        "extra_tax_number" : {
            "IRS税号" : "GB297025190000",
            "VAT税号": "GB297025190",
            "EORI税号": "GB297025190000",
            "增值税号" : "GB297025190",
            "欧盟税号" : "GB297025190000",
        },
        "value-add": "",
        "others": ["origin_crt", ],
        "trailer": "self_drive",
        "pick_id": ["1", "2"],
        "pick_time": "2019-12-24 17:21:10",
        "freight_id": "1",
        "self_delivery_freight_id": "7",
        "destination_address": "FBA",
        "shipping_warehouseid": "1",
        "note": "测试建单001",
        "third_company_name": "dolor officia pariatur commodo minim",
        "third_first_name": "aliqua non qui dolore",
        "third_phone": "15966555853",
        "third_email": "[iii@136.com](mailto:iii@136.com)",
        "is_pva":'0',
        'pva_id':'',
        "pack_infos": [{
            "box_count": "1-90",
            "cargo_enname": "英文名称1",
            "cargo_cnname": "中文名称1",
            "num": "1100",
            "unit": "pcs(个)",
            "price": "12.5",
            "texture": "材质1",
            "brand": "品牌1",
            "model": "用途1",
            "purpose": "用途1",
            "hs_code": "123",
        },
        {
            "box_count": "1-90",
            "cargo_enname": "英文名称1",
            "cargo_cnname": "中文名称1",
            "num": "1100",
            "unit": "pcs(个)",
            "price": "12.5",
            "texture": "材质1",
            "brand": "品牌1",
            "model": "用途1",
            "purpose": "用途1",
            "hs_code": "123"
        }],
    },
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": {
        "shipper_hawbcode": "KJF82712103246731G"
    }
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是	Basic MGIyNjU4ZTgzZmEzMmU2Y2U2NmQ3OWQ3YzdlNGU2NGM6ZTA3NGMxMTQ2OTNmZTM4OTM0YWQyNjgyYmM4M2Y4YjU=	认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须
├─ product_code	string	必须	KD	运输方式代码	枚举: KD,KDFBA 枚举备注: KD=快递； KDFBA=FBA快递；
├─ country	string	必须	US	收件人的国家二字码；例：美国填写US
├─ service_id	string	必须	335	服务方式id：获取服务方式接口返回的id
├─ fba_refercode_arr	string []	必须		客户参考号：客户自有箱号或者FBA单号，可以传多个值子元素限制：目的国为美国且地址为FBA时，格式为：FBA+9个英文数字	最小数量: 0 最大数量: 20 item 类型: string
├─		非必须	FBA66332555A	客户自有箱号或者FBA单号
├─ fba_refercode2_arr	string []	非必须		FBA参考号：尾程亚马逊预约的ID号，数组长度和客户参考号的数组长度一致（部分服务方式要求必填）	最小数量: 0 最大数量: 20 item 类型: string
├─		非必须	FBA66332556A	尾程亚马逊预约的ID号
├─ box_num_arr	integer []	必须		预报箱数（单位：箱）：可以传多个箱数。数组长度和客户参考号的数组长度一致子元素限制：只能是正整数	item 类型: integer
├─		非必须	90	只能是正整数
├─ volume_arr	number []	必须		预报体积（单位：m³）：可以传多个值，数组长度和客户参考号的数组长度一致子元素限制：支持两位小数的数字	最小数量: 1 最大数量: 9 item 类型: number
├─		非必须	45	支持两位小数的数字
├─ weight_arr	number []	必须		预报重量（单位：kg）：可以传多个值，数组长度和客户参考号的数组长度一致子元素限制：支持两位小数的数字	最小数量: 0 最大数量: 999 item 类型: number
├─		非必须	45	支持两位小数的数字
├─ mail_cargo_type	string []	必须		货物类型：可传多个值 1=普货； 2=内置电池； 3=配套电池； 4=纯电池； 5=易碎物品； 6=纺织品； 7=带磁；	item 类型: string
├─		非必须	2	货物类型
├─ battery_type	string []	非必须		电池类型集合：当货物类型包含内置电池，配套电池或纯电池三个中的任何一种时必填 1=PI965； 2=PI966； 3=PI967； 4=PI969； 5=PI970； 6=UN3480； 7=UN3481； 8=UN3090； 9=UN3091； 10=其他；	最小数量: 0 最大数量: 20 item 类型: string
├─		非必须	10	电池类型
├─ battery_model	string []	非必须		电池型号集合元素字符限制：0 ~ 20个字	最小数量: 0 最大数量: 99 item 类型: string
├─		非必须	小米	电池型号
├─ battery_volume	string []	非必须		电池容量集合元素字符限制：0 ~ 20个字	最小数量: 0 最大数量: 99 item 类型: string
├─		非必须	240V	电池容量
├─ battery_voltage	string []	非必须		电池伏数集合	最小数量: 0 最大数量: 9999 item 类型: string
├─		非必须	25V	电池伏数
├─ fba_warehouseid	string	必须	75
├─ shipping_id	string	非必须	5695	目的地私人收货地址id：调用获取私人收货地址（目的地）接口返回的地址id，destination_address =PERSONAL时，该参数或shipping_location必填其一
├─ shipping_location	object	非必须		私人收货地址集合(新增私人收货地址)：当该值存在时则shipping_id无效
├─ company_name	string	必须	Geek X Technology Inc.	收货公司	最大长度: 100 最小长度: 0
├─ first_name	string	必须	Derek Chen	收件人名	最大长度: 100 最小长度: 0
├─ phone	string	必须	+1 (469) 545-4888	收件人联系方式	最大长度: 50 最小长度: 0
├─ email	string	必须	adamx0413@gmail.com	收件人邮箱	最大长度: 100 最小长度: 0
├─ postcode	string	必须	75229	收件地址邮编（国家为美国时，填写的格式为5位数字/5位数字-4位）	最大长度: 50 最小长度: 0
├─ country_code	string	必须	US	收件地址所在国家二字代码	最大长度: 2 最小长度: 0
├─ province	string	必须	ASPV-洛杉矶	收件地址所在省	最大长度: 50 最小长度: 0
├─ city	string	必须	Dallas	收件地址所在市	最大长度: 50 最小长度: 0
├─ address	string	必须	11410 Grissom ln	收件详细地址	最大长度: 200 最小长度: 0
├─ customs	string	必须	EDI declar	报关方式	枚举: EDI declar,commission,themselves 枚举备注: EDI declar=买单报关； commission=退税报关； themselves=报关自理；
├─ clea_id	string	非必须	23453	报关资料id上传退税报关资料返回的id（类型：报关资料）；customs包含退税报关时必填，支持zip、rar文档上传
├─ clearance	string	必须	edi-tax	清关方式	枚举: own-tax,edi-tax 枚举备注: own-tax=自有税号清关； edi-tax=跨鲸税号清关；
├─ tax_file_number	string	非必须	跨鲸	清关税号：clearance = own-tax时，填写自有清关税号；clearance = edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_company	string	非必须	跨鲸	清关公司名称：clearance = own-tax时，填写自有清关公司名称；clearance = edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_contact_information	string	非必须	跨鲸	税号公司联系方式：clearance = own-tax时，填写公司联系方式；clearance = edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_company_address	string	非必须	跨鲸	税号公司地址：clearance = own-tax时，填写公司地址；	最大长度: 200 最小长度: 0
├─ value-add	string	非必须	departure	打托服务	枚举: departure,destion,tariff-pre 枚举备注: departure=起运港打托； destion=目的港打托； tariff-pre=关税预付；
├─ others	string []	必须		增值服务集合：无需增值服务时，该参数置空既："others" = [] fumigation=熏蒸； origin_crt=产地证； world_ease=world_ease服务； post_check=偏远邮编校； make_appointment=预约送货； carry=搬运服务； check_fee=包查验费； tax_fee=包税费； up_fee=保险服务； addr_type_commercial=商业地址； addr_type_residential=住宅地址； business_fee=商检服务； commodity_inspection=商检服务； isf_report=ISF申报	item 类型: string
├─		非必须	fumigation	增值服务
├─ trailer	string	必须	pick-door	派车服务	枚举: pick-door,self_drive 枚举备注: pick-door=上门提货； self_drive=自送；
├─ pick_id	number []	非必须		提货地址id：获取提货地址中的接口返回的id，如果派车服务选择上门提货（pick-door），则该字段为必填，可传多个值	最小数量: 0 最大数量: 999 item 类型: number
├─		非必须	304
├─ pick_time	string	非必须	2022-12-24 17:21:10	提货时间：如果派车服务选择上门提货（pick-door），则该字段为必填，格式“2019-12-24 17:21:10”
├─ freight_id	string	非必须	13	仓库id：获取仓库地址接口中返回的仓库id，如果派车服务选择上门提货（pick-door），则该字段为必填
├─ self_delivery_freight_id	string	非必须	7	自送仓库id：获取仓库地址接口中返回的仓库id，派车服务选择自送（self_drive），则该字段为必填
├─ note	string	非必须	床位数	备注信息	最大长度: 200 最小长度: 0
├─ destination_address	string	必须	PERSONAL	目的地址类型；FBA订单时，该值只能为FBA	枚举: FBA,THIRDPARTY,PERSONAL 枚举备注: FBA=FBA地址； THIRDPARTY=第三方仓库； PERSONAL=私人地址；
├─ shipping_warehouseid	string	非必须	1	目的地第三方仓库id：调用获取第三方仓库地址接口返回的仓库id，destination_address =THIRDPARTY时，该参数必填
├─ pack_infos	object []	必须		商品信息集合	最小数量: 0 最大数量: 999 item 类型: object
├─ box_count	string	必须	1-90	箱号：支持格式如下：n1-n2或n1-n1或n1（n1,n2...均为正整数）
├─ cargo_enname	string	必须	TEst	商品英文名称
├─ cargo_cnname	string	必须	测试	商品中文名称
├─ num	string	必须	1	数量
├─ unit	string	必须	个	单位	枚举: bag(包/袋),set(台),set(座),set(架),set(套),set(部),set(亿),unit(辆/艘),pcs(个),pcs(只),pcs(件),pcs(支),pcs(枝),pcs(把),head(头),sheet(张),stick(根),bar(条),block(块),coil(卷/盘),pair(副/双),group(组),ration(份),couple(对),komg(井),meter(米),square meter(平方米),cubic meter(立方米),cone(筒),cone(筒),g(克),basin(盆),ten thousand(万个),hundred pairs(百副/百双),hundred pcs(百支/百把/百个/百片),bolt(疋/匹),quintal(公担),thousand pcs(千只/千枝/千个),thousand block(千块),thousand box(千盒),hundred million pcs(亿支/亿个),hundred million set(万套),thousand sheet(千张),thousand sheet(千张),kilowatt-ampere(千伏安),kilowatt(千瓦),kilowatt-hour(千瓦时),thousand liter(千升),foot(英尺),metric ton(吨),long ton(长吨),short ton(短吨),picul(司马担),jin(斤),pound(磅),hundred pounds(担),uk hundred-weight(英担),short hundred weight(短担),liang(两),dan(市担),ounce(盎司),carat(克拉),chi(市尺),yard(码),cun(寸),liter(升),milliliter(毫升),uk gallon(英加仑),us gallon(美加仑),cubic foot(立英方尺),cubic chi(立方尺),square yard(平方码),square foot(平方英尺),square chi(平方尺),uk horsepower(英制马力),metric horsepower(公制马力),link(令),box(箱/盒),batch(批),can(罐),barrel(桶),bundle(扎/捆),basket(萝/筐),dozen(打),gross(罗),book(册/本),sheel(发),grain(粒),he(合),bottle(瓶),ten thousand pair(万双),ten thousand grain(万粒),thousand grain(千粒),km(千米),thousand feet(千英尺),million ba(百万贝可)
├─ price	string	必须	32	申报价格
├─ texture	string	必须	木材	材质
├─ brand	string	必须	无	品牌
├─ model	string	必须	009	型号
├─ purpose	string	必须	测试用途	用途
├─ hs_code	string	必须	645648	海关编码
├─ third_company_name	string	非必须	阿ADC	第三方仓库联系方式信息-公司名（当「destination_address」参数值为「THIRDPARTY」时必填）	最大长度: 100 最小长度: 0
├─ third_first_name	string	非必须	小城	第三方仓库联系方式信息-姓名（当「destination_address」参数值为「THIRDPARTY」可以传值，也可为空）	最大长度: 100 最小长度: 0
├─ third_phone	string	非必须	13426464211	第三方仓库联系方式信息-电话（当「destination_address」参数值为「THIRDPARTY」可以传值，也可为空）	最大长度: 50 最小长度: 0
├─ third_email	string	非必须	description@163.com	第三方仓库联系方式信息-邮箱，值必须为正确的邮箱格式（当「destination_address」参数值为「THIRDPARTY」时必填）	format: email
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3
RequestTime	string	必须	1577084088	请求发起时间
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	唯一请求标识

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号
ResponseTime	string	必须		响应时间
RequestId	string	必须		唯一请求标识
ResponseId	string	必须		唯一响应标识
ResponseResult	number	必须		响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待；
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码
├─ ShortMessage	string	非必须		简短错误信息
├─ LongMessage	string	非必须		详细错误信息
Data	object	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ shipper_hawbcode	string	必须		运单号（订单号）

创建海运散货订单

基本信息

Path： /api/createShippingBulk?dataType=json

Method： POST

接口描述：

海运散货订单下单接口

请求体：

{
  "Data": {
    "product_code": "SHHY",
    "country": "AD",
    "service_id": "153",
    "mail_cargo_type": [
      "1",
      "5"
    ],
    "volume": "0.11",
    "weight": "100000",
    "battery_type": [],
    "battery_model": [],
    "battery_volume": [],
    "battery_voltage": [],
    "fba_warehouseid": "13",
    "shipping_id": "",
    "customs": "EDI declar",
    "clea_id": "6817",
    "customs_title": [
      "清关抬头1",
      "清关抬头2"
    ],
    "clearance": "edi-tax",
    "tax_file_number": "跨鲸",
    "clearance_company": "跨鲸",
    "clearance_contact_information": "跨鲸",
    "clearance_company_address":'',
    "extra_tax_number" : {
        "IRS税号" : "GB297025190000",
        "VAT税号": "GB297025190",
        "EORI税号": "GB297025190000",
        "增值税号" : "GB297025190",
        "欧盟税号" : "GB297025190000",
    },
    "others": [],
    "trailer": "self_drive",
    "pick_time": "",
    "freight_id": "",
    "self_delivery_freight_id": "7",
    "destination_address": "THIRDPARTY",
    "shipping_warehouseid": "10",
    "note": "",
    "is_pva":'0',
    'pva_id':'',
    "pack_infos": [
      {
        "box_number": "aaa",
        "fba_reference_id": "FFF",
        "box_count": "1-90",
        "cargo_enname": "英文名称11",
        "cargo_cnname": "中文名称1",
        "num": "1100",
        "unit": "pcs(个)",
        "price": "12.5",
        "ner_weight": "17.5",
        "rough_weight": "20.22",
        "volume":"12.3",
        "texture": "材质1",
        "brand": "品牌1",
        "model": "用途1",
        "purpose": "用途1",
        "hs_code": "124151",
        "image": "",
        "company_enname": "",
        "company_enaddress": "",
        "volume": 12.3,
        "remark": "备注1"
      },
      {
        "box_number": "aaa",
        "fba_reference_id": " WWW",
        "box_count": "1-100",
        "cargo_enname": "英文名称11",
        "cargo_cnname": "中文名称1",
        "num": "1100",
        "unit": "pcs(个)",
        "price": "12.5",
        "ner_weight": "17.5",
        "rough_weight": "20.22",
        "volume":"12.3",
        "texture": "材质1",
        "brand": "品牌1",
        "model": "用途1",
        "purpose": "用途1",
        "hs_code": "124151",
        "image": "",
        "company_enname": "",
        "company_enaddress": "",
        "volume": 12.3,
        "remark": "备注1"
      }
    ],
    "third_company_name": "dolor officia pariatur commodo minim",
    "third_first_name": "aliqua non qui dolore",
    "third_phone": "do laboris",
    "third_email": "[in@sentence.com](mailto:in@sentence.com)"
  },
  "Version": "0.0.3",
  "RequestTime": "1577084088",
  "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": {
        "shipper_hawbcode": "KJF82712103246731G"
    }
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是	Basic MGIyNjU4ZTgzZmEzMmU2Y2U2NmQ3OWQ3YzdlNGU2NGM6ZTA3NGMxMTQ2OTNmZTM4OTM0YWQyNjgyYmM4M2Y4YjU=	认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须
├─ product_code	string	必须	SHHY	运输方式代码	枚举: SHHY,SHFBA 枚举备注: SHHY=海运散货； SHFBA=FBA海运散货；
├─ country	string	必须	AD	收件人的国家二字码；例：美国填写US
├─ service_id	string	必须	342	服务方式id：获取服务方式接口返回的id
├─ volume	number	必须		预报体积（单位：m³）	最大值: 1000 最小值: 0.01
├─ weight	number	必须		预报重量（单位：kg）	最大值: 100000 最小值: 0.01
├─ mail_cargo_type	string []	必须		货物类型：可传多个值 1=普货； 2=内置电池； 3=配套电池； 4=纯电池； 5=易碎物品； 6=纺织品； 7=带磁；	最小数量: 1 最大数量: 99 item 类型: string
├─		非必须	1	货物类型
├─ battery_type	string []	非必须		电池类型集合：当货物类型包含内置电池，配套电池或纯电池三个中的任何一种时必填 1=PI965； 2=PI966； 3=PI967； 4=PI969； 5=PI970； 6=UN3480； 7=UN3481； 8=UN3090； 9=UN3091； 10=其他；	最小数量: 1 最大数量: 99 item 类型: string
├─		非必须	1	电池类型
├─ battery_model	string []	非必须		电池型号集合子元素字符限制：0 ~ 20个字	最小数量: 1 最大数量: 9999 item 类型: string
├─		非必须	飞利浦	电池型号
├─ battery_volume	string []	非必须		电池容量集合子元素字符限制：0 ~ 20个字	最小数量: 1 最大数量: 99 item 类型: string
├─		非必须	240v	电池容量
├─ battery_voltage	string []	非必须		电池伏数集合	最小数量: 1 最大数量: 999 item 类型: string
├─		非必须	15an	电池伏数
├─ pickup_type	number	非必须	0	提单类型（海运散货和FBA海运散货必填，空运、快递、FBA空运、FBA快递非必填）	枚举: 0,1 枚举备注: 0=电放； 1=正本；
├─ fba_warehouseid	string	非必须	75	FBA仓库地址id，FBA订单（即product_code为FBA海运散货、FBA空运、FBA快递）时，该参数必填
├─ shipping_id	string	非必须	5695	目的地私人收货地址id：调用获取私人收货地址（目的地）接口返回的地址id，destination_address =PERSONAL时，该参数或shipping_location必填其一
├─ shipping_location	object	非必须		私人收货地址集合(新增私人收货地址)：当该值存在时则shipping_id无效
├─ company_name	string	必须	Naomi Vicente Perez	收货公司	最大长度: 100 最小长度: 0
├─ first_name	string	必须	SDFDH	收件人名	最大长度: 100 最小长度: 0
├─ phone	string	必须	===687076577	收件人联系方式	最大长度: 50 最小长度: 0
├─ email	string	必须	yeasddfg760610092@qq.com	收件人邮箱	最大长度: 100 最小长度: 0
├─ postcode	string	必须	02800	收件地址邮编（国家为美国时，填写的格式为5位数字/5位数字-4位）	最大长度: 50 最小长度: 0
├─ country_code	string	必须	AD	收件地址所在国家二字代码	最大长度: 2 最小长度: 0
├─ province	string	必须	AK-阿拉斯加	收件地址所在省	最大长度: 50 最小长度: 0
├─ city	string	必须	Madrid	收件地址所在市	最大长度: 50 最小长度: 0
├─ address	string	必须	Calle de las Infantas	收件详细地址	最大长度: 200 最小长度: 0
├─ customs	string	必须	EDI declar	报关方式	枚举: EDI declar,commission,pay_tax 枚举备注: EDI declar=买单报关； commission=退税报关； pay_tax=买单+退税报关；
├─ customs_title	string []	非必须		报关抬头，当customs=commission 或 pay_tax时必填子元素限制：1 ~ 64个字符	最小数量: 1 最大数量: 10 item 类型: string
├─		非必须	三行情书	报关抬头
├─ clea_id	string	非必须	23454	报关资料id上传退税报关资料返回的id（类型：报关资料）；customs包含退税报关时必填，支持zip、rar文档上传
├─ clearance	string	必须	edi-tax	清关方式	枚举: own-tax,edi-tax 枚举备注: own-tax=自有税号清关( 需对应服务方式有此选项，否则返回错误 )； edi-tax=跨鲸税号清关；
├─ tax_file_number	string	非必须	跨鲸	清关税号：清关方式为own-tax时，填写自有清关税号；清关方式为edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_company	string	非必须	跨鲸	清关公司名称：清关方式为own-tax时，填写自有清关公司名称；清关方式为edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_contact_information	string	非必须	跨鲸	税号公司联系方式：清关方式为own-tax时，填写公司联系方式；清关方式为edi-tax时，填写“跨鲸”	最大长度: 50 最小长度: 0
├─ clearance_company_address	string	非必须	跨鲸	税号公司地址：清关方式为own-tax时，填写公司地址；”	最大长度: 200 最小长度: 0
├─ others	string []	必须		增值服务集合：无需增值服务时，该参数置空既："others" = [] fumigation=熏蒸； origin_crt=产地证； world_ease=world_ease服务； post_check=偏远邮编校； make_appointment=预约送货； carry=搬运服务； check_fee=包查验费； tax_fee=包税费； up_fee=保险服务； addr_type_commercial=商业地址； addr_type_residential=住宅地址； business_fee=商检服务； commodity_inspection=商检服务； isf_report=ISF申报	最小数量: 1 最大数量: 99 item 类型: string
├─		非必须	fumigation	增值服务
├─ trailer	string	必须	self_drive	派车服务	枚举: pick-door,self_drive 枚举备注: pick-door=上门提货； self_drive=自送；
├─ pick_id	number []	非必须		提货地址id：获取提货地址中的接口返回的id，如果派车服务选择上门提货（pick-door），则该字段为必填，可传多个值	最小数量: 1 最大数量: 99 item 类型: number
├─		非必须	89	提货地址id
├─ pick_time	string	非必须	2022-12-24 17:21:10	提货时间：如果派车服务选择上门提货（pick-door），则该字段为必填，格式“2019-12-24 17:21:10”
├─ freight_id	string	非必须		仓库id：获取仓库地址接口中返回的仓库id，如果派车服务选择上门提货（pick-door），则该字段为必填
├─ self_delivery_freight_id	string	非必须	7	自送仓库id：获取仓库地址接口中返回的仓库id，派车服务选择自送（self_drive），则该字段为必填
├─ note	string	非必须	测试	备注信息	最大长度: 200 最小长度: 0
├─ pay_the_bill	string	非必须	23451	买单报关id
├─ destination_address	string	必须	PERSONAL	目的地址类型；FBA订单时，该值只能为FBA	枚举: FBA,THIRDPARTY,PERSONAL 枚举备注: FBA=FBA地址； THIRDPARTY=第三方仓库； PERSONAL=私人地址；
├─ shipping_warehouseid	string	非必须		目的地第三方仓库id：调用获取第三方仓库地址接口返回的仓库id，destination_address =THIRDPARTY时，该参数必填
├─ pack_infos	object []	非必须		货物详细信息集合：货物详情（运输方式为KY=空运、KYFBA=FBA空运、SHHY=海运、SHFBA=FBA海运时，若使用pack_info传递商品信息则pack_id=""即可）	item 类型: object
├─ box_count	string	必须	1-90	箱号：支持格式如下：n1-n2或n1-n1或n1（n1,n2...均为正整数）
├─ cargo_enname	string	必须	string	商品英文名称
├─ cargo_cnname	string	必须	键盘	商品中文名称
├─ num	string	必须	1	数量
├─ unit	string	必须		计量单位	枚举: bag(包/袋),set(台),set(座),set(架),set(套),set(部),set(亿),unit(辆/艘),pcs(个),pcs(只),pcs(件),pcs(支),pcs(枝),pcs(把),head(头),sheet(张),stick(根),bar(条),block(块),coil(卷/盘),pair(副/双),group(组),ration(份),couple(对),komg(井),meter(米),square meter(平方米),cubic meter(立方米),cone(筒),cone(筒),g(克),basin(盆),ten thousand(万个),hundred pairs(百副/百双),hundred pcs(百支/百把/百个/百片),bolt(疋/匹),quintal(公担),thousand pcs(千只/千枝/千个),thousand block(千块),thousand box(千盒),hundred million pcs(亿支/亿个),hundred million set(万套),thousand sheet(千张),thousand sheet(千张),kilowatt-ampere(千伏安),kilowatt(千瓦),kilowatt-hour(千瓦时),thousand liter(千升),foot(英尺),metric ton(吨),long ton(长吨),short ton(短吨),picul(司马担),jin(斤),pound(磅),hundred pounds(担),uk hundred-weight(英担),short hundred weight(短担),liang(两),dan(市担),ounce(盎司),carat(克拉),chi(市尺),yard(码),cun(寸),liter(升),milliliter(毫升),uk gallon(英加仑),us gallon(美加仑),cubic foot(立英方尺),cubic chi(立方尺),square yard(平方码),square foot(平方英尺),square chi(平方尺),uk horsepower(英制马力),metric horsepower(公制马力),link(令),box(箱/盒),batch(批),can(罐),barrel(桶),bundle(扎/捆),basket(萝/筐),dozen(打),gross(罗),book(册/本),sheel(发),grain(粒),he(合),bottle(瓶),ten thousand pair(万双),ten thousand grain(万粒),thousand grain(千粒),km(千米),thousand feet(千英尺),million ba(百万贝可)
├─ price	string	必须	23	申报单价
├─ ner_weight	number	必须		商品总净重（单位：kg）
├─ rough_weight	number	必须		整箱毛重（单位：kg）
├─ texture	string	必须	太和经	材质
├─ brand	string	必须	ikbc	品牌
├─ model	string	必须	1500da	型号
├─ purpose	string	必须	写代码	用途
├─ hs_code	string	必须	12651511	海关编码
├─ image	string	非必须	https://fanyi.baidu.com/#glg/en/	商品链接
├─ company_enname	string	非必须	化工厂	工厂名
├─ company_enaddress	string	非必须	深圳市宝安区	工厂地址
├─ box_number	string	必须		客户参考号（目的国家为美国且目的地址为FBA地址时，箱唛格式为FBA+9个英文数字）
├─ fba_reference_id	string	非必须		FBA参考号（部分服务方式要求必填）
├─ pay_the_bill_file_num	number	非必须	1	买单&退税报关的买单箱数
├─ third_company_name	string	非必须	沃尔玛	第三方仓库联系方式信息-公司名（当「destination_address」参数值为「THIRDPARTY」时必填	最大长度: 100 最小长度: 0
├─ third_first_name	string	非必须	小欧	第三方仓库联系方式信息-姓名（当「destination_address」参数值为「THIRDPARTY」可以传值，也可为空）	最大长度: 100 最小长度: 0
├─ third_phone	string	非必须	7500-98132331	第三方仓库联系方式信息-电话（当「destination_address」参数值为「THIRDPARTY」可以传值，也可为空）	最大长度: 50 最小长度: 0
├─ third_email	string	非必须	wem@sever.com	第三方仓库联系方式信息-邮箱，值必须为正确的邮箱格式（当「destination_address」参数值为「THIRDPARTY」时必填）	format: email
├─ fee_money	string	非必须	231	货值金额：当增值服务选择up_fee时候必填
Version	string	必须	0.0.3	接口版本号
RequestTime	string	必须	1577084088	请求发起时间
RequestId	string	必须	fa0b38da-271f-41c0-87c9-b057a41bba07	唯一请求标识

返回数据

名称	类型	是否必须	默认值	备注	其他信息
Version	string	必须	0.0.3	接口版本号
ResponseTime	string	必须		响应时间
RequestId	string	必须		唯一请求标识
ResponseId	string	必须		唯一响应标识
ResponseResult	number	必须		请求响应ID	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待；
ResponseError	object	必须		响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须		错误代码
├─ ShortMessage	string	非必须		简短错误信息
├─ LongMessage	string	非必须		详细错误信息
Data	object	必须		响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ shipper_hawbcode	string	必须		运单号（订单号）

获取货物仓库测量信息

基本信息

Path： /api/getWarehouseData?dataType=json

Method： POST

接口描述：

获取订单货物入库后的测量信息

请求体：

{
    "Data": {
        "shipper_hawbcode": "KJF48342012221981U"
    },
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": {
        "total_volume": "0.00m³",
        "total_weight": "2.00KG",
        "fee_volumeweigh": "0.10m³",
        "min_box_charge_weight": "0.00",
        "metrical_info": [
            {
                "packnum": "KJF82712101309942Y-1/4",
                "length": "1.00",
                "width": "1.00",
                "height": "1.00",
                "weight": "1.00",
                "created_at": "2021-01-30 17:13:21",
                "updated_at": "2021-01-30 17:13:21",
                "volume_weight": "0.00",
                "fee_volume_weight": "0.00",
                "box_number": "FBA15Y4H7G4Q31",
                "return_status": 2
            }
        ]
    }
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		请求数据
├─ shipper_hawbcode	string	必须		运单号	mock: KJF48342012221981U
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3 mock: 0.0.3
RequestTime	string	必须		请求发起时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	备注	其他信息
Version	string	必须	接口版本号	mock: 0.0.3
ResponseTime	number	必须	响应时间	mock: 1618899866
RequestId	string	必须	唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须	唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须	响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须	响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须	错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须	简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须	详细错误信息	mock: 服务器异常，请稍后重试
Data	object	必须	响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ total_volume	string	非必须	总体积	mock: 0.00m³
├─ total_weight	string	非必须	总实重	mock: 0.00KG
├─ fee_volumeweigh	string	非必须	计费重	mock: 0.00KG
├─ min_box_charge_weight	string	非必须	单箱最低标准	mock: 0.00
├─ metrical_info	object []	非必须	箱子测量信息集合	item 类型: object
├─ packnum	string	非必须	系统箱唛	mock: KJF48342012221981U-1/5
├─ length	string	非必须	长cm	mock: 1.00
├─ width	string	非必须	宽cm	mock: 2.00
├─ height	string	非必须	高cm	mock: 3.00
├─ weight	string	非必须	实重(kg)	mock: 4.00
├─ created_at	string	非必须	创建时间	mock: 2021-02-08 17:23:21
├─ updated_at	string	非必须	修改时间	mock: 2021-02-08 17:23:21
├─ volume_weight	string	非必须	体积重	mock: 0.00
├─ fee_volume_weight	string	非必须	计费重	mock: 0.00
├─ box_number	string	非必须	自有箱号	mock: KL-15511

获取物流信息

基本信息

Path： /api/getLogistics?dataType=json

Method： POST

接口描述：

获取订单运输的物流轨迹信息

请求体：

{
    "Data": {
        "shipper_hawbcode": "KJF48342103048397X"
    },
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": {
        "shipper_hawbcode": "KJF82712103248541H",
        "transport": [
            {
                "change_server_hawbcode": "1Z4FR3976744446933",
                "order_name": "主单1",
                "transport_data": [
                    {
                        "title": "已发货",
                        "contents": "【快递】订单【KJF82712103248541H】已发货出库，下一步：等待物流更新",
                        "created_at": "2021-03-25 17:03:49"
                    }
                ]
            }
        ]
    }
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须		请求数据
├─ shipper_hawbcode	string	必须		运单号	mock: KJF48342103048397X
Version	string	必须	0.0.3	接口版本号	枚举: 0.0.3 mock: 0.0.3
RequestTime	string	必须		请求发起时间	mock: 1618899866
RequestId	string	必须		唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07

返回数据

名称	类型	是否必须	备注	其他信息
Version	string	必须	接口版本号	mock: 0.0.3
ResponseTime	number	必须	响应时间	mock: 1618899866
RequestId	string	必须	唯一请求标识	mock: fa0b38da-271f-41c0-87c9-b057a41bba07
ResponseId	string	必须	唯一响应标识	mock: b5f1bce0-1266-bdc3-c84a-0bc5798992dd
ResponseResult	number	必须	响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待； mock: 1
ResponseError	object	必须	响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须	错误代码	mock: 0x00999999
├─ ShortMessage	string	非必须	简短错误信息	mock: 服务器异常，请稍后重试
├─ LongMessage	string	非必须	详细错误信息	mock: 服务器异常，请稍后重试
Data	object	必须	响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ shipper_hawbcode	string	非必须	运单号（订单号）	mock: KJF48342103048397X
├─ transport	object []	非必须	物流数据集合	item 类型: object
├─ change_server_hawbcode	string	非必须	转跟踪号	mock: KJF48342103048397X
├─ order_name	string	非必须	转单名称（主单1,2，...）	mock: 主单1
├─ transport_data	object []	非必须	单号物流信息	item 类型: object
├─ title	string	必须	物流状态	mock: 已发货
├─ contents	string	必须	物流明细	mock: 【海运散货】订单【KJF48342103048397X】已发货出库，下一步：等待物流更新
├─ created_at	string	必须	创建时间	mock: 2021-03-24 15:28:19

创建海运整柜订单

基本信息

Path： /api/createShippingTheEntireCabinet?dataType=json

Method： POST

接口描述：

海运整柜下单接口

请求体：

{
    "Data": {
        "service_mode": 1,
        "country": "AD",
        "service_id": 135,
        "box_type_new": "20GP",
        "load_port_id": 2,
        "destination_port_id": 22,
        "product_name": "Test",
        "volume": 1000,
        "weight": 1000,
        "predict_value": 1000,
        "destination_address": 2,
        "fba_warehouse_id": "",
        "destination_depot_id": "",
        "private_shipping_id": 1572,
        "sel_country_code": "AD",
        "sel_province": "阿萨德",
        "sel_city": "阿萨德",
        "sel_company_name": "aaaaaaaa",
        "sel_first_name": 123,
        "sel_phone": 234,
        "sel_email": "zt17259@zongteng.net",
        "sel_postcode": 234,
        "sel_address": 123,
        "customs_declaration": "pay_tax",
        "clearance_file_id": 5592,
        "others": ["carry", "origin_crt", "make_appointment", "commodity_inspection"],
        "make_appointment_name": "联系人",
        "make_appointment_phone": "电话",
        "make_appointment_email": "xxxxx@ztn.com",
        "need_pickup": 1,
        "pick_time": "2021/05/22 11:20",
        "pick_id": [130],
        "third_company_name": "dolor officia pariatur commodo minim",
        "third_first_name": "aliqua non qui dolore",
        "third_phone": "15966555853",
        "third_email": "iii@136.com"
        "clearance_data": [{
            "type": "own-tax",
            "list": [{
                "tax_zz_number": "GB297025190",
                "tax_om_number": "GB297025190000",
                "clearance_company": "跨鲸无限公司",
                "clearance_contact_information": "[kuajing123@kj.com](mailto:kuajing123@kj.com)",
                "clearance_company_address":"公司地址",
                "clear_file_id": 5593
            }]
        },
        {
            "type": "edi-tax",
            "clearance_mode": 0,
            "list": [{
                "tax_file_number": "跨鲸",
                "clearance_company": "跨鲸",
                "clearance_contact_information": "跨鲸"
            }]
        }]
    },
    "Version": "0.0.3",
    "RequestTime": "1577084088",
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07"
}

响应成功示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569387,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "dfb889ca-2934-190c-7b8c-db0d7d5a0a80",
    "ResponseResult": 1,
    "ResponseError": "",
    "Data": {
        "shipper_hawbcode": "KJF82712103246731G"
    }
}

响应失败示例：

{
    "Version": "0.0.3",
    "ResponseTime": 1616569753,
    "RequestId": "fa0b38da-271f-41c0-87c9-b057a41bba07",
    "ResponseId": "1c636259-26eb-29bd-5afb-a1a61d0c3879",
    "Data": "",
    "ResponseResult": 0,
    "ResponseError": {
        "Code": "0x00150001",
        "ShortMessage": "请求数据不存在",
        "LongMessage": "请求数据不存在"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization		是		认证

Query

参数名称	是否必须	示例	备注
dataType	是	json

Body

名称	类型	是否必须	默认值	备注	其他信息
Data	object	必须
├─ service_mode	number	必须	1	服务模式	枚举: 1,2 枚举备注: 1=>DDP门到门；2=>FOB港到港
├─ country	string	必须	AD	服务国家：国家二字代码
├─ service_id	number	必须		服务方式：通过【获取服务方式】获取服务方式id，与国家对应
├─ box_type_new	string	必须	20GP	预约柜型	枚举: 20GP,40GP,40HQ,45HQ
├─ load_port_id	number	必须		起运港id：通过【获取起运港接口】获取
├─ destination_port_id	number	必须		目的港id：通过【获取目的港接口】获取，与服务国家对应
├─ product_name	string	必须		品名：字符限制	最大长度: 50 最小长度: 0
├─ volume	number	必须		预估体积(m³)	最大值: 99999999.99 最小值: 0.01
├─ weight	number	必须		预估重量(KG)	最大值: 99999999.99 最小值: 0.01
├─ predict_value	number	必须		预估货值(USD)	最大值: 99999999.99 最小值: 0.01
├─ destination_address	number	必须	2	收货/目的地地址类型	枚举: 1,2 枚举备注: 1=>FBA仓库；2=>私人地址；3=>第三方仓库
├─ fba_warehouse_id	number	非必须		收货/目的地FBA仓id：当destination_address=1时必填，通过【获取FBA仓库地址接口】，与服务国家挂钩
├─ destination_depot_id	number	非必须		第三方仓库地址：当destination_address=3时必填，通过【获取第三方仓库地址接口】，与服务国家挂钩
├─ private_shipping_id	number	非必须		私人地址：当destination_address=2时选填，通过【获取收货地址接口】，若填写值则以下sel_*值的修改将无视，若该值不填则表示新建私人地址
├─ sel_country_code	string	非必须		私人地址国家二字代码：当destination_address=2时必填，该值必须与服务服务国家相同，字符限制：小于100
├─ sel_province	string	非必须		私人地址省份：当destination_address=2时必填，字符限制：小于50
├─ sel_city	string	非必须		私人地址城市：当destination_address=2时必填，字符限制：小于50
├─ sel_company_name	string	非必须		私人地址收件公司：当destination_address=2时必填，字符限制：小于100
├─ sel_first_name	string	非必须		私人地址收件人姓名：当destination_address=2时选填，字符限制：小于100
├─ sel_phone	string	非必须		私人地址收件人联系电话：当destination_address=2时选填，字符限制：大于1，小于50
├─ sel_email	string	非必须		私人地址收件人电子邮箱：当destination_address=2时选填，，字符限制：小于200
├─ sel_postcode	string	非必须		私人地址邮编：当destination_address=2时必填，字符限制：小于50
├─ sel_address	string	非必须		私人地址详细地址：当destination_address=2时必填，字符限制：小于200
├─ customs_declaration	string	必须		报关方式	枚举: commission,EDI decalr,pay_tax,themselves 枚举备注: commission=>退税报关；EDI decalr=>买单报关；pay_tax=>买单+退税报关；themselves=>报关自理
├─ clearance_file_id	number	非必须		退税文件id：通过【上传文件接口】获取
├─ others	string []	必须		增值服务集合：无需增值服务时，该参数置空既："others" = []	item 类型: string
├─		非必须			枚举: fumigation,origin_crt,world_ease,post_check, make_appointment,carry,check_fee, tax_fee,up_fee,addr_type_commercial,addr_type_residential, business_fee,commodity_inspection,isf_report 枚举备注: fumigation=熏蒸；origin_crt=产地证；world_ease=world_ease服务；post_check=偏远邮编校；make_appointment=预约送货；carry=搬运服务；check_fee=包查验费；tax_fee=包税费；up_fee=保险服务；addr_type_commercial=商业地址；addr_type_residential=住宅地址；business_fee=商检服务；commodity_inspection=商检服务；isf_report=ISF申报
├─ make_appointment_name	string	非必须		预约送货联系人：当other包含make_appointment时必填	最大长度: 30
├─ make_appointment_phone	string	非必须		预约送货联系电话：当other包含make_appointment时必填	最大长度: 30
├─ make_appointment_email	string	非必须		预约送货邮箱：当other包含make_appointment时必填	最大长度: 30
├─ need_pickup	number	必须		拖车服务	枚举: 0 枚举备注: 0=>自理拖车；1=>跨鲸拖车
├─ pick_time	string	非必须		提货时间：need_pickup=1时该字段为必填，格式“2019-12-24 17:21:10”
├─ pick_id	number []	非必须		提货地址id集合：获取提货地址中的接口返回的id，need_pickup=1时该字段为必填，可传多个值	item 类型: number
├─		非必须		提货地址id
├─ clearance_data	object []	必须		清关信息，可填写多种清关方式	item 类型: object
├─ type	string	必须		清关方式	枚举: own-tax,edi-tax 枚举备注: own-tax=>自有清关号清关；edi-tax=>跨鲸税号清关
├─ list	object []	必须			item 类型: object
├─ tax_zz_number	string	非必须		增值税号：当type=edi-tax时，填写跨鲸即可
├─ tax_om_number	string	非必须		欧盟税号：当type=own-tax时选填
├─ tax_file_number	string	非必须		跨鲸清关税号：当type=edi-tax时必填，填写“跨鲸”即可
├─ clearance_company	string	必须		税号公司名称：当type=edi-tax时，填写跨鲸即可
├─ clearance_contact_information	string	必须		联系方式：当type=edi-tax时，填写跨鲸即可
├─ clearance_company_address	string	非必须		公司地址
├─ clear_file_id	number	非必须		清关文件id：通过【上传文件接口】获取
├─ third_company_name	string	非必须		第三方仓库联系方式信息-公司名（当「destination_address」参数值为「THIRDPARTY」时必填）
├─ third_first_name	string	非必须		第三方仓库联系方式信息-姓名（当「destination_address」参数值为「THIRDPARTY」可以传值，也可为空）
├─ third_phone	string	非必须		第三方仓库联系方式信息-电话（当「destination_address」参数值为「THIRDPARTY」可以传值，也可为空）
├─ third_email	string	非必须		仓库联系方式信息-邮箱（当「destination_address」参数值为「THIRDPARTY」时必填）
Version	string	必须		请求接口版本号	枚举: 0.0.3
RequestTime	string	必须		请求发起时间
RequestId	string	必须		唯一请求标识

返回数据

名称	类型	是否必须	备注	其他信息
Version	string	必须	接口版本号	枚举: 0.0.3
ResponseTime	string	必须	响应时间
RequestId	string	必须	唯一请求标识
ResponseId	string	必须	唯一响应标识
ResponseResult	number	必须	请求响应结果	枚举: 0,1,2 枚举备注: 0=失败； 1=成功； 2=等待；
ResponseError	object	必须	响应错误信息：当 ResponseResult = 0 时，该字段返回具体错误信息
├─ Code	string	非必须	错误代码
├─ ShortMessage	string	非必须	简短错误信息
├─ LongMessage	string	非必须	详细错误信息
Data	object	必须	响应具体数据：当 ResponseResult = 1 时，该字段返回具体结果集
├─ shipper_hawbcode	string	必须	运单号（订单号）

更新日志

2021-06-18

1. 补充了商品信息中箱数（pack_infos.box_count）格式的说明

2. 补充了FBA参考号（fba_refercode2_arr）必填说明

3. 新增整柜海运下单接口

4. 新增获取港口信息接口

5. 新增获取整柜增值服务接口