1. Evs下载面单
1.2. 下载pdf 文件
Type: GET
Author: rainy
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 下载pdf 文件
Request-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
username | string | 用户名 | true | - |
apikey | string | 用户验证key | true | - |
key | string | 文件key(创建面单返回的标识符) | true | - |
Request-example:
curl -X GET -i https://api.duoduo.biz/usps/evs/download?apikey=202cb962ac591111111111152d234b70&username=txxxxxs&key=61EFF7D0DAAAAAAAAAA2BD9A123F29CD
Response-example:
This api return nothing.
2. Evs创建面单
2.2. 创建面单
Type: POST
Author: rainy
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 创建面单
Request-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
username | string | 用户名 | true | - |
apikey | string | 用户验证key | true | - |
imageParameters | object | 图像参数 | false | - |
└─imageParameter | string | 图像参数 BARCODE ONLY CROP 4X6LABEL 4X6LABELL 6X4LABEL 4X6LABELP 4X6LABELP PAGE SEPARATECONTINUEPAGE 4X6LABELZPL | false | - |
└─xcoordinate | string | 画面坐标x值 最高900 | false | - |
└─ycoordinate | string | 画面坐标y值 最高1000 | false | - |
└─labelSequence | object | 面单信息 | false | - |
└─packageNumber | int32 | packageNumber 包裹顺序号 | false | - |
└─totalPackages | int32 | totalPackages 包裹总数 | false | - |
evsSender | object | 发件人 | false | - |
└─fromName | string | 发件人姓名 | false | - |
└─fromCompany | string | 发件人公司名称 | false | - |
└─fromAddress1 | string | 发件人第一次交货地址线 | true | - |
└─fromAddress2 | string | 发件人第二次交货地址线 | false | - |
└─fromCity | string | 发件人城市 | true | - |
└─fromState | string | 发件人所在的州或省 | true | - |
└─fromZip5 | string | 发件人邮政编码 | true | - |
└─fromZip4 | string | 发件人zip+4 | false | - |
└─fromPhone | string | 发件人的电话 | true | - |
└─pozipCode | string | 发件人邮局邮箱 | false | - |
└─allowNonCleansedOriginAddr | string | 检查地址是否错误 | false | - |
evsReceiver | object | 收件人 | false | - |
└─toName | string | 收件人姓名 | false | - |
└─toCompany | string | 收件人公司 | false | - |
└─toAddress1 | string | 收件人地址1 | true | - |
└─toAddress2 | string | 收件人地址2 | false | - |
└─toCity | string | 收件人城市 | false | - |
└─toState | string | 收件人省 | false | - |
└─toZip5 | string | 收件人邮政编码 | true | - |
└─toZip4 | string | 收件人zip+4 | false | - |
└─toPhone | string | 收件人电话 | false | - |
└─pobox | string | 是否是邮政信箱 | false | - |
└─toContactPreference | string | 是否通知收件人 | false | - |
└─toContactMessaging | string | 是否是邮政信箱 | false | - |
└─toContactEmail | string | 是否是邮政信箱 | false | - |
└─allowNonCleansedDestAddr | string | 是否需要检查错误 | false | - |
weightOz | number | 重量 (单位磅) | true | - |
serviceType | string | 服务状态 (PRIORITY EXPRESS,PRIORITY,FIRST CLASS ,PARCEL SELECT GROUND) | true | - |
container | string | 包装方式 | false | - |
width | number | 宽 单位英寸 (如果serviceType =‘PRIORITY’ ,'‘PARCEL SELECT NPS’的话就必须填写 ) | false | - |
length | number | 长 单位英寸 (如果serviceType =‘PRIORITY’ ,'‘PARCEL SELECT NPS’的话就必须填写 ) | false | - |
height | number | 高 单位英寸 (如果serviceType =‘PRIORITY’ ,'‘PARCEL SELECT NPS’的话就必须填写 ) | false | - |
priceOptions | string | PriceOptions 是否返回零售价 | false | - |
insuredAmount | string | InsuredAmount 申报金额 | false | - |
expressMailOptions | object | ExpressMailOptions 签名服务 当ServiceType=’EXPRESS’ 是有效 | false | - |
└─waiverOfSignature | boolean | 签名要求 | false | - |
└─esofAllowed | boolean | 是否允许签名 | false | - |
shipDate | string | ShipDate 发货时间 当前时间的0-7天内填写 格式为dd-mmm-yyyy | false | - |
extraServices | object | extraServices 额外服务 | false | - |
└─extraService | string | 额外服务 值为编号 value=100 | false | - |
senderName | string | SenderName 电子邮件发件人的名称。 | false | - |
senderEMail | string | SenderEMail 发件人邮件 | false | - |
recipientName | string | RecipientName 电子邮件收件人的名称。 | false | - |
recipientEMail | string | RecipientEMail 收件人邮件 | false | - |
content | object | Content 物品类型 | false | - |
└─contentType | string | ContentType 物品类别 | false | - |
└─ontentDescription | string | ContentDescription 内容描述 | false | - |
destinationEntryFacilityType | string | 目的地输入设施类型 (None,DNDC,DSCF,DDU) | false | - |
Request-example:
curl -X POST -i https://api.duoduo.biz/usps/evs/createLabel --data 'content.ontentDescription=3eyiro&evsSender.fromCity=1na9iq&expressMailOptions.waiverOfSignature=true&imageParameters.imageParameter=j68wwp&evsReceiver.toCompany=xxx@mail.com&shipDate=2020-11-10&evsSender.pozipCode=94570&extraServices.extraService=0h4pso&expressMailOptions.esofAllowed=true&evsSender.fromAddress1=528w0s&insuredAmount=4jk3we&evsReceiver.toAddress2=7idhjg&evsReceiver.toCity=qfyifk&evsReceiver.pobox=8gbpzz&evsReceiver.toZip5=lry5u1&evsReceiver.toContactPreference=0iddbg&length=368&apikey=202cb962ac591111111111152d234b70&height=89&evsReceiver.toZip4=bv6pmx&evsSender.fromState=pcoi4i&evsReceiver.toName=xxx&evsSender.fromZip5=podzqs&evsReceiver.toAddress1=8mfjju&evsSender.fromCompany=xxx&serviceType=vaylsz&evsSender.fromName=xxx&evsReceiver.toPhone=17536230446&priceOptions=nw926j&evsReceiver.toContactEmail=false&recipientEMail=xxx@mail.com&evsReceiver.toContactMessaging=zjqpv8&evsSender.fromPhone=17536230446&evsReceiver.allowNonCleansedDestAddr=v4fxtu&senderName=xxx&recipientName=xxx&content.contentType=vc8noa&evsSender.fromAddress2=oy0ue6&imageParameters.ycoordinate=5rj810&evsReceiver.toState=a0kfkr&evsSender.allowNonCleansedOriginAddr=36km6l&container=qwpboa&evsSender.fromZip4=54ygqo&senderEMail=xxx@mail.com&imageParameters.xcoordinate=brwcee&width=935&username=txxxxxs&imageParameters.labelSequence.totalPackages=726&destinationEntryFacilityType=nlm8r5&imageParameters.labelSequence.packageNumber=750&weightOz=440'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
Status | string | 状态 | - |
errorMessage | string | 错误信息 | - |
totalAmount | number | 邮资 | - |
mailClass | string | 快件类型 | - |
key | string | 下载key | - |
trackingNo | string | 运单号 | - |
isapproved | boolean | 是否退款 | - |
amount | number | 余额 | - |
Response-example:
{ "Status":"r4x6ic", "errorMessage":"success", "totalAmount":480, "mailClass":"hikzyw", "key":"8ncd4q", "trackingNo":"tpwow6", "isapproved":true, "amount":198 }
2.3. 查询价格
Type: POST
Author: rainy
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: 查询价格
Request-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
username | string | 用户名 | true | - |
imageParameters | object | 图像参数 | false | - |
└─imageParameter | string | 图像参数 BARCODE ONLY CROP 4X6LABEL 4X6LABELL 6X4LABEL 4X6LABELP 4X6LABELP PAGE SEPARATECONTINUEPAGE 4X6LABELZPL | false | - |
└─xcoordinate | string | 画面坐标x值 最高900 | false | - |
└─ycoordinate | string | 画面坐标y值 最高1000 | false | - |
└─labelSequence | object | 面单信息 | false | - |
└─packageNumber | int32 | packageNumber 包裹顺序号 | false | - |
└─totalPackages | int32 | totalPackages 包裹总数 | false | - |
evsSender | object | 发件人 | false | - |
└─fromName | string | 发件人姓名 | false | - |
└─fromCompany | string | 发件人公司名称 | false | - |
└─fromAddress1 | string | 发件人第一次交货地址线 | true | - |
└─fromAddress2 | string | 发件人第二次交货地址线 | false | - |
└─fromCity | string | 发件人城市 | true | - |
└─fromState | string | 发件人所在的州或省 | true | - |
└─fromZip5 | string | 发件人邮政编码 | true | - |
└─fromZip4 | string | 发件人zip+4 | false | - |
└─fromPhone | string | 发件人的电话 | true | - |
└─pozipCode | string | 发件人邮局邮箱 | false | - |
└─allowNonCleansedOriginAddr | string | 检查地址是否错误 | false | - |
evsReceiver | object | 收件人 | false | - |
└─toName | string | 收件人姓名 | false | - |
└─toCompany | string | 收件人公司 | false | - |
└─toAddress1 | string | 收件人地址1 | true | - |
└─toAddress2 | string | 收件人地址2 | false | - |
└─toCity | string | 收件人城市 | false | - |
└─toState | string | 收件人省 | false | - |
└─toZip5 | string | 收件人邮政编码 | true | - |
└─toZip4 | string | 收件人zip+4 | false | - |
└─toPhone | string | 收件人电话 | false | - |
└─pobox | string | 是否是邮政信箱 | false | - |
└─toContactPreference | string | 是否通知收件人 | false | - |
└─toContactMessaging | string | 是否是邮政信箱 | false | - |
└─toContactEmail | string | 是否是邮政信箱 | false | - |
└─allowNonCleansedDestAddr | string | 是否需要检查错误 | false | - |
weightOz | number | 重量 (单位磅) | true | - |
serviceType | string | 服务状态 (PRIORITY EXPRESS,PRIORITY,FIRST CLASS ,PARCEL SELECT GROUND) | true | - |
container | string | 包装方式 | false | - |
width | number | 宽 单位英寸 (如果serviceType =‘PRIORITY’ ,'‘PARCEL SELECT NPS’的话就必须填写 ) | false | - |
length | number | 长 单位英寸 (如果serviceType =‘PRIORITY’ ,'‘PARCEL SELECT NPS’的话就必须填写 ) | false | - |
height | number | 高 单位英寸 (如果serviceType =‘PRIORITY’ ,'‘PARCEL SELECT NPS’的话就必须填写 ) | false | - |
priceOptions | string | PriceOptions 是否返回零售价 | false | - |
insuredAmount | string | InsuredAmount 申报金额 | false | - |
expressMailOptions | object | ExpressMailOptions 签名服务 当ServiceType=’EXPRESS’ 是有效 | false | - |
└─waiverOfSignature | boolean | 签名要求 | false | - |
└─esofAllowed | boolean | 是否允许签名 | false | - |
shipDate | string | ShipDate 发货时间 当前时间的0-7天内填写 格式为dd-mmm-yyyy | false | - |
extraServices | object | extraServices 额外服务 | false | - |
└─extraService | string | 额外服务 值为编号 value=100 | false | - |
senderName | string | SenderName 电子邮件发件人的名称。 | false | - |
senderEMail | string | SenderEMail 发件人邮件 | false | - |
recipientName | string | RecipientName 电子邮件收件人的名称。 | false | - |
recipientEMail | string | RecipientEMail 收件人邮件 | false | - |
content | object | Content 物品类型 | false | - |
└─contentType | string | ContentType 物品类别 | false | - |
└─ontentDescription | string | ContentDescription 内容描述 | false | - |
destinationEntryFacilityType | string | 目的地输入设施类型 (None,DNDC,DSCF,DDU) | false | - |
partnerCustomerID | string | 会员信息 | true | - |
Request-example:
curl -X POST -i https://api.duoduo.biz/usps/evs/quote --data 'evsSender.fromZip5=f4r41t&expressMailOptions.waiverOfSignature=true&recipientEMail=xxx@mail.com&evsSender.pozipCode=94570&evsReceiver.toZip5=yvd6yg&shipDate=2020-11-10&evsReceiver.toName=xxx&evsSender.allowNonCleansedOriginAddr=gze68s&container=4ebjpe&extraServices.extraService=sbls6r&recipientName=xxx&content.contentType=ggf0ho&evsReceiver.toPhone=17536230446&partnerCustomerID=90&evsReceiver.allowNonCleansedDestAddr=aw4nfs&evsSender.fromPhone=17536230446&evsReceiver.pobox=vivygy&evsSender.fromCompany=xxx&evsReceiver.toZip4=sjjxfo&username=浩宇.邵&evsReceiver.toState=3fm6hq&evsSender.fromState=mcg6hr&evsReceiver.toCompany=xxx@mail.com&destinationEntryFacilityType=4siva7&imageParameters.labelSequence.totalPackages=745&evsReceiver.toAddress2=cu4ydg&evsSender.fromCity=pjojs6&priceOptions=hqfdn3&serviceType=t0ala9&imageParameters.imageParameter=pi1pl3&imageParameters.labelSequence.packageNumber=869&content.ontentDescription=2tkmwy&imageParameters.ycoordinate=qe2hyc&weightOz=986&senderEMail=xxx@mail.com&evsSender.fromAddress2=25m8y7&evsReceiver.toContactMessaging=rbyevq&evsSender.fromName=xxx&evsReceiver.toContactPreference=2xdfqf&length=676&expressMailOptions.esofAllowed=true&evsReceiver.toContactEmail=false&evsReceiver.toAddress1=0k7vr2&senderName=xxx&insuredAmount=kc2dy7&imageParameters.xcoordinate=7z1ahj&evsSender.fromAddress1=tbe69y&evsSender.fromZip4=3h2rrj&evsReceiver.toCity=7aurfb&width=189&height=574'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
Status | string | 状态 | - |
errorMessage | string | 错误信息 | - |
totalAmount | number | 邮资 | - |
mailClass | string | 快件类型 | - |
key | string | 下载key | - |
trackingNo | string | 运单号 | - |
isapproved | boolean | 是否退款 | - |
amount | number | 余额 | - |
Response-example:
{ "Status":"acjvwj", "errorMessage":"success", "totalAmount":746, "mailClass":"1wyl8j", "key":"0v14bv", "trackingNo":"zmopew", "isapproved":true, "amount":380 }
3. Evs退款接口
3.2. Evs面单退款
Type: POST
Author: rainy
Content-Type: application/x-www-form-urlencoded;charset=utf-8
Description: Evs面单退款
Request-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
trackingNo | string | 订单号 | true | - |
gukey | string | 订单key | true | - |
username | string | 用户名 | true | - |
apikey | string | api验证key | true | - |
Request-example:
curl -X POST -i https://api.duoduo.biz/usps/evs/refund --data 'trackingNo=42010009999999999999999997770&apikey=202cb962ac591111111111152d234b70&gukey=61EFF7D0DAAAAAAAAAA2BD9A123F29CD&username=texxt'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
Status | string | 状态 | - |
errorMessage | string | 错误信息 | - |
reason | string | 错误信息 | - |
totalAmount | number | 邮资 | - |
mailClass | string | 快件类型 | - |
trackingNo | string | 运单号 | - |
isapproved | boolean | 是否退款 | - |
Response-example:
{ "Status":"hg4268", "errorMessage":"success", "reason":"d91cr0", "totalAmount":539, "mailClass":"x5wx2j", "trackingNo":"ixtqmj", "isapproved":true }