1. Evs下载面单

1.2. 下载pdf 文件

Type: GET

Author: rainy

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: 下载pdf 文件

Request-parameters:

ParameterTypeDescriptionRequiredSince

username

string

用户名

true

-

apikey

string

用户验证key

true

-

key

string

文件key(创建面单返回的标识符)

true

-

Request-example:

curl -X GET  -i https://api.ebizw.com/endicia/evs/download?apikey=202cb962ac591111111111152d234b70&key=61EFF7D0DAAAAAAAAAA2BD9A123F29CD&username=txxxxxs

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:

ParameterTypeDescriptionRequiredSince

username

string

用户名

true

-

apikey

string

用户验证key

true

-

imageParameters

object

图像参数

false

-

└─imageParameter

string

图像参数 BARCODE ONLY CROP 4X6LABEL 4X6LABELL 6X4LABEL 4X6LABELP 4X6LABELP PAGE SEPARATECONTINUEPAGE 4X6LABELZPL
默认 4X6LABEL

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
100 Insurance
101 Insurance (PME)
102 Return Receipt

false

-

senderName

string

SenderName 电子邮件发件人的名称。

false

-

senderEMail

string

SenderEMail 发件人邮件

false

-

recipientName

string

RecipientName 电子邮件收件人的名称。

false

-

recipientEMail

string

RecipientEMail 收件人邮件

false

-

content

object

Content 物品类型

false

-

└─contentType

string

ContentType 物品类别
HAZMAT
CrematedRemains
Lives
Perishable
Pharmaceuticals
MedicalSupplies

false

-

└─ontentDescription

string

ContentDescription 内容描述
Bees
DayOldPoultry
AdultBirds
Other

false

-

destinationEntryFacilityType

string

目的地输入设施类型 (None,DNDC,DSCF,DDU)

false

-

Request-example:

curl -X POST  -i https://api.ebizw.com/endicia/evs/createLabel --data 'evsSender.fromCity=qvr612&apikey=202cb962ac591111111111152d234b70&evsReceiver.toContactPreference=mpoq7i&evsReceiver.toCompany=xxx@mail.com&length=717&serviceType=rstzg0&evsReceiver.toPhone=17266559443&priceOptions=vh51hv&insuredAmount=4savnz&evsSender.fromCompany=xxx&senderName=xxx&expressMailOptions.esofAllowed=true&senderEMail=xxx@mail.com&evsReceiver.toName=xxx&shipDate=2020-09-18&evsReceiver.toContactMessaging=wwreti&width=362&height=782&imageParameters.labelSequence.totalPackages=59&evsReceiver.toContactEmail=false&evsReceiver.toZip4=qf478e&evsSender.fromAddress2=xwfx7x&evsReceiver.toZip5=q2xo1z&destinationEntryFacilityType=vmr90o&evsSender.fromZip4=oceljl&extraServices.extraService=tpafpi&imageParameters.imageParameter=0o30yj&evsSender.fromAddress1=a0z6lx&recipientEMail=xxx@mail.com&imageParameters.labelSequence.packageNumber=248&evsSender.fromState=aa4fp7&recipientName=xxx&imageParameters.xcoordinate=s1cbqk&weightOz=938&content.contentType=wibz93&imageParameters.ycoordinate=mbky4k&evsSender.pozipCode=14044&evsReceiver.pobox=hqd16u&evsReceiver.toAddress2=301b22&evsSender.fromZip5=3xx9gs&expressMailOptions.waiverOfSignature=true&container=pmpfpw&evsReceiver.allowNonCleansedDestAddr=vxueqs&username=txxxxxs&evsSender.fromName=xxx&evsReceiver.toAddress1=xn8t6c&evsSender.allowNonCleansedOriginAddr=l2caz3&evsReceiver.toState=ewemwh&evsReceiver.toCity=c4pjxu&evsSender.fromPhone=17266559443&content.ontentDescription=ff3dpk'

Response-fields:

FieldTypeDescriptionSince

Status

string

状态

-

errorMessage

string

错误信息

-

totalAmount

number

邮资

-

mailClass

string

快件类型

-

key

string

下载key

-

trackingNo

string

运单号

-

isapproved

boolean

是否退款

-

amount

number

余额

-

Response-example:

{
	"Status":"lkrjcf",
	"errorMessage":"success",
	"totalAmount":751,
	"mailClass":"yz2e20",
	"key":"329ofz",
	"trackingNo":"87xf4z",
	"isapproved":true,
	"amount":398
}

3. Evs退款接口

3.2. Evs面单退款

Type: POST

Author: rainy

Content-Type: application/x-www-form-urlencoded;charset=utf-8

Description: Evs面单退款

Request-parameters:

ParameterTypeDescriptionRequiredSince

trackingNo

string

订单号

true

-

gukey

string

订单key

true

-

username

string

用户名

true

-

apikey

string

api验证key

true

-

Request-example:

curl -X POST  -i https://api.ebizw.com/endicia/evs/refund --data 'gukey=61EFF7D0DAAAAAAAAAA2BD9A123F29CD&username=texxt&apikey=202cb962ac591111111111152d234b70&trackingNo=42010009999999999999999997770'

Response-fields:

FieldTypeDescriptionSince

Status

string

状态

-

errorMessage

string

错误信息

-

totalAmount

number

邮资

-

mailClass

string

快件类型

-

trackingNo

string

运单号

-

isapproved

boolean

是否退款

-

Response-example:

{
	"Status":"k8n638",
	"errorMessage":"success",
	"totalAmount":369,
	"mailClass":"zdff1p",
	"trackingNo":"axq64d",
	"isapproved":true
}