接口文档

接口文档

API

创建运单

查看API域名

接口地址:

/order/create-order

请求方式:POST

请求头:

参数名参数值
Content-Typeapplication/x-www-form-urlencoded
AuthorizationBearer

请求参数:

参数名参数值必填描述
asyncint异步获取面单设置,9:不启用(默认),10:启用(可在用户后台->设置->异步设置中填入URL并启用)
product_codestring渠道地址名(在获取发货渠道地址API中获取
typeint类型,仓库地址=>9(传空或不传值则默认9),GOFO和UNI上门取件(一票一件)=>10(在获取发货渠道地址API中获取
currency_codestring货币代码,如美元:USD。不填默认为USD
customer_order_numstring客户订单号
rate_order_numstring报价单号,由价格试算接口获取
shipper_namestring发件人姓名
shipper_phoneint发件人电话
shipper_postal_codestring发件邮编,有申报需求的如(gofo、uniuni需传)
shipper_countrystring发件人国家,有申报需求的如(gofo、uniuni需传)
shipper_statestring发件州,有申报需求的如(gofo、uniuni需传)
shipper_citystring发件城市,有申报需求的如(gofo、uniuni需传)
shipper_add_1string发件地址1,有申报需求的如(gofo、uniuni需传)
shipper_add_2string发件地址2
shipper_companystring发件人公司
unitint尺寸-重量单位: Lbs-Inch/Kgs-Cm (9=>Lbs-Inch,10=>Kgs-Cm)默认Kgs-Cm
target_namestring收货人姓名
target_phonestring收货人电话
target_postal_codeint收货地邮编
target_countrystring收货地国家(如:US)
target_statestring收货地洲
target_citystring收货地城市
target_add_1string街道地址1
target_add_2string街道地址2
target_companystring收货地公司
signature_servicestring签名服务: None/Normal signature/Adult signature (传值填写:-/SSF/ASS)
package_qtyint包裹数量
packagesJSON[]包裹信息
packages参数:
参数名参数值必填描述
xdouble
yv
zdouble
net_weightdouble净重
qtyint数量
seqint箱号
name_cnstring申报中文名,有申报需求的如(一票一件,gofo、uniuni需传)
name_enstring申报英文名,有申报需求的如(一票一件,gofo、uniuni需传)
declared_valuestring申报价格,有申报需求的如(一票一件,gofo、uniuni需传)
skustringSKU,有申报需求的如(一票一件,gofo、uniuni需传)
remarkstring备注

响应结果:

参数名参数值是否一定回传描述
err_codeint状态码,详见状态码表
msgstring描述信息
resultstring(JSON)否,code为200回传结果(结果集)
result结果集(code=200回传):
参数名参数值是否一定回传描述
asyncint是否异步查询下单结果,(是:10,否:9)
totalint预付总金额
fee_list_costJSON[]费用清单
customer_order_numint客户订单号
master_tracking_numberstring主跟踪号
merge_labelstring面单下载链接
order_numstring订单号
packages_listJSON[]包裹单号、面单、箱号等

响应示例:

成功:
{
	"err_code": 0,
	"msg": "执行成功",
	"result": {
		"customer_order_num": "test1234567890001",
		"total": "14.43",
		"fee_list_cost": [
			{
				"code": "431580860",
				"name": "快递费",
				"currency": "USD",
				"zone_code": "2",
				"amount": "5.94"
			},
			{
				"code": "431580861",
				"name": "燃油附加费",
				"currency": "USD",
				"zone_code": "2",
				"amount": "1.13"
			},
			{
				"code": "431580862",
				"name": "快递费",
				"currency": "USD",
				"zone_code": "2",
				"amount": "5.94"
			},
			{
				"code": "431580864",
				"name": "燃油附加费",
				"currency": "USD",
				"zone_code": "2",
				"amount": "1.13"
			}
		],
		"master_tracking_number": "1ZK6B4420330175884",
		"merge_label": "xxxxxxxxx",
		"order_num": "LSM370918409065598976",
		"packages_list": [
			{
				"tracking_number": "96320019602069871xxxxxxxxx",
				"is_main": 10,
				"seq": "test1234567890001-1",
				"box_num": "1",
				"package_label": "http://xxxxxxx.pdf"
			},
			{
				"tracking_number": "9632001960206987xxxxxxxxx",
				"is_main": 9,
				"seq": "test1234567890001-2",
				"box_num": "2",
				"package_label": "http://xxxxxxx.pdf"
			}
		],
		"async": 9
	}
}
失败:
{
	"err_code": 404,
	"msg": "错误描述"
}
下载示例代码(内有C#,Java,PHP): 点击下载示例代码