本土运单API接口
一、基本信息
1.通信方式:
HTTP的POST方法
2.数据格式
响应数据采用JSON
3.请求参数
Head ContentType : application/x-www-form-urlencoded
Key（必填参数）
请求key(32位)，公司提供给合作网站的识别字符串，用于识别和鉴定请求来源，避免未授权的非法访问
其它参数
按实际需要填写，见下面接口说明
4.BaseURl
https://
5.响应数据
Code
结果状态码
200 - 成功返回
600 – 服务器异常
603 – 参数错误
Message
描述返回错误信息
二、API说明
1.获取余额
BaseURL + /Api/UserInfo.ashx
请求参数：
|
POST参数名 |
是否必填 |
说明 |
|
Key |
是 |
快递公司发放的key |
返回对象 Response
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
Data |
用户信息 |
示例
postman示例：
请求参数：
Key = 88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": null,
"Data": {
"Balance": 888.88
}
}
2.获取快递和快递服务
BaseURL + /Api/Express/GetCarrierList.ashx 点击这里链接在线查看
请求参数：
|
POST参数名 |
是否必填 |
说明 |
|
Key |
是 |
快递公司发放的key |
返回对象 Response
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
Data |
快递对象列表 |
示例
postman示例：
请求参数：
Key = 88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": null,
"Data": [{
"ServiceList": ["FedEx SmartPost", "FedEx Home Delivery", "FedEx Ground"],
"Name": "FedEx Test",
"IsInsure": true,
"IsMultParcel": true,
}, {
"ServiceList": ["usps_first_class_mail", "usps_media_mail", "usps_parcel_select", "usps_priority_mail", "usps_priority_mail_express", "usps_first_class_mail_international", "usps_priority_mail_international", "usps_priority_mail_express_international"],
"Name": "USPS"
"IsInsure": false,
"IsMultParcel": true,
}]
}
3.本土运单查费率
BaseURL + /Api/Express/Rates.ashx
请求参数：
|
POST参数名 |
是否必填 |
说明 |
|
Key |
是 |
快递公司发放的key |
|
Data |
是 |
Shipment Json 对象序列化后字符串 |
Shipment对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
Carrier |
是 |
String |
运营商,点击这里链接在线查看 |
|
ShipFrom |
是 |
ShipAddr |
发件人信息 |
|
ShipTo |
是 |
ShipAddr |
收件人信息 |
|
Parcels |
是 |
List<Parcels> |
包裹列表 |
|
ItemList |
是 |
List<Item> |
货物信息列表 (new) |
|
FreightClass |
否 |
String |
UPS GFP FREIGHT_CLASS 必填。其他不用填这个参数,可选值： 50、55、 60、65、70、77.5、85、92.5、100、110、125、150、175、200、250、300、400、500 |
|
Signature |
否 |
Bool |
是否需要签名，默认不签名 |
|
WeightUnitType |
否 |
int |
单位类型，0表示lb/in,1表示kg/cm,2表示oz/in,默认是0 |
ShipAddr对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
PostalCode |
是 |
String |
邮编 |
|
Name |
是 |
String |
姓名 |
|
Company |
否 |
String |
公司,最多30个字符 |
|
Address1 |
是 |
String |
地址行1,最多35个字符 |
|
Address2 |
否 |
String |
地址行2,最多35个字符 |
|
State |
是 |
String |
州,两位大写代码 |
|
City |
是 |
String |
城市 |
|
Country |
是 |
String |
2位国家代码，如US |
|
PhoneNumber |
否 |
String |
电话号码 |
|
AddrType |
否 |
Int |
0.自动判断(默认),1表示商业BUSINESS,2表示住宅RESIDENTIAL |
Parcel对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
Weight |
是 |
Decimal 2位小数 |
包裹重量 |
|
Length |
是 |
Decimal 2位小数 |
长度 |
|
Width |
是 |
Decimal 2位小数 |
宽度 |
|
Height |
是 |
Decimal 2位小数 |
高度 |
|
Insure |
否 |
Decimal 2位小数 |
保险额度，Carrier返回支持保险才可用 |
Item对象(new)
|
参数名 |
是否必填 |
类型 |
说明 |
|
Sku |
是 |
String |
Sku |
|
Quantity |
是 |
Int |
数量 |
返回对象 Response
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
Rate |
Rate Json对象 – 费率信息 |
示例
请求参数：
Data = {
"Carrier": "ups2",
"ShipFrom": {
"PostalCode": "47906",
"Name": "xiaoyang hu",
"Address1": "1138 anthrop dr",
"Address2": null,
"State": "IN",
"City": "West Lafayette",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"ShipTo": {
"PostalCode": "60609",
"Name": "Jing zhang",
"Address1": "2023 w 35th st",
"Address2": null,
"State": "IL",
"City": "Chicago",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"Parcels": [{
"Weight": 3,
"Length": 22,
"Width": 22,
"Height": 22
}],
"ItemList": [{
"Sku": "TEST123456789",
"Quantity": 3
}]
}&Key = 88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": "",
"Data": [{
"RateId": "rate_fa3adcab1d084bd290fd92149a8aeb0c",
"Carrier": "self_ups",
"CarrierServiceLevel": "Ground",
"CarrierServiceName": "Ground",
"ChargeWeight": 3,
"TotalCharge": 29.42,
"PackageType": null
}, {
"RateId": "rate_fa9cdf649a33426b9cdfd3883f5ec8af",
"Carrier": "self_ups",
"CarrierServiceLevel": "3DaySelect",
"CarrierServiceName": "3DaySelect",
"ChargeWeight": 3,
"TotalCharge": 77.59,
"PackageType": null
}, {
"RateId": "rate_8a5d4079079348668e071a1ffdfed6dd",
"Carrier": "self_ups",
"CarrierServiceLevel": "NextDayAir",
"CarrierServiceName": "NextDayAir",
"ChargeWeight": 3,
"TotalCharge": 182.84,
"PackageType": null
}]
}
4.本土运单下单
BaseURL + /Api/Express/CreateLabel.ashx
请求参数：
|
POST参数名 |
是否必填 |
说明 |
|
Key |
是 |
快递公司发放的key |
|
Data |
是 |
Shipment Json 对象序列化后的字符串 |
Shipment对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
OrderNum |
否 |
String |
订单号，大于8位，需要有权限，空则自动生成。如无权限，则无需填写 |
|
Carrier |
是 |
String |
运营商,点击这里链接在线查看 |
|
CarrierServiceLevel |
是 |
String |
运营商服务,点击这里链接在线查看 |
|
ShipFrom |
是 |
ShipAddr |
发件人信息 |
|
ShipTo |
是 |
ShipAddr |
收件人信息 |
|
Parcels |
是 |
List<Parcels> |
包裹列表 |
|
ItemList |
是 |
List<Item> |
货物信息列表 (new) |
|
FreightClass |
否 |
String |
UPS GFP FREIGHT_CLASS 必填。其他不用填这个参数 |
|
Signature |
否 |
Bool |
是否需要签名，默认不签名 |
|
LabelSize |
否 |
Int |
面单尺寸,0表示4x6 1表示A4，默认4x6 |
|
Remark1 |
否 |
String |
备注1 |
|
Remark2 |
否 |
String |
备注2 |
|
WeightUnitType |
否 |
int |
单位类型，0表示lb/in,1表示kg/cm,2表示oz/in,默认是0 |
|
EcOrder |
否 |
String |
电商订单号 |
|
AutoChangeService |
否 |
Bool |
部分FedEx渠道使用(具体渠道请咨询技术支持),可能因FedEx地址类型问题,是否自动变换FedEx Ground/FedEx Home Delivery服务下单 |
ShipAddr对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
PostalCode |
是 |
String |
邮编 |
|
Name |
是 |
String |
姓名 |
|
Company |
否 |
String |
公司,最多30个字符 |
|
Address1 |
是 |
String |
地址行1,最多35个字符 |
|
Address2 |
否 |
String |
地址行2,最多35个字符 |
|
State |
是 |
String |
州,两位大写代码 |
|
City |
是 |
String |
城市 |
|
Country |
是 |
String |
2位国家代码，如US |
|
PhoneNumber |
否 |
String |
电话号码 |
|
AddrType |
否 |
Int |
0.自动判断(默认),1表示商业BUSINESS,2表示住宅RESIDENTIAL |
Parcel对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
Weight |
是 |
Decimal 2位小数 |
包裹重量 |
|
Length |
是 |
Decimal 2位小数 |
长度 |
|
Width |
是 |
Decimal 2位小数 |
宽度 |
|
Height |
是 |
Decimal 2位小数 |
高度 |
|
Insure |
否 |
Decimal 2位小数 |
保险额度，Carrier返回支持保险才可用 |
|
Picking |
否 |
String |
拣货信息，Carrier返回支持才可用 |
Item对象(new)
|
参数名 |
是否必填 |
类型 |
说明 |
|
Sku |
是 |
String |
Sku |
|
Quantity |
是 |
Int |
数量 |
返回对象 Response
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
Shipment |
Shipment Json对象 – 订单的信息 |
示例
请求参数：
Data = {
"Carrier": "ups2",
"CarrierServiceLevel": "Ground",
"ShipFrom": {
"PostalCode": "47906",
"Name": "xiaoyang hu",
"Address1": "1138 anthrop dr",
"Address2": null,
"State": "IN",
"City": "West Lafayette",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"ShipTo": {
"PostalCode": "60609",
"Name": "Jing zhang",
"Address1": "2023 w 35th st",
"Address2": null,
"State": "IL",
"City": "Chicago",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"OrderNum": null,
"Parcels": [{
"Weight": 3,
"Length": 22,
"Width": 22,
"Height": 22
}],
"ItemList": [{
"Sku": "TEST123456789",
"Quantity": 3
}]
}&Key = 88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": null,
"Data": {
"LabelReady": true, //面单是否已经准备好,如为false 、//LabelUrl,TranckingNumbers没有数据,需要等待//10-100秒请求面单信息接口获取这几个数据
"LabelUrl": "http://localhost/UploadFiles/Self/1Z13R10R0398374459.pdf",
"ShippingWeight": 2,
"FactWeight": 2,
"ShippingPrice": 29.42,
"TrackingNumbers": ["1Z13R10R0398374459"],
"Carrier": "ups2",
"CarrierServiceLevel": "Ground",
"ShipFrom": {
"PostalCode": "47906",
"Name": "xiaoyang hu",
"Address1": "1138 anthrop dr",
"Address2": null,
"State": "IN",
"City": "West Lafayette",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"ShipTo": {
"PostalCode": "60609",
"Name": "Jing zhang",
"Address1": "2023 w 35th st",
"Address2": null,
"State": "IL",
"City": "Chicago",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"OrderNum": "KV10644787171",
"Parcels": [{
"TrackingNumber": null,
"Weight": 3,
"Length": 22,
"Width": 22,
"Height": 22
}]
}
}
5.获取面单信息
BaseURL + /Api/Express/LabelsInfo.ashx
请求参数：
|
POST参数名 |
是否必填 |
说明 |
|
Key |
是 |
快递公司发放的key |
|
Data |
是 |
Json 字符串数组 |
返回对象 Response
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
LabelInfo |
LabelInfo Json数组 – 面单的信息 |
示例
请求参数：
Data = [
"KV10645108889",
"KV10645090385",
"KV10645084825",
"KV10645076260"
]&Key = 88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": null,
"Data": [{
"LabelReady": false,
"LabelUrl": null,
"TrackingNumbers": [],
"OrderNum": "KV10645108889"
}, {
"LabelReady": true,
"LabelUrl": "http://localhost/UploadFiles/EE/794631631221.pdf",
"TrackingNumbers": ["794631631221"],
"OrderNum": "KV10645090385"
}, {
"LabelReady": true,
"LabelUrl": "http://localhost/UploadFiles/EE/794631631221.pdf",
"TrackingNumbers": ["794631631221"],
"OrderNum": "KV10645084825"
}, {
"LabelReady": true,
"LabelUrl": "http://localhost/UploadFiles/EE/794631631221.pdf",
"TrackingNumbers": ["794631631221"],
"OrderNum": "KV10645076260"
}]
}
6.面单退款
BaseURL + /Api/Express/LabelsCancel.ashx
请求参数：
|
POST参数名 |
是否必填 |
说明 |
|
Key |
是 |
快递公司发放的key |
|
OrderNum |
是 |
订单号 |
返回对象 Response
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
示例
请求参数：
OrderNum=KV10645076260&Key = 88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": null
}
7. 地址校验并返回地址类型
BaseURL + /Api/Express/AddressCheck.ashx
注意：不同快递对同一个地址的地址类型判断可能会不同，故该接口返回的地址类型不一定是正常的，但是98%以上是准确的,如果快递创建运单提示地址类型不对，最好可以手工选择地址类型
请求参数：
|
POST参数名 |
是否必填 |
说明 |
|
Key |
是 |
快递公司发放的key |
|
Data |
是 |
ShipAddr Json对象 – 地址信息 |
ShipAddr对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
PostalCode |
是 |
String |
邮编 |
|
Name |
是 |
String |
姓名 |
|
Company |
否 |
String |
公司,最多30个字符 |
|
Address1 |
是 |
String |
地址行1,最多35个字符 |
|
Address2 |
是 |
String |
地址行2,最多35个字符 |
|
State |
是 |
String |
州,两位大写代码 |
|
City |
是 |
String |
城市 |
|
Country |
否 |
String |
2位国家代码，如US |
|
PhoneNumber |
否 |
String |
电话号码 |
|
AddrType |
否 |
Int |
1表示商业BUSINESS,2表示住宅RESIDENTIAL 此接口不需要填写AddrType，正确的地址，返回结果会自动带这项 |
返回对象 Response
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
Data |
ShipAddr Json对象 – 地址信息 |
示例
请求参数：
Data = {
"PostalCode": "91710",
"Name": "Kevin Chen",
"Address1": "14592111 Central Av",
"Address2": null,
"State": "CA",
"City": "Chino",
"Country": null,
"CountryCode": null,
"PhoneNumber": "1234567890",
"AddrType":0
} &Key = 88888888888888888888888888888888
正确返回值：
{
"Code": "200",
"Message": null,
"Data": {
"PostalCode": "91710",
"Name": "Kevin Chen",
"Address1": "14592 Central Av",
"Address2": null,
"State": "CA",
"City": "Chino",
"Country": "US",
"CountryCode": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
}
}
错误返回值：
{
"Code": "603",
"Message": "[address]Address not found",
"Data": {
"PostalCode": "91710",
"Name": "Kevin Chen",
"Address1": "14592111 Central Av",
"Address2": null,
"State": "CA",
"City": "Chino",
"Country": "US",
"CountryCode": "US",
"PhoneNumber": "1234567890",
"AddrType": 0
}
}
8.获取电商店铺列表
BaseURL + /Api/Ecommerce/GetEcChannelList
请求参数：
|
参数 |
类型 |
说明 |
|
Key |
String |
用于校验认证 |
返回参数
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
Data |
电商店铺EcChannel列表 |
EcChannel对象
|
参数 |
类型 |
说明 |
|
ChannelId |
Int |
id |
|
ChannelName |
String |
店铺名称 |
请求参数：
Key=88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": null,
"Data": [
{
"ChannelName": "wo11-amazon",
"ChannelId": 123
}
]
}
9.创建电商订单发货单
BaseURL + /Api/Ecommerce/CreateEcLabels
请求参数：
|
POST参数名 |
是否必填 |
说明 |
|
Key |
是 |
快递公司发放的key |
|
Data |
是 |
Shipment Json 对象序列化后的字符串 |
Shipment对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
OrderNum |
否 |
String |
订单号，大于8位，需要有权限，空则自动生成。如无权限，则无需填写 |
|
Carrier |
是 |
String |
运营商,点击这里链接在线查看 |
|
CarrierServiceLevel |
是 |
String |
运营商服务,点击这里链接在线查看 |
|
ShipFrom |
是 |
ShipAddr |
发件人信息 |
|
ShipTo |
是 |
ShipAddr |
收件人信息 |
|
Parcels |
是 |
List<Parcels> |
包裹列表 |
|
ItemList |
是 |
List<Item> |
货物信息列表 (new) |
|
FreightClass |
否 |
String |
UPS GFP FREIGHT_CLASS 必填。其他不用填这个参数 |
|
Signature |
否 |
Bool |
是否需要签名，默认不签名 |
|
LabelSize |
否 |
Int |
面单尺寸,0表示4x6 1表示A4，默认4x6 |
|
Remark1 |
否 |
String |
备注1 |
|
Remark2 |
否 |
String |
备注2 |
|
WeightUnitType |
否 |
int |
单位类型，0表示lb/in,1表示kg/cm,2表示oz/in,默认是0 |
|
EcOrderId |
是 |
Int |
电商订单Id |
|
AutoChangeService |
否 |
Bool |
部分FedEx渠道使用(具体渠道请咨询技术支持),可能因FedEx地址类型问题,是否自动变换FedEx Ground/FedEx Home Delivery服务下单 |
ShipAddr对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
PostalCode |
是 |
String |
邮编 |
|
Name |
是 |
String |
姓名 |
|
Company |
否 |
String |
公司,最多30个字符 |
|
Address1 |
是 |
String |
地址行1,最多35个字符 |
|
Address2 |
否 |
String |
地址行2,最多35个字符 |
|
State |
是 |
String |
州,两位大写代码 |
|
City |
是 |
String |
城市 |
|
Country |
是 |
String |
2位国家代码，如US |
|
PhoneNumber |
否 |
String |
电话号码 |
|
AddrType |
否 |
Int |
0.自动判断(默认),1表示商业BUSINESS,2表示住宅RESIDENTIAL |
Parcel对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
Weight |
是 |
Decimal 2位小数 |
包裹重量 |
|
Length |
是 |
Decimal 2位小数 |
长度 |
|
Width |
是 |
Decimal 2位小数 |
宽度 |
|
Height |
是 |
Decimal 2位小数 |
高度 |
|
Insure |
否 |
Decimal 2位小数 |
保险额度，Carrier返回支持保险才可用 |
|
Picking |
否 |
String |
拣货信息，Carrier返回支持才可用 |
Item对象(new)
|
参数名 |
是否必填 |
类型 |
说明 |
|
Sku |
是 |
String |
Sku |
|
Quantity |
是 |
Int |
数量 |
返回对象 Response
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
Shipment |
Shipment Json对象 – 订单的信息 |
示例
请求参数：
Data = {
"EcOrderId": 123,
"Carrier": "ups2",
"CarrierServiceLevel": "Ground",
"ShipFrom": {
"PostalCode": "47906",
"Name": "xiaoyang hu",
"Address1": "1138 anthrop dr",
"Address2": null,
"State": "IN",
"City": "West Lafayette",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"ShipTo": {
"PostalCode": "60609",
"Name": "Jing zhang",
"Address1": "2023 w 35th st",
"Address2": null,
"State": "IL",
"City": "Chicago",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"OrderNum": null,
"Parcels": [{
"Weight": 3,
"Length": 22,
"Width": 22,
"Height": 22
}],
"ItemList": [{
"Sku": "TEST123456789",
"Quantity": 3
}]
}&Key = 88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": null,
"Data": {
"LabelReady": true, //面单是否已经准备好,如为false 、//LabelUrl,TranckingNumbers没有数据,需要等待//10-100秒请求面单信息接口获取这几个数据
"LabelUrl": "http://localhost/UploadFiles/Self/1Z13R10R0398374459.pdf",
"ShippingWeight": 2,
"FactWeight": 2,
"ShippingPrice": 29.42,
"TrackingNumbers": ["1Z13R10R0398374459"],
"Carrier": "ups2",
"CarrierServiceLevel": "Ground",
"ShipFrom": {
"PostalCode": "47906",
"Name": "xiaoyang hu",
"Address1": "1138 anthrop dr",
"Address2": null,
"State": "IN",
"City": "West Lafayette",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"ShipTo": {
"PostalCode": "60609",
"Name": "Jing zhang",
"Address1": "2023 w 35th st",
"Address2": null,
"State": "IL",
"City": "Chicago",
"Country": "US",
"PhoneNumber": "1234567890",
"AddrType": 1
},
"OrderNum": "KV10644787171",
"EcOrderId": "123",
"Parcels": [{
"TrackingNumber": null,
"Weight": 3,
"Length": 22,
"Width": 22,
"Height": 22
}]
}
}
10.获取电商订单面单列表
BaseURL + /Api/Ecommerce/GetEcLabelsInfo
请求参数：
|
参数 |
是否必填 |
说明 |
|
Key |
是 |
用于校验认证 |
|
Data |
是 |
Data对象 |
Data对象
|
参数 |
是否必填 |
说明 |
|
EcOrderId |
是 |
电商订单Id |
返回参数
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
LabelInfo |
LabelInfo Json数组 – 面单的信息 |
请求参数：
Data={“EcOrderId”:111}&Key=88888888888888888888888888888888
返回值：
{
"Code": "200",
"Message": null,
"Data": [
{
"ShipmentId": "",
"LabelReady": true,
"LabelUrl": "http://localhost",
"TrackingNumbers": [
"1Z0EY9510334981488"
],
"Parcels": [
{
"TrackingNumber": "1Z0EY9510334981488",
"Weight": 33,
"Length": 19,
"Width": 15,
"Height": 13,
"Insure": 0,
"Picking": "",
"FbaRef": null,
"Quantity": 0,
"LabelUrl": "http://localhost/UploadFiles/UD/2022-01-07/4d224934-a24f-47a8-a07e-a76b1050daf3.pdf",
"AdditionalFee": 0
}
],
"OrderNum": "CSS214401270",
"LabelStatus": 1810,
"LabelStatusTxt": "退款审核中",
"TN2": null,
"Weight": 32.52
},
{
"ShipmentId": "",
"LabelReady": true,
"LabelUrl": "http://localhost",
"TrackingNumbers": [
"1Z0EY9510335615701"
],
"Parcels": [
{
"TrackingNumber": "1Z0EY9510335615701",
"Weight": 33,
"Length": 19,
"Width": 15,
"Height": 13,
"Insure": 0,
"Picking": "",
"FbaRef": null,
"Quantity": 0,
"LabelUrl": "http://localhost/UploadFiles/UD/2022-01-05/2ff4ecb8-1ae8-46cf-809f-548a70088e80.pdf",
"AdditionalFee": 0
}
],
"OrderNum": "CSS214401123",
"LabelStatus": 1810,
"LabelStatusTxt": "退款审核中",
"TN2": null,
"Weight": 32.52
}
]
}
11.回传物流信息上电商平台
BaseURL + /Api/Ecommerce/SetEcOrderTrackToChannel
请求参数：
|
参数 |
是否必填 |
说明 |
|
Key |
是 |
用于校验认证 |
|
EcOrderId |
是 |
电商订单Id |
|
TrackingNum |
是 |
物流跟踪号 |
|
CarrierAlias |
是 |
快递服务商（UPS Fedex Usps） |
|
ShipServiceLevel |
是 |
服务商渠道或服务 |
请求参数：
EcOrderId=111& TrackingNum=12324343434& CarrierAlias =UPS& ShipServiceLevel =ups test&Key=88888888888888888888888888888888
返回值：
{
"Code":"200",
"Message":"success",
"Data":null
}
12获取电商订单列表
BaseURL + /Api/ Ecommerce/GetEcOrderList
请求参数：
|
参数 |
是否必填 |
说明 |
|
Key |
是 |
用于校验认证 |
|
Data |
是 |
查询条件序列化后的字符串 |
Data对象
|
参数名 |
是否必填 |
类型 |
说明 |
|
OrderStatus |
否 |
String |
店铺平台状态 |
|
OrderId |
否 |
String |
电商订单号 |
|
ChannelSid |
否 |
Int |
店铺Id |
|
PageIndex |
否 |
Int |
页数 不填默认1 |
|
PageSize |
否 |
Int |
每页条数 不填默认100 |
|
PurchaseDateStart |
否 |
Date |
订单购买时间始 |
|
PurchaseDateEnd |
否 |
Date |
订单购买时间末 |
|
OrderIdList |
否 |
数组 |
订单号数组 |
|
ShipStatus |
否 |
String |
发货状态 Unshipped – 未发货 Shipping – 已发货 RefundReview – 申请退款中 RefundSucc – 退款成功 RefundFail – 退款失败 |
返回参数
|
属性名 |
说明 |
|
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
|
Message |
描述返回错误信息 |
|
Data |
Data对象 |
Data对象
|
参数 |
类型 |
说明 |
|
RowCount |
Int |
总条数 |
|
PageCount |
Int |
总页数 |
|
PageSize |
Int |
每页条数 |
|
PageIndex |
Int |
当前页 |
|
Datas |
List<EcOrder> |
EcOrder数组 |
EcOrder对象
|
参数 |
类型 |
说明 |
|
Sid |
Int |
订单id |
|
OrderId |
String |
电商订单号 |
|
OrderStatus |
String |
电商平台状态 |
|
ShipStatus |
String |
发货状态 |
|
ChannelName |
String |
店铺名称 |
|
ChannelSid |
Int |
店铺Id |
|
PurchaseDate |
Long |
购买时间 |
|
ShippingDate |
Date |
创建名单时间 |
|
TotalDiscounts |
Decimal |
折扣 |
|
SubTotal |
Decimal |
总价格 |
|
Channel |
String |
店铺类型 |
|
Site |
String |
店铺站点 |
|
TotalWeight |
Decimal |
总重量 |
|
BuyerEmail |
String |
购买者邮箱 |
|
BuyerName |
String |
购买者名称 |
|
BuyerPhoneNumber |
String |
购买者电话 |
|
IsPrime |
Bool |
是否会员订单 |
|
IsDel |
Bool |
是否忽略 |
|
ShipTo |
EcShipAddr |
收件人地址 |
|
OrderDetails |
List<EcOrderDetail> |
订单详情 |
EcShipTo对象
|
参数 |
类型 |
说明 |
|
OrderId |
String |
电商订单号 |
|
PostalCode |
String |
邮编 |
|
Name |
String |
收件人姓名 |
|
Address1 |
String |
地址1 |
|
Address2 |
String |
地址2 |
|
City |
String |
城市 |
|
State |
String |
州 |
|
Country |
String |
国家 |
|
CountryCode |
String |
国家简称 |
|
PhoneNumber |
String |
电话 |
|
Company |
String |
公司 |
|
AddrType |
Int |
地址类型 0 -未知
|
EcOrderDetail对象
|
参数 |
类型 |
说明 |
|
Id |
Int |
id |
|
OrderId |
Int |
电商订单号 |
|
Title |
String |
Title |
|
Sku |
String |
店铺Sku |
|
Upc |
String |
Upc |
|
Weight |
Decimal |
重量 |
|
ProductTaxCode |
String |
ProductTaxCode |
|
QuantityPurchased |
Int |
购买数量 |
|
IItemPrice |
Decimal |
单价 |
|
TotalPrice |
Decimal |
总价 |
|
PurchaseDate |
Long |
购买时间 |
|
ImageUrl |
String |
图片url |
请求：
Data={"PageIndex":1,"PurchaseDateStart":"2022-01-12"} &Key=88888888888888888888888888888888
返回：
{
"Code": "200",
"Message": null,
"Data": {
"RowCount": 2,
"PageCount": 1,
"PageSize": 100,
"PageIndex": 1,
"Datas": [
{
"Sid": 65289,
"TotalDiscounts": 0,
"SubTotal": 58.84,
"OrderId": "114-4871599-1111",
"PurchaseDate": 1641953790000,
"PaymentsDate": 0,
"PaymentsStatus": "",
"OrderStatus": "Unshipped",
"Channel": "amazon",
"Site": "US",
"TotalPrice": 58.84,
"CurrencyCode": "USD",
"PaymentMethod": "Other",
"ShippingMethod": "Econ US Dom",
"FulfillmentChannel": "MFN",
"BuyerEmail": "[email protected]",
"BuyerName": "Susan",
"BuyerPhoneNumber": "",
"TotalWeight": 10,
"ChannelName": "1111-HOMMP-US-amazon",
"ChannelSid": 23,
"IsPrime": false,
"ShipStatus": "UnShipped",
"OrderDetails": [
{
"OrderId": "114-4871599-1111",
"Title": "Hommp 4 Packs 30 Liter Clear Large Storage Boxes Container with Lids and Wheels",
"Sku": "17-FSXJ-QJVP",
"Upc": "",
"OrderStatus": "Unshipped",
"ProductTaxCode": "",
"Weight": 0,
"ItemPrice": 55,
"TotalPrice": 55,
"QuantityPurchased": 1,
"PurchaseDate": 1641953790000,
"ImageUrl": null
}
],
"ShipTo": null,
"UnitType": 0,
"IsDel": false
},
{
"Sid": 65288,
"TotalDiscounts": 0,
"SubTotal": 70.6,
"OrderId": "114-1049039-1211",
"PurchaseDate": 1641940778000,
"PaymentsDate": 0,
"PaymentsStatus": "",
"OrderStatus": "Unshipped",
"Channel": "amazon",
"Site": "US",
"TotalPrice": 70.6,
"CurrencyCode": "USD",
"PaymentMethod": "Other",
"ShippingMethod": "Econ US Dom",
"FulfillmentChannel": "MFN",
"BuyerEmail": "[email protected]",
"BuyerName": "Mickey",
"BuyerPhoneNumber": "",
"TotalWeight": 0,
"ChannelName": "111-HOMMP-US-amazon",
"ChannelSid": 23,
"IsPrime": false,
"ShipStatus": "UnShipped",
"OrderDetails": [
{
"OrderId": "114-1049039-1211",
"Title": "Hommp 2-Pack 40 L Plastic Collapsible Storage Crates, Large Stackable Storage Container Basket, Folding Crates Storage",
"Sku": "P2-DZ3R-JB37",
"Upc": "",
"OrderStatus": "Unshipped",
"ProductTaxCode": "",
"Weight": 0,
"ItemPrice": 33,
"TotalPrice": 66,
"QuantityPurchased": 2,
"PurchaseDate": 1641940778000,
"ImageUrl": null
}
],
"ShipTo": null,
"UnitType": 0,
"IsDel": false
}
]
}
}