开发者文档

完善的 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 /shipordersvc/usershipcontracts

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

Body 参数

参数名类型必填描述

示例

返回响应

参数名 类型 描述
Idint用户卡车合约编号
Defaultbool是否是默认地址
Contract{} (json对象)合约详情
Contract.Namestring名称
Contract.Contractstring合约

示例

[{
    "Id":1,
    "Default":true,
    "Contract":
    {
        "Name":"string",
        "Contract":"string"
    }
}]

在线报价TL（整车）

在线整车报价。

POST /shipordersvc/ratetl

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

Body 参数

收件人邮编S
参数名 类型 必填 描述
Numberstring可选订单号码
Typeint必须订单类型。0-线下询价订单，1-线上询价订单
ShipperPostalCodestring必须发件人邮编
ShipperCountrystring必须发件人国家
ShipperStatestring必须发件人州
ShipperCitystring必须发件人城市
ShipperAddress1string可选发件人地址1
ShipperAddress2string可选发件人地址2
ShipperNameOrCodestring可选发件联系人
ShipperCompanystring可选发件地址名称
ShipperPhonestring可选发件人电话 (最长12位数字)
ShipperEmailstring可选发件人电子邮箱
ShipperAddressTypestring必须发件地址类型 ("BUSINESS WITH DOCK","BUSINESS WITHOUT DOCK","RESIDENTIAL" 三选一)
ShipperSvcstring可选发货地址特殊要求 ("Inside","LiftGate" 可多选)
UserShipContractInfoIdint可选用户卡车合约编号。当批量询价时可以不传，则会把当前用户所有可用的合约都询价。
TargetNamestring可选收件人名称
TargetPhonestring可选收件人电话号码
TargetCompanystring可选收件地址名称
TargetCountrystring必须收件人国家
TargetStatestring必须收件人州
TargetCitystring必须收件人城市
TargetPostalCodestring必须
TargetAddress1string可选收件人地址1
TargetAddress2string可选收件人地址2
TargetEmailstring可选收件人电子邮箱
TargetAddressTypestring必须收件地址类型 ("BUSINESS WITH DOCK","BUSINESS WITHOUT DOCK","RESIDENTIAL" 三选一)
TargetSvcstring可选收货地址特殊要求 ("Inside","LiftGate","APPT","GTD","ROC","WGD","WWA" 可多选)
Unitstring必须单位:磅-英尺/千克-厘米 (Lbs-Inch或Kgs-Cm 二选一)
Descriptionstring可选订单描述
CustomOrderstring可选客户订单号
Commentsstring可选订单备注
ShipDatestring必须发货日期
IdealCoststring可选心理价格
IdealTimestring可选心理运输天数
TL_LTLbool必须false, 整车；true, 零担
Packages[] (json列表)必须包裹列表，至少须要一个
Packages.Seqint可选序列号
Packages.Namestring必须货物名称
Packages.Valuedouble必须货物价值
Packages.Aclassstring可选货物等级
Packages.SizeXdouble必须长
Packages.SizeYdouble必须宽
Packages.SizeZdouble必须高
Packages.Weightdouble必须总重
Packages.Qtyint必须数量
Packages.PalletQtyint必须打托数量
Packages.PackageTypeIdstring必须货物包装类型编号 // 1 BAG, 2 BOXES, 3 CARTONS, 4 CASE, 5 DRUMS, 6 KEGS, 7 REELS, 8 ROLLS, 9 TOTE, 10 TUBES, 11 PALLETS, 12 PIECES, 13 CYLINDERS, 14 CRATE
Packages.UnitTypeIdstring必须打托类型编号 // 3 PALLETS, 8 CRATE
Packages.IsHazmatbool可选是否危险品 ：0 非危险品 1 危险品，
Packages.UnNumberstring可选危险品编码 ，如果isHazmat 传 1 ，该字段必传
Packages.BClassstring可选危险品等级，如果isHazmat 传 1 ，该字段必传
Packages.Poisonbool可选是否有毒 ：0 无毒 1 有毒， 如果isHazmat 传 1 ，该字段必传
Packages.HazmatContactNamestring可选危险品联系人，如果isHazmat 传 1，该字段必传
Packages.HazmatPhonestring可选危险品联系手机号，如果isHazmat 传 1，该字段必传
Packages.NmfcNumberint可选NMFC编号
Packages.NmfcSubint可选nmfcSub

示例

{
    "ShipDate":"2026-01-10",
    "Type":1,
    "TL_LTL":false,
    "ShipperCountry":"string",
    "ShipperState":"string",
    "ShipperCity":"string",
    "ShipperPostalCode":"string",
    "ShipperNameOrCode":"string",
    "ShipperCompany":"string",
    "ShipperPhone":"string",
    "ShipperAddressType":"string",
    "ShipperSvc":"Inside,LiftGate",
    "UserShipContractInfoId":1,
    "TargetName":"string",
    "TargetPhone":"string",
    "TargetCompany":"string",
    "TargetCountry":"string",
    "TargetState":"string",
    "TargetCity":"string",
    "TargetPostalCode":"string",
    "TargetAddress1":"string",
    "TargetAddressType":"BUSINESS WITH DOCK",
    "TargetSvc":"Inside,LiftGate",
    "Unit":"Lbs-Inch",
    "Description":"string",
    "CustomOrder":"string",
    "Packages":
    [{
        "Name":"string",
        "Value":111,
        "Aclass":"100",
        "SizeX":1,
        "SizeY":1,
        "SizeZ":1,
        "Weight":10,
        "Qty":1,
        "PalletQty":1,
        "PackageTypeId":"2",
        "UnitTypeId":"3"
    }]
}

返回响应

险
参数名 类型 描述
ErrorCodestring错误代码
MessagestringMessage
Resultjson估算结果
Result.ReferenceNumberstring询价订单id
Result.MessagestringMessage
Result.Numberstring平台订单台
Result.Codestring错误代码
Result.Details[] (json列表)报价明细
Result.Details.ReferenceNumberstring询价订单号
Result.Details.UserShipContractInfoIdstring用户卡车合约编号
Result.Details.Idint报价记录编号
Result.Details.RateIdstring报价流水号
Result.Details.TotalChargedouble总价
Result.Details.AccessorialChargedouble额外附加费
Result.Details.FuelChargedouble燃油费
Result.Details.LineChargedouble基础费用
Result.Details.CarrierTransitDaysint运输天数
Result.Details.InsuredChargedouble比例：25.00，金额为-1 代表没有购买保
Result.Details.CarrierSCACstring承运商code
Result.Details.CarrierNamestring承运商名称
Result.Details.Descriptionstring报价描述
Result.Details.CarrierGuaranteestring服务名称交货的保证
Result.Details.CarrierLogostring承运商logo
Result.Details.CustomerDumpbool是否需要自卸 false 不需要自卸，true 需要自卸
Result.Details.Accessories[] (json列表)附加服务费集合
Result.Details.Accessories.ServiceCodestring服务编码，未必会有值
Result.Details.Accessories.ChargeAmountstring附加费金额
Result.Details.Accessories.ServiceNamestring附加费名称

示例

{
    "ErrorCode":"string",
    "Message":"string",
    "Result":
    {
        "ReferenceNumber":"string",
        "Message":"string",
        "Number:"string",
        "Code":"string",
        "Details":
        [{
            "ReferenceNumber":"string",
            "UserShipContractInfoId":1,
            "Id":1,
            "RateId":"string",
            "TotalCharge":11,
            "AccessorialCharge":11,
            "FuelCharge":1,
            "LineCharge":1,
            "CarrierTransitDays":1,
            "InsuredCharge":0,
            "CarrierSCAC":"string",
            "CarrierName":"string",
            "Description":"string",
            "CarrierGuarantee":"string",
            "CarrierLogo":"http://api.fastransp.com/images/carriers/carrier.png",
            "CustomerDump":false,
            "Accessories":
            {
                "ServiceCode":"string",
                "ChargeAmount":"10",
                "ServiceName":"string"
            }
        }]
    }
}

在线报价LTL（零担）

请求在线零担报价。该接口不会立即返回报价信息，调用该接口后须调用 【获取LTL报价】接口来获取报价

POST /shipordersvc/rateltl

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

Body 参数

收件人邮编S
参数名 类型 必填 描述
Numberstring可选订单号码
Typeint必须订单类型。0-线下询价订单，1-线上询价订单
ShipperPostalCodestring必须发件人邮编
ShipperCountrystring必须发件人国家
ShipperStatestring必须发件人州
ShipperCitystring必须发件人城市
ShipperAddress1string可选发件人地址1
ShipperAddress2string可选发件人地址2
ShipperNameOrCodestring可选发件联系人
ShipperCompanystring可选发件地址名称
ShipperPhonestring可选发件人电话 (最长12位数字)
ShipperEmailstring可选发件人电子邮箱
ShipperAddressTypestring必须发件地址类型 ("BUSINESS WITH DOCK","BUSINESS WITHOUT DOCK","RESIDENTIAL" 三选一)
ShipperSvcstring可选发货地址特殊要求 ("Inside","LiftGate" 可多选)
UserShipContractInfoIdint可选用户卡车合约编号。当批量询价时可以不传，则会把当前用户所有可用的合约都询价。
TargetNamestring可选收件人名称
TargetPhonestring可选收件人电话号码
TargetCompanystring可选收件地址名称
TargetCountrystring必须收件人国家
TargetStatestring必须收件人州
TargetCitystring必须收件人城市
TargetPostalCodestring必须
TargetAddress1string可选收件人地址1
TargetAddress2string可选收件人地址2
TargetEmailstring可选收件人电子邮箱
TargetAddressTypestring必须收件地址类型 ("BUSINESS WITH DOCK","BUSINESS WITHOUT DOCK","RESIDENTIAL" 三选一)
TargetSvcstring可选收货地址特殊要求 ("Inside","LiftGate","APPT","GTD","ROC","WGD","WWA" 可多选)
Unitstring必须单位:磅-英尺/千克-厘米 (Lbs-Inch或Kgs-Cm 二选一)
Descriptionstring可选订单描述
CustomOrderstring可选客户订单号
Commentsstring可选订单备注
ShipDatestring必须发货日期
IdealCoststring可选心理价格
IdealTimestring可选心理运输天数
TL_LTLbool必须false, 整车；true, 零担
Packages[] (json列表)必须包裹列表，至少须要一个
Packages.Seqint可选序列号
Packages.Namestring必须货物名称
Packages.Valuedouble必须货物价值
Packages.Aclassstring可选货物等级
Packages.SizeXdouble必须长
Packages.SizeYdouble必须宽
Packages.SizeZdouble必须高
Packages.Weightdouble必须总重
Packages.Qtyint必须数量
Packages.PalletQtyint必须打托数量
Packages.PackageTypeIdstring必须货物包装类型编号 // 1 BAG, 2 BOXES, 3 CARTONS, 4 CASE, 5 DRUMS, 6 KEGS, 7 REELS, 8 ROLLS, 9 TOTE, 10 TUBES, 11 PALLETS, 12 PIECES, 13 CYLINDERS, 14 CRATE
Packages.UnitTypeIdstring必须打托类型编号 // 3 PALLETS, 8 CRATE
Packages.IsHazmatbool可选是否危险品 ：0 非危险品 1 危险品，
Packages.UnNumberstring可选危险品编码 ，如果isHazmat 传 1 ，该字段必传
Packages.BClassstring可选危险品等级，如果isHazmat 传 1 ，该字段必传
Packages.Poisonbool可选是否有毒 ：0 无毒 1 有毒， 如果isHazmat 传 1 ，该字段必传
Packages.HazmatContactNamestring可选危险品联系人，如果isHazmat 传 1，该字段必传
Packages.HazmatPhonestring可选危险品联系手机号，如果isHazmat 传 1，该字段必传
Packages.NmfcNumberint可选NMFC编号
Packages.NmfcSubint可选nmfcSub

示例

{
    "ShipDate":"2026-01-10",
    "Type":1,
    "TL_LTL":true,
    "ShipperCountry":"string",
    "ShipperState":"string",
    "ShipperCity":"string",
    "ShipperPostalCode":"string",
    "ShipperNameOrCode":"string",
    "ShipperCompany":"string",
    "ShipperPhone":"string",
    "ShipperAddressType":"string",
    "ShipperSvc":"Inside,LiftGate",
    "UserShipContractInfoId":1,
    "TargetName":"string",
    "TargetPhone":"string",
    "TargetCompany":"string",
    "TargetCountry":"string",
    "TargetState":"string",
    "TargetCity":"string",
    "TargetPostalCode":"string",
    "TargetAddress1":"string",
    "TargetAddressType":"BUSINESS WITH DOCK",
    "TargetSvc":"Inside,LiftGate",
    "Unit":"Lbs-Inch",
    "Description":"string",
    "CustomOrder":"string",
    "Packages":
    [{
        "Name":"string",
        "Value":111,
        "Aclass":"100",
        "SizeX":1,
        "SizeY":1,
        "SizeZ":1,
        "Weight":10,
        "Qty":1,
        "PalletQty":1,
        "PackageTypeId":"2",
        "UnitTypeId":"3"
    }]
}

返回响应

险
参数名 类型 描述
ErrorCodestring错误代码
MessagestringMessage
Resultjson估算结果
Result.ReferenceNumberstring询价订单id
Result.MessagestringMessage
Result.Numberstring平台订单台
Result.Codestring错误代码
Result.Details[] (json列表)报价明细
Result.Details.ReferenceNumberstring询价订单号
Result.Details.UserShipContractInfoIdstring用户卡车合约编号
Result.Details.Idint报价记录编号
Result.Details.RateIdstring报价流水号
Result.Details.TotalChargedouble总价
Result.Details.AccessorialChargedouble额外附加费
Result.Details.FuelChargedouble燃油费
Result.Details.LineChargedouble基础费用
Result.Details.CarrierTransitDaysint运输天数
Result.Details.InsuredChargedouble比例：25.00，金额为-1 代表没有购买保
Result.Details.CarrierSCACstring承运商code
Result.Details.CarrierNamestring承运商名称
Result.Details.Descriptionstring报价描述
Result.Details.CarrierGuaranteestring服务名称交货的保证
Result.Details.CarrierLogostring承运商logo
Result.Details.CustomerDumpbool是否需要自卸 false 不需要自卸，true 需要自卸
Result.Details.Accessories[] (json列表)附加服务费集合
Result.Details.Accessories.ServiceCodestring服务编码，未必会有值
Result.Details.Accessories.ChargeAmountstring附加费金额
Result.Details.Accessories.ServiceNamestring附加费名称

示例

{
    "ErrorCode":"string",
    "Message":"string",
    "Result":
    {
        "ReferenceNumber":"string",
        "Message":"string",
        "Number:"string",
        "Code":"string",
        "Details":
        [{
            "ReferenceNumber":"string",
            "UserShipContractInfoId":1,
            "Id":1,
            "RateId":"string",
            "TotalCharge":11,
            "AccessorialCharge":11,
            "FuelCharge":1,
            "LineCharge":1,
            "CarrierTransitDays":1,
            "InsuredCharge":0,
            "CarrierSCAC":"string",
            "CarrierName":"string",
            "Description":"string",
            "CarrierGuarantee":"string",
            "CarrierLogo":"http://api.fastransp.com/images/carriers/carrier.png",
            "CustomerDump":false,
            "Accessories":
            {
                "ServiceCode":"string",
                "ChargeAmount":"10",
                "ServiceName":"string"
            }
        }]
    }
}

获取在线报价LTL（零担）结果

获取报价（LTL）异步处理，建议获取报价结果4秒调用一次，调用3次左右会拿到所有结果。注意报价2小时内有效，同一个报价不能重复下单。

POST /shipordersvc/getltlrates

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

Body参数

参数名类型必填描述
Numberstring必须订单号码
ReferenceNumberstring必须Reference Number
UserShipContractInfoIdint可选用户卡车合约编号。当批量获取报价时可以不传值。

示例


                                {
    "Number":"string",
    "ReferenceNumber":"string",
    "UserShipContractInfoId":1
}

返回响应

险
参数名 类型 描述
ErrorCodestring错误代码
MessagestringMessage
Resultjson估算结果
Result.ReferenceNumberstring询价订单id
Result.MessagestringMessage
Result.Numberstring平台订单台
Result.Codestring错误代码
Result.Details[] (json列表)报价明细
Result.Details.ReferenceNumberstring询价订单号
Result.Details.UserShipContractInfoIdstring用户卡车合约编号
Result.Details.Idint报价记录编号
Result.Details.RateIdstring报价流水号
Result.Details.TotalChargedouble总价
Result.Details.AccessorialChargedouble额外附加费
Result.Details.FuelChargedouble燃油费
Result.Details.LineChargedouble基础费用
Result.Details.CarrierTransitDaysint运输天数
Result.Details.InsuredChargedouble比例：25.00，金额为-1 代表没有购买保
Result.Details.CarrierSCACstring承运商code
Result.Details.CarrierNamestring承运商名称
Result.Details.Descriptionstring报价描述
Result.Details.CarrierGuaranteestring服务名称交货的保证
Result.Details.CarrierLogostring承运商logo
Result.Details.CustomerDumpbool是否需要自卸 false 不需要自卸，true 需要自卸
Result.Details.Accessories[] (json列表)附加服务费集合
Result.Details.Accessories.ServiceCodestring服务编码，未必会有值
Result.Details.Accessories.ChargeAmountstring附加费金额
Result.Details.Accessories.ServiceNamestring附加费名称

示例

{
    "ErrorCode":"string",
    "Message":"string",
    "Result":
    {
        "ReferenceNumber":"string",
        "Message":"string",
        "Number:"string",
        "Code":"string",
        "Details":
        [{
            "ReferenceNumber":"string",
            "UserShipContractInfoId":1,
            "Id":1,
            "RateId":"string",
            "TotalCharge":11,
            "AccessorialCharge":11,
            "FuelCharge":1,
            "LineCharge":1,
            "CarrierTransitDays":1,
            "InsuredCharge":0,
            "CarrierSCAC":"string",
            "CarrierName":"string",
            "Description":"string",
            "CarrierGuarantee":"string",
            "CarrierLogo":"http://api.fastransp.com/images/carriers/carrier.png",
            "CustomerDump":false,
            "Accessories":
            {
                "ServiceCode":"string",
                "ChargeAmount":"10",
                "ServiceName":"string"
            }
        }]
    }
}

提交订单

提交卡车订单。

POST /shipordersvc/create

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

Body 参数

收件人邮编S
参数名 类型 必填 描述
Numberstring可选订单号码
Typeint必须订单类型。0-线下询价订单，1-线上询价订单
ShipperPostalCodestring必须发件人邮编
ShipperCountrystring必须发件人国家
ShipperStatestring必须发件人州
ShipperCitystring必须发件人城市
ShipperAddress1string可选发件人地址1
ShipperAddress2string可选发件人地址2
ShipperNameOrCodestring可选发件联系人
ShipperCompanystring可选发件地址名称
ShipperPhonestring可选发件人电话 (最长12位数字)
ShipperEmailstring可选发件人电子邮箱
ShipperAddressTypestring必须发件地址类型 ("BUSINESS WITH DOCK","BUSINESS WITHOUT DOCK","RESIDENTIAL" 三选一)
ShipperSvcstring可选发货地址特殊要求 ("Inside","LiftGate" 可多选)
UserShipContractInfoIdint可选用户卡车合约编号。当批量询价时可以不传，则会把当前用户所有可用的合约都询价。
TargetNamestring可选收件人名称
TargetPhonestring可选收件人电话号码
TargetCompanystring可选收件地址名称
TargetCountrystring必须收件人国家
TargetStatestring必须收件人州
TargetCitystring必须收件人城市
TargetPostalCodestring必须
TargetAddress1string可选收件人地址1
TargetAddress2string可选收件人地址2
TargetEmailstring可选收件人电子邮箱
TargetAddressTypestring必须收件地址类型 ("BUSINESS WITH DOCK","BUSINESS WITHOUT DOCK","RESIDENTIAL" 三选一)
TargetSvcstring可选收货地址特殊要求 ("Inside","LiftGate","APPT","GTD","ROC","WGD","WWA" 可多选)
Unitstring必须单位:磅-英尺/千克-厘米 (Lbs-Inch或Kgs-Cm 二选一)
Descriptionstring可选订单描述
CustomOrderstring可选客户订单号
Commentsstring可选订单备注
ShipDatestring必须发货日期
IdealCoststring可选心理价格
IdealTimestring可选心理运输天数
TL_LTLbool必须false, 整车；true, 零担
Packages[] (json列表)必须包裹列表，至少须要一个
Packages.Seqint可选序列号
Packages.Namestring必须货物名称
Packages.Valuedouble必须货物价值
Packages.Aclassstring可选货物等级
Packages.SizeXdouble必须长
Packages.SizeYdouble必须宽
Packages.SizeZdouble必须高
Packages.Weightdouble必须总重
Packages.Qtyint必须数量
Packages.PalletQtyint必须打托数量
Packages.PackageTypeIdstring必须货物包装类型编号 // 1 BAG, 2 BOXES, 3 CARTONS, 4 CASE, 5 DRUMS, 6 KEGS, 7 REELS, 8 ROLLS, 9 TOTE, 10 TUBES, 11 PALLETS, 12 PIECES, 13 CYLINDERS, 14 CRATE
Packages.UnitTypeIdstring必须打托类型编号 // 3 PALLETS, 8 CRATE
Packages.IsHazmatbool可选是否危险品 ：0 非危险品 1 危险品，
Packages.UnNumberstring可选危险品编码 ，如果isHazmat 传 1 ，该字段必传
Packages.BClassstring可选危险品等级，如果isHazmat 传 1 ，该字段必传
Packages.Poisonbool可选是否有毒 ：0 无毒 1 有毒， 如果isHazmat 传 1 ，该字段必传
Packages.HazmatContactNamestring可选危险品联系人，如果isHazmat 传 1，该字段必传
Packages.HazmatPhonestring可选危险品联系手机号，如果isHazmat 传 1，该字段必传
Packages.NmfcNumberint可选NMFC编号
Packages.NmfcSubint可选nmfcSub

示例

{
    "ShipDate":"2026-01-10",
    "Type":1,
    "TL_LTL":true,
    "ShipperCountry":"string",
    "ShipperState":"string",
    "ShipperCity":"string",
    "ShipperPostalCode":"string",
    "ShipperNameOrCode":"string",
    "ShipperCompany":"string",
    "ShipperPhone":"string",
    "ShipperAddressType":"string",
    "ShipperSvc":"Inside,LiftGate",
    "UserShipContractInfoId":1,
    "TargetName":"string",
    "TargetPhone":"string",
    "TargetCompany":"string",
    "TargetCountry":"string",
    "TargetState":"string",
    "TargetCity":"string",
    "TargetPostalCode":"string",
    "TargetAddress1":"string",
    "TargetAddressType":"BUSINESS WITH DOCK",
    "TargetSvc":"Inside,LiftGate",
    "Unit":"Lbs-Inch",
    "Description":"string",
    "CustomOrder":"string",
    "Packages":
    [{
        "Name":"string",
        "Value":111,
        "Aclass":"100",
        "SizeX":1,
        "SizeY":1,
        "SizeZ":1,
        "Weight":10,
        "Qty":1,
        "PalletQty":1,
        "PackageTypeId":"2",
        "UnitTypeId":"3"
    }]
}

返回响应

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

示例

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

取消订单

取消订单。

POST /shipordersvc/cancel/{OrderNumber}

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

路径参数

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

示例

/shipordersvc/cancel/ordernumber1234

返回响应

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

示例

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

查询订单

获取订单详情。

GET /shipordersvc/{OrderNumber}

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

路径参数

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

示例

/shipordersvc/ordernumber1234

返回响应

收件人邮编S险
参数名 类型 描述
ErrorCodestring错误代码
MessagestringMessage
Resultstring结果
Result.Numberstring可选订单号码
Result.Typeint必须订单类型。0-线下询价订单，1-线上询价订单
Result.ShipperPostalCodestring必须发件人邮编
Result.ShipperCountrystring必须发件人国家
Result.ShipperStatestring必须发件人州
Result.ShipperCitystring必须发件人城市
Result.ShipperAddress1string可选发件人地址1
Result.ShipperAddress2string可选发件人地址2
Result.ShipperNameOrCodestring可选发件联系人
Result.ShipperCompanystring可选发件地址名称
Result.ShipperPhonestring可选发件人电话 (最长12位数字)
Result.ShipperEmailstring可选发件人电子邮箱
Result.ShipperAddressTypestring必须发件地址类型 ("BUSINESS WITH DOCK","BUSINESS WITHOUT DOCK","RESIDENTIAL" 三选一)
Result.ShipperSvcstring可选发货地址特殊要求 ("Inside","LiftGate" 可多选)
Result.UserShipContractInfoIdint可选用户卡车合约编号。当批量询价时可以不传，则会把当前用户所有可用的合约都询价。
Result.TargetNamestring可选收件人名称
Result.TargetPhonestring可选收件人电话号码
Result.TargetCompanystring可选收件地址名称
Result.TargetCountrystring必须收件人国家
Result.TargetStatestring必须收件人州
Result.TargetCitystring必须收件人城市
Result.TargetPostalCodestring必须
Result.TargetAddress1string可选收件人地址1
Result.TargetAddress2string可选收件人地址2
Result.TargetEmailstring可选收件人电子邮箱
Result.TargetAddressTypestring必须收件地址类型 ("BUSINESS WITH DOCK","BUSINESS WITHOUT DOCK","RESIDENTIAL" 三选一)
Result.TargetSvcstring可选收货地址特殊要求 ("Inside","LiftGate","APPT","GTD","ROC","WGD","WWA" 可多选)
Result.Unitstring必须单位:磅-英尺/千克-厘米 (Lbs-Inch或Kgs-Cm 二选一)
Result.Descriptionstring可选订单描述
Result.CustomOrderstring可选客户订单号
Result.Commentsstring可选订单备注
Result.ShipDatestring必须发货日期
Result.IdealCoststring可选心理价格
Result.IdealTimestring可选心理运输天数
Result.TL_LTLbool必须false, 整车；true, 零担
Result.Packages[] (json列表)必须包裹列表，至少须要一个
Result.Packages.Seqint可选序列号
Result.Packages.Namestring必须货物名称
Result.Packages.Valuedouble必须货物价值
Result.Packages.Aclassstring可选货物等级
Result.Packages.SizeXdouble必须长
Result.Packages.SizeYdouble必须宽
Result.Packages.SizeZdouble必须高
Result.Packages.Weightdouble必须总重
Result.Packages.Qtyint必须数量
Result.Packages.PalletQtyint必须打托数量
Result.Packages.PackageTypeIdstring必须货物包装类型编号 // 1 BAG, 2 BOXES, 3 CARTONS, 4 CASE, 5 DRUMS, 6 KEGS, 7 REELS, 8 ROLLS, 9 TOTE, 10 TUBES, 11 PALLETS, 12 PIECES, 13 CYLINDERS, 14 CRATE
Result.Packages.UnitTypeIdstring必须打托类型编号 // 3 PALLETS, 8 CRATE
Result.Packages.IsHazmatbool可选是否危险品 ：0 非危险品 1 危险品，
Result.Packages.UnNumberstring可选危险品编码 ，如果isHazmat 传 1 ，该字段必传
Result.Packages.BClassstring可选危险品等级，如果isHazmat 传 1 ，该字段必传
Result.Packages.Poisonbool可选是否有毒 ：0 无毒 1 有毒， 如果isHazmat 传 1 ，该字段必传
Result.Packages.HazmatContactNamestring可选危险品联系人，如果isHazmat 传 1，该字段必传
Result.Packages.HazmatPhonestring可选危险品联系手机号，如果isHazmat 传 1，该字段必传
Result.Packages.NmfcNumberint可选NMFC编号
Result.Packages.NmfcSubint可选nmfcSub
Result.Files[] (json列表)附件，BOL,POD等
Result.Files.Idint编号
Result.Files.ShipOrderInfoIdint订单编号
Result.Files.UploadFileInfoIdint文件编号
Result.Files.UploadFilejson文件
Result.Files.UploadFile.Idint编号
Result.Files.UploadFile.Namestring名称
Result.Files.UploadFile.Urlstring链接
Result.Files.UploadFile.Typestring>类型。bol,pod
Result.RateInfojson报价信息
Result.RateInfo.Idint报价记录编号
Result.RateInfo.TotalChargedouble总价
Result.RateInfo.AccessorialChargedouble额外附加费
Result.RateInfo.FuelChargedouble燃油费
Result.RateInfo.LineChargedouble基础费用
Result.RateInfo.CarrierTransitDaysint运输天数
Result.RateInfo.InsuredChargedouble比例：25.00，金额为-1 代表没有购买保
Result.RateInfo.CarrierSCACstring承运商code
Result.RateInfo.CarrierNamestring承运商名称
Result.RateInfo.Descriptionstring报价描述
Result.RateInfo.CarrierGuaranteestring服务名称交货的保证
Result.RateInfo.CarrierLogostring承运商logo
Result.RateInfo.CustomerDumpbool是否需要自卸 false 不需要自卸，true 需要自卸
Result.RateInfo.Accessories[] (json列表)附加服务费集合
Result.RateInfo.Accessories.ServiceCodestring服务编码，未必会有值
Result.RateInfo.Accessories.ChargeAmountstring附加费金额
Result.RateInfo.Accessories.ServiceNamestring附加费名称

示例

{
    "ErrorCode":"string",
    "Message":"string",
    "Result":
    {
        "Number":"string",
        "DeliverTime":1,
        "PickupTime1":"string",
        "PickupTime2":"string",
        "DeliverTime1":"string",
        "DeliverTime2":"string",
        "TrackNumber":"string",
        "AuditRemark":"string",
        "ProNumber":"string",
        "PickupNumber":"string",
        "DeliveryNumber":"string",
        "ShipComment":"string",
        "DeliverComment":"string",
        "ShipperNameOrCode":"string",
        "ShipperCompany":"string",
        "ShipperPhone":"string",
        "ShipperEmail":"string",
        "ShipperAddressType":"BUSINESS WITH DOCK",
        "ShipperSvc":"Inside",
        "UserShipContractInfoId":1,
        "State":10,
        "TargetName":"string",
        "TargetPhone":"string",
        "TargetCompany":"string",
        "TargetCountry":"string",
        "TargetState":"string",
        "TargetCity":"string",
        "TargetPostalCode":"string",
        "TargetAddress1":"string",
        "TargetAddress2":"string",
        "TargetAddressType":"BUSINESS WITH DOCK",
        "TargetSvc":"Inside,LiftGate",
        "Unit":"Lbs-Inch",
        "Description":"string",
        "CustomOrder":"string",
        "Comments":"string",
        "ShipDate":"string",
        "IdealCost":0,
        "IdealTime":0,
        "TL_LTL":true,
        "Packages":
        [{
            "Seq":1,
            "Name":"string",
            "Value":111,
            "Aclass":100,
            "SizeX":1,
            "SizeY":1,
            "SizeZ":1,
            "Weight":11,
            "Qty":1,
            "PalletQty":1,
            "PackageTypeId":"2",
            "UnitTypeId":"3",
            "IsHazmat":0,
            "UnNumber":0,
            "BClass":0,
            "Poison":0,
            "HazmatContactName":"string",
            "HazmatPhone":"string",
            "NmfcNumber":1,
            "NmfcSub":1,
        }],
        "Files":
        [{
            "Id":1,
            "ShipOrderInfoId":1,
            "UploadFileInfoId":1,
            "UploadFile":
            {
                "Id":1,
                "Name":"string",
                "Url":"string",
                "Type""string",
            }
        }],
        "RateInfo":
        {
            "Id":1,
            "TotalCharge":111,
            "AccessorialCharge":1,
            "FuelCharge":1,
            "LineCharge":1,
            "CarrierTransitDays":1,
            "InsuredCharge":0,
            "CarrierSCAC":"string",
            "CarrierName":"string",
            "Description":"string",
            "CarrierGuarantee":"string",
            "CustomerDump":false,
            "Accessories":
            [{
                "ServiceCode":"string",
                "ChargeAmount":"11",
                "ServiceName":"string",
            }]
        }
    }
}

地址验证

验证输入的地址并返回地址类型。

POST /shipordersvc/validateaddress

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

Body 参数

参数名类型必填描述
address1string必须地址1
address2string可选地址2
citystring必须城市
provincestring必须州/省 (最长12位数字)
countrystring必须国家
postalCodestring必须邮编
namestring可选地址名称
contractstring必须合约名称。值可以从接口“获取用户合约”返回的合约详情的合约字段获取

示例

{

    "address1"":"string",
    "address2"":"string",
    "city"":"string",
    "province"":"CA",
    "country"":"US",
    "postalCode"":"string",
    "name"":"string",
    "contract"":"string"
}

返回响应

参数名 类型 描述
ErrorCodestring错误代码
MessagestringMessage
Resultstring结果
Result.address1string地址1
Result.address2string地址2
Result.citystring城市
Result.provincestring州/省 (最长12位数字)
Result.countrystring国家
Result.postalCodestring邮编
Result.statusstring地址类型 Business,Residential,Unknown
Result.originstring地址名称
Result.origin.address1string地址1
Result.origin.address2string地址2
Result.origin.citystring城市
Result.origin.provincestring州/省 (最长12位数字)
Result.origin.countrystring国家
Result.origin.postalCodestring邮编
Result.origin.namestring地址名称

示例

{
    "errorCode":"string",
    "message":"string",
    "result":
    {
        "address1":"string",
        "address2":"string",
        "city":"string",
        "province":"CA",
        "country":"US",
        "postalCode":"string",
        "name":"string",
        "status":"string",
        "origin":
        {
            "address1":"string",
            "address2":"string",
            "city":"string",
            "province":"CA",
            "country":"US",
            "postalCode":"string",
            "name":"string"
    }
}

查询保险配置

查询平台支持的保险配置。

GET /shipordersvc/getInsuranceConfig

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

路径参数

参数名类型必填描述
UserShipContractInfoIdint是用户卡车合约编号

示例

/shipordersvc/getInsuranceConfig/1234

返回响应

参数名 类型 描述
ErrorCodestring错误代码
MessagestringMessage
Resultstring结果
Result.ChannelNamestring保险渠道名称
Result.ChannelCodestring保险渠道代码
Result.InsuranceRatiodecimal保险费率
Result.SubsidyAmountdecimal补贴金额，当保额小于该金额时不收取保费。
Result.InsuredAmountdecimal最低保险费

示例

{
    "ErrorCode":"string",
    "Message":"string",
    "Result":
    {
        "ChannelName":"string",
        "ChannelCode":"string",
        "InsuranceRatio":0.003,
        "SubsidyAmount":5000,
        "InsuredAmount":0
    }
}

查询订单轨迹

查询平台卡车订单的轨迹。

GET /shipordersvc/tracking

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

路径参数

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

示例

/shipordersvc/tracking/1234

返回响应

参数名 类型 描述
ErrorCodestring错误代码
MessagestringMessage
Resultstring结果
Result.Timestring时间
Result.Locationstring地点
Result.Eventstring事件
Result.Descriptionstring描述

示例

{
    "ErrorCode":"string",
    "Message":"string",
    "Result":
    [{
        "Time":"string",
        "Location":"string",
        "Event":"string",
        "Description":"string"
    }]
}

查询货物class

查询物货的class。

POST /shipordersvc/getclass

Header 参数

Authorizationstring必须
Content-Typestring可选

示例

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

Body 参数

参数名类型必填描述
SizeXdouble必须长
SizeYdouble必须宽
SizeZdouble必须高
Weightdouble必须总重
PalletQtyint必须打托数量
CalcUnitint必须计算类型。0：（in/lb），1： (cm/kg)

示例

{
    "SizeX":1,
    "SizeY":1,
    "SizeZ":1,
    "Weight":1,
    "PalletQty":1,
    "CalcUnit":0
}

返回响应

参数名 类型 描述
Resultdecimal结果
ErrorCodestring错误代码
MessagestringMessage

示例

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

准备好开始了吗？

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

前往快递系统