邮局 Scan Form

接口URL

/shipment/scanForm

请求方式

POST

美国邮局Scan Form生成，仅个别USPS渠道支持，如有需要使用具体请咨询渠道对接经理

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
trackingCodes	-	String	是	运单号数组，支持单个或多个，每个运单号只能用于一个ScanForm单
fromCompany	-	String	是	发件地址公司名
fromContactName	-	String	是	发件地址联系人名
fromAddressLine	-	String	是	发件地址街道地址
fromCity	-	String	是	发件地址城市
fromStateCode	-	String	是	发件地址洲，两位洲编码
fromCountryCode	-	String	是	发件地址国家，两位国家编码
fromPostalCode	-	String	是	发件地址邮编

请求示例

{
    "trackingCodes":["92359000000000000000000"],
    "fromCompany":"test",
    "fromContactName":"test",
    "fromAddressLine":"street1",
    "fromCity":"Chino",
    "fromStateCode":"CA",
    "fromCountryCode":"US",
    "fromPostalCode":"91710"
}

返回示例

{
    "code": 200,//如部分成功或成功为200，失败则为400
    "data": {
            "ScanFormNumber": "923000000000000000000",
            "fileBase64Data": "",   //base64数据
            "fileDataExt": "pdf",   //base64数据文件扩展名类型
            "failedMessages": [{
                "trackingCode":"",
                "message":""
            }] //如部分成功，个别单错误时可能显示对应单号错误信息，如成功则为空
        },
    "message": "" //失败时错误提示信息
}