开发者文档

完善的 RESTful API 接口和详细文档，轻松集成到您的业务系统中。

快递服务API 列表

获取 User Token

使用Token和Key，获取访问授权Token。在后续的接口访问时在HTTP Header的Authorization字段中带上该Token进行鉴权。

Token有效期为1小时。

POST /usersvc/gettoken

Header 参数

Content-Typestring可选

示例

application/json

Body 参数

参数名 类型 必填 描述
AppKeystring是application Key
AppSecretstring是application secret token

示例

{
    "AppKey":"string",
    "AppSecret":"string"
}

返回响应

参数名 类型 描述
Resultstring用户Token
ErrorCodestring错误代码
MessagestringMessage

示例

{
    "Result":"eyJhbGciOiJI....eyJzd....8hwQ3..",
    "ErrorCode":"string",
    "Message":"string"
}

获取用户地址列表

获取用户的发货地址列表。快递必须从这些地址列表中的地址发货。

GET /usersvc/addresses

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

bearer eyJhbGciOiJI....eyJzd....8hwQ3..

Body 参数

参数名类型必填描述

示例

返回响应

参数名 类型 描述
Idint用户地址编号
Defaultbool是否是默认地址
UserInfoIdint用户编号
Address{} (json对象)地址详情
Address.Namestring名称
Address.Address1string地址1
Address.Address2string地址2
Address.Citystring城市
Address.Provincestring州
Address.Countrystring国家
Address.PostalCodestring邮编

示例

[{
    Id:1,
    Default:true,
    UserInfoId:1,
    Address:
    {
        Name:"string",
        Address1:"string1",
        Address2:"string2,
        City:"string",
        Province:"string",
        Country:"string",
        PostalCode:"string"
    }
}]

运费估算

估算订单的运费

POST /labelordersvc/rate

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

bearer eyJhbGciOiJI....eyJzd....8hwQ3..

Body 参数

参数名 类型 必填 描述
Numberstring可选订单号码
ShipperNameOrCodestring必须发件人名称或代码 (目前请使用名称)
ShipperCompanystring必须发件人公司
ShipperPhonestring必须发件人电话 (最长12位数字)
UserAddressInfoIdint必须发货地址编号
Stateint可选订单状态
TargetNamestring必须收件人名称
TargetPhonestring必须收件人电话号码
TargetCompanystring必须收件人公司
TargetCountrystring必须收件人国家
TargetStatestring必须收件人州
TargetCitystring必须收件人城市
TargetPostalCodestring必须收件人邮编
TargetAddress1string必须收件人地址1
TargetAddress2string可选收件人地址2
SignatureServicestring必须签名服务: 无/普通签名/成人签名 (-/SSF/ASS 三选一)
Unitstring必须单位:磅-英尺/千克-厘米 (Lbs-Inch/Kgs-Cm 二选一)
Typeint可选订单类型
Descriptionstring可选订单描述
CustomerRefstring可选客户订单号
Commentsstring可选订单备注
IsResidentialbool可选是否住宅住址。如果不传值，默认为住宅地址。
Packages[] (json列表)必须包裹列表，至少须要一个
Packages.Seqint可选序列号
Packages.SizeXdouble必须长
Packages.SizeYdouble必须宽
Packages.SizeZdouble必须高
Packages.NetWeightdouble必须净重
Packages.Qtyint必须数量

示例

{
    ShipperNameOrCode:"string",
    ShipperCompany:"string",
    ShipperPhone:"string",
    UserAddressInfoId:1,
    State:1,
    TargetName:"string",
    TargetPhone:"string",
    TargetCompany:"string",
    TargetCountry:"string",
    TargetState:"string",
    TargetCity:"string",
    TargetPostalCode:"string",
    TargetAddress1:"string",
    TargetAddress2:"string",
    SignatureService:"-",
    Unit:"Lbs-Inch",
    Type:0,
    Description:"string",
    CustomerRef:"string",
    Comments:"string",
    IsResidential:true,
    Packages:
    {
        Seq:1,
        SizeX:1,
        SizeY:1,
        SizeZ:1,
        NetWeight:1,
        Qty:1
    }
}

返回响应

参数名 类型 描述
Resultjson估算结果
Result.UserAddressInfoIdint发货地址编号
Result.OrderNumberstring订单号码
Result.ReferenceNumberstring报价信息编号
Result.CurrencyCodestring货币
Result.Totaldouble总价
Result.ChargeDetail[] (json列表)收费明细
Result.ChargeDetail.Amountint金额
Result.ChargeDetail.Descriptionint描述
ErrorCodestring错误代码
MessagestringMessage

示例

{
    Result：
    {
        UserAddressInfoId:1,
        OrderNumber:"string",
        ReferenceNumber:"string",
        CurrencyCode:"string",
        Total:1.0,
        ChargeDetail:
        [{
            Amount:1,
            Description:"string"
        }]
    },
    ErrorCode:"string",
    Message:"string"
}

提交订单

提交创建订单。

POST /labelordersvc/create

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

bearer eyJhbGciOiJI....eyJzd....8hwQ3..

Body 参数

参数名 类型 必填 描述
Numberstring可选订单号码
ReferenceNumberstring必须报价信息编号。值是运费估算接口返回的ReferenceNumber字段。
ShipperNameOrCodestring必须发件人名称或代码 (目前请使用名称)
ShipperCompanystring必须发件人公司
ShipperPhonestring必须发件人电话 (最长12位数字)
UserAddressInfoIdint必须发货地址编号
Stateint可选订单状态
TargetNamestring必须收件人名称
TargetPhonestring必须收件人电话号码
TargetCompanystring必须收件人公司
TargetCountrystring必须收件人国家
TargetStatestring必须收件人州
TargetCitystring必须收件人城市
TargetPostalCodestring必须收件人邮编
TargetAddress1string必须收件人地址1
TargetAddress2string可选收件人地址2
SignatureServicestring必须签名服务: 无/普通签名/成人签名 (-/SSF/ASS 三选一)
Unitstring必须单位:磅-英尺/千克-厘米 (Lbs-Inch/Kgs-Cm 二选一)
Typeint可选订单类型
Descriptionstring可选订单描述
CustomerRefstring可选客户订单号
Commentsstring可选订单备注
IsResidentialbool可选是否住宅住址。如果不传值，默认为住宅地址。
Packages[] (json列表)必须包裹列表，至少须要一个
Packages.Seqint可选序列号
Packages.SizeXdouble必须长
Packages.SizeYdouble必须宽
Packages.SizeZdouble必须高
Packages.NetWeightdouble必须净重
Packages.Qtyint必须数量

示例

{
    ReferenceNumber:"string"
    ShipperNameOrCode:"string"
    ShipperCompany:"string"
    ShipperPhone:"string"
    UserAddressInfoId:1
    TargetName:"string"
    TargetPhone:"string"
    TargetCompany:"string"
    TargetCountry:"string"
    TargetState:"string"
    TargetCity:"string"
    TargetPostalCode:"string"
    TargetAddress1:"string"
    SignatureService:"-"
    Unit:"Lbs-Inch"
    Description:"string"
    CustomerRef:"string"
    Comments:"string"
    IsResidential:true
    Packages:
    {
        Seq:1
        SizeX:1
        SizeY:1
        SizeZ:1
        NetWeight:1
        Qty:1
    }
}

返回响应

参数名 类型 描述
Resultjson估算结果
Result.UserAddressInfoIdint发货地址编号
Result.OrderNumberstring订单号码
Result.CurrencyCodestring货币
Result.Totaldouble总价
Result.MergeLabelstring面单
Result.ReferenceNumberstringReference No
Result.Fees[] (json列表)收费列表
Result.Fees.Amountdouble金额
Result.Fees.CurrencyCodestring货币代码
Result.Fees.FtCodestring收费项代码
Result.Fees.FtNamestring收费项名称
Result.FeeDetails[] (json列表)收费明细列表
Result.FeeDetails.Amountdouble金额
Result.FeeDetails.CurrencyCodestring货币代码
Result.FeeDetails.FtCodestring收费项代码
Result.FeeDetails.FtNamestring收费项名称
Result.FeeDetails.TrackingNumberstring跟踪编号
Result.FeeDetails.BoxCodeint打包代码
Result.Labels[] (json列表)面单列表
Result.Labels.TrackingNumberstring跟踪编号
Result.Labels.LabelUrlstring面单链接
Result.Labels.FileTypestring文件类型
ErrorCodestring错误代码
MessagestringMessage

示例

{
    "Result":
    {
        "UserAddressInfoId":1
        "OrderNumber":"string"
        "CurrencyCode":"string"
        "Total":111
        "MergeLabel":"string"
        "ReferenceNumber":"string"
        "Fees":
        {
            "Amount":11
            "CurrencyCode":"string"
            "FtCode":"string"
            "FtName":"string"
        }
        "FeeDetails":
        {
            "Amount":11
            "CurrencyCode":"string"
            "FtCode":"string"
            "FtName":"string"
            "TrackingNumber":"string"
            "BoxCode":"string"
        }
        "Labels":
        {
            "TrackingNumber":"string"
            "LabelUrl":"string"
            "FileType":"string"
        }
    }
    "ErrorCode":"string"
    "Message":"string"
}

取消订单

取消订单。

POST /labelordersvc/cancel/{OrderNumber}

路径参数

参数名类型必填描述
OrderNumberstring是订单号

示例

/labelordersvc/cancel/ordernumber1234

返回响应

参数名 类型 描述
Resultstring取消结果
ErrorCodestring错误代码
MessagestringMessage

示例

{
    "Result":"string"
    "ErrorCode":"string"
    "Message":"string"
}

查询订单

获取订单详情。

GET /labelordersvc/{OrderNumber}

路径参数

参数名类型必填描述
OrderNumberstring是订单号

示例

/labelordersvc/ordernumber1234

返回响应

参数名 类型 描述
ErrorCodestring错误代码
MessagestringMessage
Resultstring取消结果
Result.Numberstring订单号码
Result.ShipperNameOrCodestring发件人名称或代码 (目前请使用名称)
Result.ShipperCompanystring发件人公司
Result.ShipperPhonestring发件人电话 (最长12位数字)
Result.UserAddressInfoIdint发货地址编号
Result.Stateint订单状态
Result.TargetNamestring收件人名称
Result.TargetPhonestring收件人电话号码
Result.TargetCompanystring收件人公司
Result.TargetCountrystring收件人国家
Result.TargetStatestring收件人州
Result.TargetCitystring收件人城市
Result.TargetPostalCodestring收件人邮编
Result.TargetAddress1string收件人地址1
Result.TargetAddress2string收件人地址2
Result.SignatureServicestring签名服务: 无/普通签名/成人签名 (-/SSF/ASS 三选一)
Result.Unitstring单位:磅-英尺/千克-厘米 (Lbs-Inch/Kgs-Cm 二选一)
Result.Typeint订单类型
Result.Descriptionstring订单描述
Result.CustomerRefstring客户订单号
Result.Commentsstring订单备注
Result.Packages[] (json列表)包裹列表，至少须要一个
Result.Packages.Seqint序列号
Result.Packages.SizeXdouble长
Result.Packages.SizeYdouble宽
Result.Packages.SizeZdouble高
Result.Packages.NetWeightdouble净重
Result.Packages.Qtyint数量
Result.Creation{} (json对象)订单创建信息
Result.Creation.UserAddressInfoIdstring发货地址编号
Result.Creation.OrderNumberstring订单号码
Result.Creation.CurrencyCodestring货币
Result.Creation.Totaldouble总价
Result.Creation.MergeLabelstring面单
Result.Creation.ReferenceNumberstringReference No
Result.Creation.Fees[] (json列表)收费列表
Result.Creation.Fees.Amountdouble金额
Result.Creation.Fees.CurrencyCodestring货币代码
Result.Creation.Fees.FtCodestring收费项代码
Result.Creation.Fees.FtNamestrng收费项名称
Result.Creation.FeeDetails[] (json列表)收费明细列表
Result.Creation.FeeDetails.Amountdouble金额
Result.Creation.FeeDetails.CurrencyCodestring货币代码
Result.Creation.FeeDetails.FtCodestring收费项代码
Result.Creation.FeeDetails.FtNamestring收费项名称
Result.Creation.FeeDetails.TrackingNumberstring跟踪编号
Result.Creation.FeeDetails.BoxCodestring打包代码
Result.Creation.Labels[] (json列表)面单列表
Result.Creation.Labels.TrackingNumberstring跟踪编号
Result.Creation.Labels.LabelUrlstring面单链接
Result.Creation.Labels.FileTypestring文件类型

示例

{
    "ErrorCode":"string"
    "Message":"string"
    "Result":
    {
        "Number":"string"
        "ShipperNameOrCode":"string"
        "ShipperCompany":"string"
        "ShipperPhone":"string"
        "UserAddressInfoId":1
        "State":1
        "TargetName":"string"
        "TargetPhone":"string"
        "TargetCompany":"string"
        "TargetCountry":"string"
        "TargetState":"string"
        "TargetCity":"string"
        "TargetPostalCode":"string"
        "TargetAddress1":"string"
        "TargetAddress2":"string"
        "SignatureService":"-")
        "Unit":"Lbs-Inch")
        "Type":0
        "Description":"string"
        "CustomerRef":"string"
        "Comments":"string"
        "Packages":
        [{
            "Seq":1
            "SizeX":1
            "SizeY":1
            "SizeZ":1
            "NetWeight":1
            "Qty":1
        }]
        "Creation":
        {
            "UserAddressInfoId":1
            "OrderNumber":"string"
            "CurrencyCode":"string"
            "Total":111
            "MergeLabel":"string"
            "ReferenceNumber":"string"
            "Fees":
            {
                "Amount":111
                "CurrencyCode":"string"
                "FtCode":"string"
                "FtName":"string"
            }
            "FeeDetails":
            {
                "Amount":111
                "CurrencyCode":"string"
                "FtCode":"string"
                "FtName":"string"
                "TrackingNumber":"string"
                "BoxCode":"string"
            }
            "Labels":
            {
                "TrackingNumber":"string"
                "LabelUrl":"string"
                "FileType":"string"
            }
        }
    }
}

准备好开始了吗？

访问快递系统，免费注册并获取您的 API Key。

前往快递系统