API接口文档

序号

方法名

描述

1

createorder

提交订单

2

getnewlabel

获取订单标签

3

gettrack

获取跟踪记录

4

feetrail

费用试算

5

getshippingmethod

getmailcargotype

getcountry

getcertificatetype

getdeclareunit

getextraservice

getlabelconfig

获取基础数据（运输方式、申报种类、国家、证件类型、申报单位 、额外服务、标签纸张配置）

6

removeorder

删除订单

参数名

数据类型

必填

说明

reference_no

string

√

客户参考号

shipping_method

string

√

运输方式代码

shipping_method_no

string

服务商单号

order_weight

float

订单重量，单位KG，默认为0.2

order_pieces

int

外包装件数,默认1

cargotype

string

货物类型
W:包裹
D:文件
B:袋子

mail_cargo_type

string

包裹申报种类
1:Gif礼品
2:CommercialSample 商品货样
3:Document 文件
4:Other 其他
默认4

buyer_id

string

买家ID

order_info

string

订单备注

platform_id

int

平台ID
（如果您是电商平台，请联系我们添加并确认您对应的平台ID）

shipper

object

√

发件人信息

consignee

object

√

收件人信息

invoice

object[]

√

海关申报信息

extra_service

object[]

额外服务

custom_hawbcode

string

自定义单号

参数名

数据类型

必填

说明

shipper_name

string

√

发件人姓名

shipper_company

string

发件人公司名

shipper_countrycode

string

√

发件人国家二字码

shipper_province

string

发件人省

shipper_city

string

发件人城市

shipper_street

string

√

发件人地址

shipper_postcode

string

发件人邮编

shipper_areacode

string

发件人区域代码

shipper_telephone

string

√
(至少传一个)

发件人电话

shipper_mobile

string

发件人手机

shipper_email

string

发件人邮箱

shipper_fax

string

发件人传真

参数名

数据类型

必填

说明

consignee_name

string

√

收件人姓名

consignee_company

string

收件人公司名

consignee_countrycode

string

√

收件人国家代码

consignee_province

string

收件人省

consignee_city

string

收件人城市

consignee_street

string

√

收件人地址

consignee_postcode

string

收件人邮编

consignee_areacode

string

收件人区域代码

consignee_telephone

string

√
(至少传一个)

收件人电话

consignee_mobile

string

收件人手机

consignee_email

string

收件人邮箱

consignee_fax

string

收件人传真

consignee_certificatetype

string

证件类型代码
ID:身份证
PP:护照

consignee_certificatecode

string

证件号码

consignee_credentials_period

string

证件有效期

consignee_tariff

string

收件人税号

参数名

数据类型

必填

说明

sku

string

SKU

invoice_enname

string

√

英文品名

invoice_cnname

string

中文品名

invoice_quantity

int

√

数量

unit_code

string

单位(MTR(米), PCE(件), SET(套)),
默认PCE

invoice_unitcharge

float

√

单价

hs_code

string

海关协制编号

invoice_note

string

配货信息

invoice_url

string

销售地址

invoice_info

string

商品图片地址

参数名

数据类型

必填

说明

extra_servicecode

string

√

额外服务类型代码

extra_servicevalue

string

√

额外服务值（有些额外服务类型必须传此值）

extra_servicenote

string

备注

参数名

数据类型

说明

success

int

是否成功标志，0代表失败；1代表成功

cnmessage

string

处理结果中文消息

enmessage

string

处理结果英文消息

data

object

成功时返回的数据

参数名

数据类型

说明

refrence_no

string

客户参考号

shipping_method_no

string

服务商单号

参数名

数据类型

必填

说明

configInfo

object

√

配置信息

listorder

object[]

√

订单信息(单次请求不能超过100条)

config_code

string

标签纸张配置代码，通过 getlabelconfig 接口获得 (传了此参数， configInfo 参数可不传)

参数名

数据类型

必填

说明

lable_file_type

string

√

标签文件类型
1 ：PNG文件
2 ：PDF文件

lable_paper_type

string

√

纸张类型
1 ：标签纸(10*10厘米)
2 ：A4纸(21*29.7厘米)

lable_content_type

string

√

标签内容类型代码
1 ：标签
2 ：报关单
3 ：配货单
4 ：标签+报关单
5 ：标签+配货单
6 ：标签+报关单+配货单

additional_info

object

√

附加配置信息

参数名

数据类型

必填

说明

lable_print_invoiceinfo

string

标签上打印配货信息 (Y:打印 N:不打印) 默认 N:不打印

lable_print_buyerid

string

标签上是否打印买家ID (Y:打印 N:不打印) 默认 N:不打印

lable_print_datetime

string

标签上是否打印日期 (Y:打印 N:不打印) 默认 Y:打印

customsdeclaration_print_actualweight

string

报关单上是否打印实际重量 (Y:打印 N:不打印) 默认 N:不打印

参数名

数据类型

必填

说明

reference_no

string

√

客户参考号

参数名

数据类型

说明

success

int

是否成功标志，0代表失败；1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息

data

object[]

成功时返回的数据

参数名

数据类型

说明

lable_file_type

string

标签文件类型
1 ：PNG文件
2 ：PDF文件

lable_file

string

标签文件url地址

参数名

数据类型

必填

说明

tracking_number

string

√

跟踪单号

参数名

数据类型

说明

success

int

是否成功标志，0代表失败；1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息

data

object[]

成功时返回的数据

参数名

数据类型

说明

server_hawbcode

string

跟踪单号

track_status

string

最新状态代码

track_status_name

string

最新状态名称

signatory_name

string

签收人

details

object[]

跟踪记录明细

参数名

数据类型

说明

track_occur_date

string

时间

track_location

string

地点

track_description

string

内容

track_code

string

轨迹代码

参数名

数据类型

必填

说明

country_code

string

√

目的国家二字代码

weight

float

√

重量（KG）

shipping_method

string

运输方式代码

post_code

string

目的地邮编

location

string

起运地
默认为：用户绑定的起运地

cargo_type

string

货物类型（W:包裹 D:文件）
默认为：W

length

float

长（CM）

width

float

宽（CM）

height

float

高（CM）

extra_service

string[]

额外服务代码集合

参数名

数据类型

说明

success

int

是否成功标志，0代表失败；1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息

data

object[]

成功时返回的数据

参数名

数据类型

说明

ServiceCode

string

运输方式代码

ServiceCnName

string

运输方式中文名

ServiceEnName

string

运输方式英文名

ChargeWeight

string

计费重量

FreightFee

string

运费

FuelFee

string

燃油费

RegisteredFee

string

挂号费

OtherFee

string

其他费用

OtherFeeDetails

object[]

其他费用明细

TotalFee

float

总费用

Effectiveness

string

时效天数

Traceability

string

是否可追踪

VolumeCharge

string

材积系数

ProductSort

string

排序权重值，值越大权重越高

Formula

string

运费计算公式

Remark

string

备注

参数名

数据类型

说明

FeeCnName

string

费用中文名

FeeEnName

string

费用英文名

FeeAmount

string

费用金额

参数名

数据类型

说明

success

int

是否成功标志，0代表失败；1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息

data

object[]

成功时返回的数据

参数名

数据类型

说明

code

string

代码

cnname

string

中文名

enname

string

英文名

note

string

备注

参数名

数据类型

说明

reference_no

string

客户参考号

参数名

数据类型

说明

success

int

是否成功标志，0代表失败；1代表成功

cnmessage

string

中文消息

enmessage

string

英文消息