顺友物流开发者平台

接口说明

用于批量创建并预报多个包裹，单次请求提交包裹数量不得超过100个。

1.请求参数

参数级别/参数名称	类型/关系	是否必须提交	参数含义及数值要求
packageList/	一对多	Y	一次调用最多支持提交100个包裹。
packageList/ customerOrderNo	String	Y	客户订单号，由客户自定义，不允许重复。 Length <= 50
packageList/ customerReferenceNo	String	N	客户参考号，由客户自定义，允许重复。 Length <= 50
packageList/ trackingNumber	String	N	追踪号码，通常由顺友提供，已从顺友获取批量备用追踪号的客户可以直接提供，顺友系统会校验其有效性，无效将返回错误信息。 Length <= 50
packageList/ shippingMethodCode	String	Y	邮寄方式编码可通过4.07findShippingMethods接口获取。 Length <= 20
packageList/ salesPlatform	String	N	销售平台（各大平台或独立站等） Length <= 50
packageList/ packageCodAmount	Double	N	代收货款的价值数字0.01-5000.00
packageList/ packageCodCurrencyCode	String	N	代收货款的币种 CNY/HKD/USD/MYR/KRW/IDR/INR/THB/PHP/VND/KHR/TWD
packageList/ packageSalesAmount	Double	N	包裹销售总价值（单位：USD）系统接收后自动四舍五入至2位小数
packageList/ packageLength	Double	N	包裹长度（单位：cm）系统接收后自动四舍五入至2位小数
packageList/ packageWidth	Double	N	包裹宽度（单位：cm）系统接收后自动四舍五入至2位小数
packageList/ packageHeight	Double	N	包裹高度（单位：cm）系统接收后自动四舍五入至2位小数
packageList/ predictionWeight	Double	Y	包裹总重量（单位：kg）系统接收后自动四舍五入至3位小数
packageList/ recipientName	String	Y	收件人姓名 Length <= 64
packageList/ recipientCountryCode	String	Y	收件人国家二字代码可参考附录7.0国家代码 Lenth = 2
packageList/ recipientPostCode	String	Y	收件人邮编 Length <= 32
packageList/ recipientState	String	Y	收件人省州 Length <= 64
packageList/ recipientCity	String	Y	收件人城市 Length <= 64
packageList/ recipientStreet	String	Y	收件人街道地址 Length <= 100
packageList/ recipientStreet1	String	N	收件人街道地址1 Length <= 100
packageList/ recipientPhone	String	N	收件人电话 Length <= 32
packageList/ recipientMobile	String	N	收件人手机 Length<=32
packageList/ recipientEmail	String	N	收件人邮箱 Length <= 128
packageList/ recipientTaxNumber	String	N	收件人税号，英国、巴西、智利路向需要填写 Length<=32
packageList/ recipientIdentityNumber	String	N	收件人身份证号码，韩国专线需要填写 Length<=32
packageList/ senderName	String	N	寄件人姓名 Length<=64
packageList/ senderPhone	String	N	寄件人电话 Length<=32
packageList/ senderPostCode	String	N	寄件人邮编 Length<=32
packageList/ senderAddress	String	N	寄件人街道地址 Length<=200
packageList/ senderCountryCode	String	N	寄件人国家代码 Length=2
packageList/ senderState	String	N	寄件人省州 Length<=64
packageList/ senderCity	String	N	寄件人城市 Length<=64
packageList/ senderDistrict	String	N	寄件人区/县 Length<=64
packageList/ senderEmail	String	N	寄件人邮箱 Length<=128
packageList/ senderTaxNumber	String	N	寄件人税号 Length<=32
packageList/ senderLicenseNumber	String	N	寄件人公司执照号 Length<=32
packageList/ iossVatId	String	N	IOSS欧盟税号、新加坡OVR税号、智利平台税号、马来西亚VAT税号、瑞士VAT税号 Length<=50
packageList/ packageAttributes	String	N	包裹属性，例如：“011”、“210”。如果包裹没有任何属性请填入000或者不填。第一位 0：不含电池 1：含电池 2：纯电池第二位 0：不含液体及粉末 1：含液体或粉末第三位 0：不是食品 1：食品 Length=3
packageList/ shortAddressCode	String	N	短地址码（沙特必填） Length<=50
packageList/productList/	一对多	Y	一次最多支持10个产品信息（请注意：超过10个将会忽略，系统只保留10个产品）
packageList/productList/ declareEnName	String	Y	申报英文名称 Length <= 100
packageList/productList/ declareCnName	String	Y	申报中文名称 Length <= 100
packageList/productList/ quantity	Integer	Y	产品数量数值必须为正整数
packageList/productList/ declarePrice	Double	Y	进口申报单价，数值必须大于0 系统接收后自动四舍五入至2位小数最终申报总价值为Σ(单价*数量)
packageList/productList/ currencyCode	String	N	进口申报币种 Length = 3 默认：USD 目前只支持USD、GBP、EUR、AUD
packageList/productList/ productSku	String	N	产品、配货SKU Length <= 100 如果此值为空，面单将会显示申报英文名称
packageList/productList/ customCode	String	N	海关编码 6 >= Length <= 10
packageList/productList/ productMaterial	String	N	产品材质 Length <= 50
packageList/productList/ productPurpose	String	N	产品用途 Length <= 50
packageList/productList/ sellerName	String	N	卖家名称 Length<=100 默认：公司名称
packageList/productList/ sellerCreditCode	String	N	卖家信用代码 Length<=50 默认：公司社会信用代码
packageList/productList/ platformName	String	N	平台名称(建议发往智利的包裹均填写该字段) Length<=50
packageList/productList/ exportDeclaredValue	Double	N	出口申报价值，数值必须大于0 系统接收后自动四舍五入至2位小数最终出口申报总价值为Σ(出口申报价值*数量)
packageList/productList/ exportDeclaredCurrencyCode	String	N	出口申报币种 Length = 3 默认：USD 目前只支持USD、GBP、EUR、AUD、CNY
packageList/productList/ productUrl	String	N	产品销售链接 Length <= 200
packageList/productList/ productNo	String	N	产品编码亚马逊平台对应ASIN字段，Length <= 50
packageList/productList/ mPid	String	N	商家产品标识符欧盟国家11月起清关需要，Length <= 64
packageList/productList/ sPid	String	N	标准化产品标识符 Length <= 64
packageList/productList/ nsPid	String	N	非标准化制造商产品标识符欧盟国家11月起清关需要，Length <= 64

2.请求示例复制代码

					
{
	"data": {
		"packageList": [{
			"customerOrderNo": "C14491429182620",
			"shippingMethodCode": "TEST",
			"salesPlatform": "Amazon",
			"packageLength": 33.3,
			"packageWidth": 22.2,
			"packageHeight": 11.2,
			"predictionWeight": 0.88,
			"recipientName": "sunyou",
			"recipientCountryCode": "CN",
			"recipientState": "Guangdong",
			"recipientCity": "Shenzhen",
			"recipientPostCode": "51800",
			"recipientStreet": "19th Floor, Block A, Guanghao International Center, Minzhi Subdistrict, Longhua District",
			"recipientPhone": "400-607-5388",
			"recipientMobile": "0755-8656-5656",
			"recipientEmail": "test@sypost.com",
			"productList": [{
					"productSku": "IPHONE6*1",
					"declareEnName": "iphone6",
					"declareCnName": "苹果6",
					"quantity": 1,
					"customCode": "6104320010",
					"productMaterial": "金属",
					"productPurpose": "通讯",
					"declarePrice": 998.31,
					"currencyCode": "USD",
					"sellerName": "test",
					"sellerCreditCode": "test",
					"platformName": "test",
					"exportDeclaredValue": 998.31,
					"exportDeclaredCurrencyCode": "USD",
					"productUrl":"https://www.sypost.com/test.html",
					"mPid":"",
					"sPid":"",
					"nsPid":"",
				},
				{
					"productSku": "CPT001*1",
					"declareEnName": "compute",
					"declareCnName": "电脑",
					"productMaterial": "金属",
					"productPurpose": "通讯",
					"customCode": "6104320010",
					"quantity": 1,
					"declarePrice": 620.22,
					"currencyCode": "USD",
					"sellerName": "test",
					"sellerCreditCode": "test",
					"platformName": "test",
					"exportDeclaredValue": 620.22,
					"exportDeclaredCurrencyCode": "USD",
					"productUrl":"https://www.sypost.com/test.html",
					"mPid":"",
					"sPid":"",
					"nsPid":"",
				}
			]
		}]
	}
}

3.返回参数

参数级别/参数名称	类型/关系	是否必定返回	参数含义及数值要求
ack	String	Y	接口是否访问成功 SUCCESS：成功 FAILURE：失败该字段仅用于判断服务接口是否正常响应，请勿用于判断包裹时否创建或预报成功。
errorCode	String	Y	当ack为FAILURE的时候，返回的错误代码
errorMsg	String	Y	当ack为FAILURE的时候，返回的错误信息
resultList /	一对多	N
resultList / customerOrderNo	String	Y	客户订单号
resultList / syOrderNo	String	N	顺友流水号（成功时必会返回）
resultList / trackingNumber	String	N	追踪号（有值必会返回）
resultList / currencyCode	String	N	预估费用币种
resultList / predictionFreight	Double	N	包裹预估费用
resultList / labelPath	String	N	面单标签地址
resultList / repearUploadStatus	String	Y	重复上传标识(0：否 1：是) 说明：标识此次请求是否重复上传重复上传并不会覆盖原数据，请注意
resultList / processStatus	String	Y	处理状态(success:成功 failure:失败)
resultList / errorCode	String	N	错误代码 processStatus为failure时必定返回请参见附录
resultList / errorMsg	String	N	错误信息 processStatus为failure时必定返回

4.返回示例复制代码

					
成功：
{
    "ack": "success",
    "data": {
        "resultList": [
            {
                "syOrderNo": "SY10000050059",
                "customerOrderNo": "C14491429182631",
                "trackingNumber": "RT000001766US",
                "processStatus": "success",
                "repearUploadStatus": "0",
                "currencyCode" : "CNY",
                "predictionFreight": 8.88,
                "labelPath": "https://www.sypost.com/**/SY10000050059.pdf"
            },
            {
                "syOrderNo": "SY10000050067",
                "customerOrderNo": "C14491429182620",
                "trackingNumber": "RT000001766US",
                "processStatus": "success",
                "repearUploadStatus": "0",
                "currencyCode" : "CNY",
                "predictionFreight": 9.99,
                "labelPath": "https://www.sypost.com/**/SY10000050067.pdf"
            }
        ]
    }
} 
失败:
1：全部失败
{
	    "ack": "failure",
	    "errorMsg": "当前帐号存在超账期的账单未结清，请尽快结清！",
	    "errorCode": "S1027",
	    "accessId": "1577081186350589044"
}
2：部分失败
{
    "ack": "success",
    "data": {
        "resultList": [
            {
                "customerOrderNo": "C14491436570901",
                "processStatus": "failure",
                "errorList": [
                    {
                        "errorCode": "S1110",
                        "errorMsg": "收件地址1不能为空"
                    }
                ]
            },
            {
                "customerOrderNo": "C14491436570890",
                "processStatus": "failure",
                "errorList": [
                    {
                        "errorCode": "S1110",
                        "errorMsg": "收件地址1不能为空"
                    }
                ]
            }
        ]
    }
}

createAndConfirmPackages（创建并预报包裹）

接口说明

1.请求参数

2.请求示例 复制代码

3.返回参数

4.返回示例 复制代码

2.请求示例复制代码

4.返回示例复制代码