一、基本信息
1.通信方式:
HTTP的POST方法
2.数据格式
响应数据采用JSON
3.请求参数
ContentType : application/x-www-form-urlencoded
Key(必填参数)
l 请求key(32位),公司提供给合作网站的识别字符串,用于识别和鉴定请求来源,避免未授权的非法访问。
l 登录系统后在右上角“个人中心->个人信息”获取Api Key
其它参数
按实际需要填写,见下面接口说明
4. 基本流程
以下是基本流程接口顺序,其他接口按需调测.
获取仓库信息GetWarehouse ->获取物流信息GetExpressList->获取SKU库存信息GetSkuInventoryList-> 创建发货单CreateOrder
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
Data |
是 |
Page 对象序列化后的字符串 |
Page对象
参数名 |
是否必填 |
类型 |
说明 |
PageSize |
是 |
Int |
每页大小 |
PageNumber |
是 |
Int |
第几页 |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Count |
总数量 |
Data |
仓库列表 |
仓库对象
参数 |
类型 |
说明 |
WarehouseName |
String |
仓库名 |
WarehouseCode |
String |
仓库编码 |
请求:
Data={
"PageSize": 10,
"PageNumber": 1
}&Key=88888888888888888888888888888888
返回:
{
"Code":"200",
"Message":"",
"Count":3,
"Data":[
{
"WarehouseCode":"153",
"WarehouseName":"洛杉矶"
},
{
"WarehouseCode":"148",
"WarehouseName":"第二仓库"
},
{
"WarehouseCode":"129",
"WarehouseName":"默认仓库"
}
]
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
快递列表 |
请求参数:
Key = 88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":null,
"Data":[
{
"ServiceList":[
"UPS Ground",
"UPS Three-Day Select"
],
"Name":"UPS TEST",
"CarrierName":"UPS TEST",
"CarrierType":"UPS",
"UnitType":-1,
"IsInsure":false,
"IsMultParcel":true,
"IsSignature":true,
"IsPicking":false,
"IsMustItem":false,
"Notes":"",
"IsFBA":false,
"IsShippingDate":false,
"ShipFromList":[
],
"ShipToList":[
]
},
{
"ServiceList":[
"UPS Ground",
"UPS Three-Day Select"
],
"Name":"UPS TEST2",
"CarrierName":"UPS TEST2",
"CarrierType":"UPS",
"UnitType":-1,
"IsInsure":false,
"IsMultParcel":true,
"IsSignature":true,
"IsPicking":false,
"IsMustItem":false,
"Notes":"",
"IsFBA":false,
"IsShippingDate":false,
"ShipFromList":[
{
"PostalCode":"24015-2702",
"Name":"zzy",
"Address1":"1838 Arden Rd SW",
"Address2":"",
"State":"VA",
"City":"Roanoke",
"Country":"USA",
"CountryCode":"US",
"PhoneNumber":"1480618534403068",
"AddrType":1,
"Company":""
}
],
"ShipToList":[
]
}
]
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
Data |
是 |
Sku 对象序列化后的字符串 |
Sku对象
参数 |
类型 |
说明 |
SkuId |
Int |
当SkuId=0,则是添加SKU,如果SkuId>0,则编辑SKU信息 |
Sku |
String |
Sku编码 (在系统唯一标识) |
SelfCode |
String |
Sku自编码 |
CnTitle |
String |
中文名称 |
EnTitle |
String |
英文名称 |
Weight |
Decimal |
重量 |
Length |
Decimal |
长 |
Width |
Decimal |
宽 |
Height |
Decimal |
高 |
SafetyAmount |
Int |
安全库存 |
DeclarePrice |
Decimal |
产品价值 |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
返回SkuId,可用于编辑SKU信息使用 |
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
Data |
是 |
Page 对象序列化后的字符串 |
Page对象
参数名 |
是否必填 |
类型 |
说明 |
PageSize |
是 |
Int |
每页大小 |
PageNumber |
是 |
Int |
第几页 |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Count |
总数量 |
Data |
SKU列表 |
Sku对象
参数 |
类型 |
说明 |
SkuId |
Int |
SkuId |
Sku |
String |
Sku编码 |
SelfCode |
String |
Sku自编码 |
CnTitle |
String |
中文名称 |
EnTitle |
String |
英文名称 |
Weight |
Decimal |
重量 |
Length |
Decimal |
长 |
Width |
Decimal |
宽 |
Height |
Decimal |
高 |
SafetyAmount |
Int |
安全库存 |
DeclarePrice |
Decimal |
产品价值 |
请求:
Data={
"PageSize": 2,
"PageNumber": 1
}&Key=88888888888888888888888888888888
返回:
{
"Code":"200",
"Message":"",
"Count":5,
"Data":[
{
"Sku":"sku1206",
"EnTitle":"cothes",
"CnTitle":"联想电脑",
"Weight":1,
"Length":1,
"Width":1,
"Height":1
},
{
"Sku":"sku120701",
"EnTitle":"milk",
"CnTitle":"零食",
"Weight":1,
"Length":1,
"Width":1,
"Height":1
}
]
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
Data |
是 |
Page对象序列化后的字符串 |
Page对象
参数名 |
是否必填 |
类型 |
说明 |
PageSize |
是 |
Int |
每页大小 |
PageNumber |
是 |
Int |
第几页 |
Sku |
否 |
String |
Sku编码 |
WarehouseCode |
否 |
String |
仓库编码 |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Count |
总数量 |
Data |
库存列表 |
库存对象
参数 |
类型 |
说明 |
Sku |
String |
Sku编码 |
SelfCode |
String |
Sku自编码 |
Amount |
Int |
库存数量 |
LockedAmount |
Int |
锁定库存 |
EffectiveAmount |
Int |
有效库存 |
SafetyAmount |
Int |
安全库存数量 |
WarehouseCode |
String |
仓库编码 |
WarehouseName |
String |
仓库名 |
请求:
Data={
"PageSize": 2,
"PageNumber": 1
}&Key=88888888888888888888888888888888
返回:
请求参数:
POST参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
Data |
是 |
Shipment Json 对象序列化后字符串 |
Shipment对象
参数名 |
是否必填 |
类型 |
说明 |
Carrier |
是 |
String |
运营商 |
ShipFrom |
是 |
ShipAddr |
发件人信息 |
ShipTo |
是 |
ShipAddr |
收件人信息 |
Parcels |
是 |
List<Parcels> |
包裹列表 |
ItemList |
是 |
List<Item> |
Sku信息列表 |
FreightCalss |
否 |
String |
UPS GFP FREIGHT_CLASS 必填。其他不用填这个参数 |
Signature |
否 |
Bool |
是否需要签名,默认不签名 |
WeightUnitType |
否 |
int |
单位类型,0表示lb/in,1表示kg/cm,2表示oz/in,默认是0 |
ShipAddr对象
参数名 |
是否必填 |
类型 |
说明 |
PostalCode |
是 |
String |
邮编 |
Name |
是 |
String |
姓名 |
Company |
否 |
String |
公司 |
Address1 |
是 |
String |
地址行1 |
Address2 |
否 |
String |
地址行2 |
State |
是 |
String |
州,两位代码 |
City |
是 |
String |
城市 |
Country |
是 |
String |
国家(US) ,目前只支持美国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": "6267104685",
"AddrType": 1
},
"ShipTo": {
"PostalCode": "60609",
"Name": "Jing zhang",
"Address1": "2023 w 35th st",
"Address2": null,
"State": "IL",
"City": "Chicago",
"Country": "US",
"PhoneNumber": "6267104685",
"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
}]
}
ContentType:application/json
POST 参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
thumbnail-file |
是 |
文件 必须是 pdf 文件 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
面单 url |
示例:
ContentType:application/json
POST 参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
TraceNumber |
是 |
面单跟踪号 |
OrderId |
是 |
订单id |
thumbnail-file |
是 |
文件 必须是 pdf 文件 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
面单 url |
示例:
POST 参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
Base64String |
是 |
文件Base64字符串 |
FileName |
是 |
文件名 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
面单 url |
示例:
请求参数:
POST参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
Data |
是 |
Shipment Json 对象序列化后的字符串 |
Shipment对象
参数名 |
是否必填 |
类型 |
说明 |
OrderNum |
是 |
String |
订单号,大于8位 |
WarehouseCode |
是 |
String |
仓库编码 |
Carrier |
是 |
String |
运营商 |
CarrierServiceLevel |
是 |
String |
运营商服务 |
ShipTo |
是 |
ShipAddr |
收件人信息 |
Parcels |
是 |
List<Parcels> |
包裹列表 |
ItemList |
是 |
List<Item> |
Sku信息列表 |
SizeFromSys |
否 |
Bool |
False,包裹的长宽高自传的为准;True,包裹的长宽高取系统SKU录入的。 |
FreightCalss |
否 |
String |
UPS GFP FREIGHT_CLASS 必填。其他不用填这个参数 |
LabelUrl |
否 |
String |
自传 label 时需必填自传 label 面单路径 |
TraceNumber |
否 |
String |
自传 label 时需必填 自传 label 面单跟踪号 |
CarrierType |
否 |
String |
自传 label 时需必填 自传 label时需必填 面单渠道类型 (UPS, USPS, FEDEX, WAYFAIR, LTL/FTL) |
IsNeedBol |
否 |
Bool |
自传 label且CarrierType为LTL/FTL时需必填 是否自动生成面单(BOL) |
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 |
公司 |
Address1 |
是 |
String |
地址行1 |
Address2 |
否 |
String |
地址行2 |
State |
是 |
String |
州 |
City |
是 |
String |
城市 |
Country |
是 |
String |
国家(US) ,目前只支持美国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对象
参数名 |
是否必填 |
类型 |
说明 |
Sku |
是 |
String |
Sku |
Quantity |
是 |
Int |
数量 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
OrderInfo对象 |
OrderInfo对象
参数名 |
类型 |
说明 |
OrderId |
类型 |
订单id |
OrderNum |
String |
订单号,大于8位,需要有权限,空则自动生成。如无权限,则无需填写 |
Carrier |
String |
运营商 |
CarrierServiceLevel |
String |
运营商服务 |
Created |
String |
创建时间 |
Status |
Int |
订单状态: 0- 创建 1- 拒绝 2- 拣货中 3- 已拣货 4- 已发货 |
ExpressStatus |
Int |
0- 创建 1- 申请取消 2- 审核成功 3- 审核失败 4- 未发货 5- 已拒绝 |
Weight |
Decimal |
重量 |
ShippingFee |
Decimal |
运费 |
OperateFee |
Decimal |
操作费 |
TraceNumber |
String |
物流跟踪单号 |
LabelUrl |
String |
面单下载地址 |
WarehouseName |
String |
仓库名 |
WarehouseCode |
String |
仓库编码 |
示例
请求参数:
Data = {
"Carrier": "ups2",
" WarehouseCode": "129",
"CarrierServiceLevel": "Ground",
"ShipTo": {
"PostalCode": "60609",
"Name": "Jing zhang",
"Address1": "2023 w 35th st",
"Address2": null,
"State": "IL",
"City": "Chicago",
"Country": "US",
"PhoneNumber": "6267104685",
"AddrType": 1
},
"OrderNum": null,
"Parcels": [{
"Weight": 3,
"Length": 22,
"Width": 22,
"Height": 22
}],
"ItemList": [{
"Sku": "TEST123456789",
"Quantity": 3
}]
}&Key = 88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"",
"Data":{
"OrderNum":"22210119",
"Created":"2021-01-09 21:33:04",
"Status":0,
"Weight":3,
"ShippingFee":73.68,
"Carrier":"UPS TEST",
"CarrierServiceLevel":"UPS Ground",
"LabelUrl":"http://www.xxx.com/UploadFiles/UD/2021-01-09/eb060c49-ae1b-43ea-8b17-d568e0339b36.pdf",
"WarehouseName":"默认仓库",
"WarehouseCode": "129"
}
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
Data |
是 |
查询条件序列化后的字符串 |
Data对象
参数名 |
是否必填 |
类型 |
说明 |
PageInfo |
是 |
PageInfo对象 |
分页信息 |
CreateTimeRange |
否 |
TimeRange对象 |
创建时间范围 |
UpdateTimeRange |
否 |
TimeRange对象 |
变更时间范围 |
Tag |
否 |
String |
标签属性,如ShipOnly、NeedCreateLabel等自定义标签 |
Code |
否 |
String |
订单编号 |
PageInfo对象
参数名 |
是否必填 |
类型 |
说明 |
PageSize |
是 |
Int |
每页大小 |
PageNumber |
是 |
Int |
第几页 |
TimeRange对象
参数名 |
是否必填 |
类型 |
说明 |
StartTime |
否 |
DateTime |
开始时间 |
EndTime |
否 |
DateTime |
结束时间 |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Count |
总数量 |
Data |
订单Order列表 |
Order对象
参数 |
类型 |
说明 |
OrderId |
String |
订单Id |
OrderNum |
String |
订单编号 |
Carrier |
String |
运营商 |
CarrierServiceLevel |
String |
运营商服务 |
Created |
DateTime |
创建时间 |
UpdateTime |
DateTime |
变更时间 |
Status |
Int |
订单发货状态: 0-创建;2-拣货中;3-已拣货;4-已发货 |
ExpressStatus |
Int |
订单申请取消发货状态: 0-创建;1-申请取消;2-审核成功;3-审核失败 |
LabelUrl |
String |
面单下载地址 |
TraceNumber |
String |
物流跟踪单号 |
Tag |
String |
标签属性,如ShipOnly、NeedCreateLabel等自定义标签 |
Remark |
String |
备注信息 |
AddrInfo |
Addr对象 |
地址信息 |
Skus |
Sku对象列表 |
SKU信息列表 |
Files |
File对象列表 |
附件信息列表 |
Addr对象
参数 |
类型 |
说明 |
ContactName |
String |
联系人 |
Province |
String |
省份 |
City |
String |
城市 |
ZipCode |
String |
编码 |
Address1 |
String |
地址1 |
Address2 |
String |
地址2 |
PhoneNumber |
String |
联系电话 |
CompanyName |
String |
公司名 |
Sku对象
参数 |
类型 |
说明 |
SkuId |
Int |
SkuId |
SkuCode |
String |
Sku编码 |
SkuEntitle |
String |
Sku英文描述 |
SkuCntitle |
String |
Sku中文描述 |
Amount |
Int |
Sku数量 |
File对象
参数 |
类型 |
说明 |
FileName |
String |
文件名 |
Url |
String |
文件下载地址 |
示例
请求参数:
Data={"PageInfo":{"PageSize":1,"PageNumber":1}}&Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"",
"Count":846,
"Data":[
{
"OrderId":929,
"OrderNum":"SH0B2329181Z116",
"Created":"2023-07-01 14:28:08",
"UpdateTime":null,
"Status":0,
"ExpressStatus":0,
"Carrier":"UPS TEST",
"CarrierServiceLevel":"UPS Ground",
"LabelUrl":"http://sandbox.dadanla.com/UploadFiles/UD/2023-06-30/184a109f-cb0c-46df-934b-9ac1fa73f928.pdf",
"TraceNumber":"1ZXXXXXXXXXXXXXXXX",
"Tag":null,
"Remark":null,
"AddrInfo":{
"ContactName":"kevin",
"Province":"CA",
"City":"temple city",
"ZipCode":"91780",
"Address1":"6269 Rosemead Blvd",
"Address2":null,
"PhoneNumber":"4445559888",
"CompanyName":null
},
"Skus":[
{
"SkuId":51652,
"SkuCode":"A000015",
"SkuEntitle":"onlyfortestandtest",
"SkuCntitle":"只是为了测试测试最后完了",
"Amount":3
}
],
"Files":[
{
"Url":"http://localhost/UploadFile/Order_Label_File/9/d8bc3797-4ed7-4f3f-a6e0-ee612e6c3ea6.pdf",
"FileName":"TEST0802.pdf"
}
]
}
]
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
Data |
是 |
Json 字符串数组 |
Data对象
参数名 |
是否必填 |
类型 |
说明 |
OrderId |
是 |
Int |
订单Id |
Status |
是 |
Int |
订单状态: 4-已发货 |
Carrier |
否 |
String |
运营商 |
CarrierServiceLevel |
否 |
String |
运营商服务 |
LabelUrl |
否 |
String |
面单下单 |
示例
请求参数:
Data={"OrderId":929,"Status":4}&Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"success",
"Data":null
}
请求参数:
POST参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
Data |
是 |
Json 字符串数组 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
OrderInfo Json数组 – 面单的信息 |
OrderInfo对象
参数名 |
类型 |
说明 |
OrderId |
类型 |
订单id |
OrderNum |
String |
订单号,大于8位,需要有权限,空则自动生成。如无权限,则无需填写 |
Carrier |
String |
运营商 |
CarrierServiceLevel |
String |
运营商服务 |
Created |
String |
创建时间 |
Status |
Int |
订单发货状态: 0-创建;2-拣货中;3-已拣货;4-已发货 |
ExpressStatus |
Int |
订单申请取消发货状态: 0-创建;1-申请取消;2-审核成功;3-审核失败 |
Weight |
Decimal |
重量 |
ShippingFee |
Decimal |
运费 |
OperateFee |
Decimal |
操作费 |
TraceNumber |
String |
物流跟踪单号 |
LabelUrl |
String |
面单下载地址 |
WarehouseName |
String |
仓库名 |
WarehouseCode |
String |
仓库编码 |
示例
请求参数:
Data=[
"20200107",
"fh20201215 ",
]&Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"",
"Data":[
{
"OrderNum":"fh20201215",
"Created":"2020-12-15 11:40:57",
"Status":0,
"Weight":2,
"ShippingFee":16.23,
"Carrier":"UPS TEST",
"CarrierServiceLevel":"UPS Ground",
"LabelUrl":"http://www.xxx.com/UploadFiles/UD/2020-12-14/ab1141ca-4a44-4c54-9b2b-ea10ce120d9e.pdf",
"WarehouseName":"默认仓库",
"WarehouseCode": "129"
},
{
"OrderNum":"20200107",
"Created":"2021-01-05 12:55:15",
"Status":0,
"Weight":3,
"ShippingFee":73.68,
"Carrier":"UPS TEST",
"CarrierServiceLevel":"UPS Ground",
"LabelUrl":"http://www.xxx.com/UploadFiles/UD/2021-01-04/4b0b9df2-fddf-426c-8caa-695c3b6f09f0.pdf",
"WarehouseName":"默认仓库",
"WarehouseCode": "129"
}
]
}
请求参数:
POST参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
OrderNum |
是 |
订单号 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
示例
请求参数:
OrderNum=KV10645076260&Key = 88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"取消订单申请成功"
}
请求参数:
POST参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
Data |
是 |
InRequest Json 对象序列化后的字符串 |
InRequest对象
参数名 |
是否必填 |
类型 |
说明 |
OrderNum |
否 |
String |
入库单号,大于8位。如果为空则系统会随机创建 |
WarehouseCode |
是 |
String |
仓库编码 |
BoxType |
是 |
Int |
0-包裹,1-货柜,2-托盘 |
Amount |
是 |
Int |
数量 |
Weight |
是 |
decimal |
重量 |
ArriveDate |
否 |
String |
预报到达日期 |
ItemList |
是 |
List<Item> |
Sku信息列表 |
Remark |
否 |
String |
备注 |
Item对象
参数名 |
是否必填 |
类型 |
说明 |
Sku |
是 |
String |
Sku |
Quantity |
是 |
Int |
数量 |
IsApplySku |
否 |
Bool |
值填写为Ture时, SKU对象信息必填 |
SkuInfo |
否 |
Sku对象 |
Sku对象信息 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
InRequestInfo对象 |
InRequestInfo对象
参数名 |
类型 |
说明 |
OrderNum |
String |
入库单号 |
WarehouseCode |
String |
仓库编码 |
WarehouseName |
String |
仓库名字 |
BoxType |
Int |
0-包裹,1-货柜,2-托盘 |
Weight |
decimal |
重量 |
ArriveDate |
String |
预报到达日期 |
Remark |
String |
备注 |
Status |
Int |
0-已发,2-已签收,3-已入库,4-入库中。 |
Deleted |
Bool |
是否已删除 |
示例
请求参数:
Data={
"OrderNum": 2221012501,
"WarehouseCode": "129",
"BoxType":0,
"Amount":2,
"Weight":2,
"ItemList": [{
"Sku": "sku1124",
"Quantity": 1
}]
}&Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"",
"Data":{
"OrderNum":"2221012501",
"WarehouseCode":"129",
"WarehouseName":"默认仓库",
"BoxType":0,
"Amount":2,
"ArriveDate":null,
"Weight":2,
"Status":0,
"Remark":null
}
}
请求参数:
POST参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
Data |
是 |
Json 字符串数组 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
InRequestInfo Json数组 – 入库单的信息 |
InRequestInfo对象
参数名 |
类型 |
说明 |
OrderNum |
String |
入库单号 |
WarehouseCode |
String |
仓库编码 |
WarehouseName |
String |
仓库名字 |
BoxType |
Int |
0-包裹,1-货柜,2-托盘 |
Weight |
decimal |
重量 |
ArriveDate |
String |
预报到达日期 |
Remark |
String |
备注 |
Status |
Int |
0-已发,2-已签收,3-已入库,4-入库中。 |
Details |
List<InRequestDetail> |
SKU入库明细 |
InRequestDetail对象
参数名 |
类型 |
说明 |
SkuCode |
String |
SKU |
Amount |
Int |
预报数量 |
SignAmount |
Int |
签收数量 |
InAmount |
String |
入库数量(库存以该数量为准) |
示例
请求参数:
Data=[
" 2221012501",
]&Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"",
"Data":[
{
"OrderNum":"2221012501",
"WarehouseCode":"129",
"WarehouseName":"默认仓库",
"BoxType":0,
"Amount":2,
"ArriveDate":null,
"Weight":0,
"Status":0,
"Remark":null
}
]
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
Data |
是 |
查询条件序列化后的字符串 |
Data对象
参数名 |
是否必填 |
类型 |
说明 |
PageInfo |
是 |
Int |
每页大小 |
StartDate |
否 |
Date |
创建时间始 |
EndDate |
否 |
Date |
创建时间末 |
OrderId |
否 |
String |
电商订单号 |
ChannelName |
否 |
String |
店铺名称 |
ShipStatus |
否 |
String |
发货状态 Unshipped – 未发货 Shipping – 已发货 RefundReview – 申请退款中 RefundSucc – 退款成功 RefundFail – 退款失败 |
PageInfo对象
参数名 |
是否必填 |
类型 |
说明 |
PageSize |
是 |
Int |
每页大小 |
PageNumber |
是 |
Int |
第几页 |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Count |
总数量 |
Data |
电商订单EcOrder列表 |
EcOrder对象
参数 |
类型 |
说明 |
Id |
Int |
订单id |
OrderId |
String |
电商订单号 |
OrderStatus |
String |
电商平台状态 |
ShipStatus |
String |
发货状态 |
ChannelName |
String |
店铺名称 |
ChannelId |
Int |
店铺Id |
PurchaseDate |
Long |
购买时间 |
ShippingDate |
Date |
创建名单时间 |
CarrierName |
String |
快递服务商渠道 |
ShipServiceLevel |
String |
渠道服务 |
TrackingNumber |
String |
快递主单号 |
ShippingPrice |
Decimal |
快递费用 |
LabelPdfs |
String |
快递面单Url |
ShippingWeight |
Decimal |
发货重量 |
LabelId |
Int |
面单Id |
LabelStatus |
Int |
面单状态 0 – 创建 1- 申请退款 2- 退款成功 3- 退款失败 4- 未创建面单 |
OrderNumber |
String |
发货单号 |
Channel |
String |
店铺 |
EcSite |
String |
店铺站点 |
EcShipTo |
EcShipTo |
收件人地址 |
EcOrderDetails |
List<EcOrderDetail> |
订单详情 |
EcShipTo对象
参数 |
类型 |
说明 |
Id |
Int |
id |
OrderLabelId |
Int |
电商订单Id(或者面单id) |
PostalCode |
String |
邮编 |
Name |
String |
收件人姓名 |
Address1 |
String |
地址1 |
Address2 |
String |
地址2 |
Address3 |
String |
地址3 |
City |
String |
城市 |
State |
String |
州 |
Country |
String |
国家 |
CountryCode |
String |
国家简称 |
PhoneNumber |
String |
电话 |
AddrType |
Int |
地址类型 0 -未知 1- 商业 2- 住宅 |
DataType |
Int |
0- 电商订单地址 1- 面单地址 |
EcOrderDetail对象
参数 |
类型 |
说明 |
Id |
Int |
id |
OrderId |
Int |
电商订单号 |
EcOrderId |
Int |
电商订单Id |
Title |
String |
Title |
Sku |
String |
店铺Sku |
Upc |
String |
Upc |
Weight |
Decimal |
重量 |
ProductTaxCode |
String |
ProductTaxCode |
QuantityPurchased |
Int |
购买数量 |
IItemPrice |
Decimal |
单价 |
TotalPrice |
Decimal |
总价 |
PurchaseDate |
Long |
购买时间 |
ConSku |
Sku |
本系统sku |
请求:
Data={
"PageInfo":{
"PageSize":100,
"PageNumber":1
}}&Key=88888888888888888888888888888888
返回:
{
"Code":"200",
"Message":"",
"Count":1,
"Data":[
{
"Id":64646,
"SubTotal":41.99,
"OrderId":"114-6711175-8888",
"ShipStatus":"UnShipped",
"OrderStatus":"Unshipped",
"TotalPrice":41.99,
"TotalWeight":0,
"ChannelName":"UUMITTY-US",
"ChannelId":369,
"IsPrime":null,
"OwnerId":77,
"OwnerName":"trans test",
"PurchaseDate":1640848903000,
"ShippingDate":null,
"CarrierName":null,
"TrackingNumber":null,
"ShippingPrice":null,
"ShipServiceLevel":null,
"LabelPdfs":null,
"ShippingWeight":null,
"LabelStatus":4,
"LabelId":null,
"OrderNumber":null,
"Channel":"amazon",
"EcSite":"US",
"EcShipTo":{
"Id":86496,
"OrderLabelId":64646,
"PostalCode":"63103-1934",
"Name":"Shanaye Rogers",
"Address1":"1209 WASHINGTON AVE APT 201",
"Address2":"",
"Address3":"",
"State":"MO",
"District":"",
"City":"SAINT LOUIS",
"Country":"UNITED STATES",
"CountryCode":"US",
"PhoneNumber":"+1 763-225-9463 ext. 14942",
"Type":0,
"AddrType":0,
"DataType":0
},
"EcOrderDetails":[
{
"Id":66029,
"OrderId":"114-6711175-8888",
"EcOrderId":64646,
"Title":"Uumitty 3-Pack 40 L Large Folding Basket, Plastic Collapsible Storage Crate, Black",
"Sku":"IT-RFWF-AUUT",
"Upc":"751300845296",
"Weight":0,
"ProductTaxCode":"",
"QuantityPurchased":1,
"IItemPrice":41.99,
"TotalPrice":41.99,
"PurchaseDate":1640848903000,
"ConSku":{
"Sku":"TP20203",
"EnTitle":"thinkpad",
"CnTitle":"联想电脑",
"Weight":2.5,
"Length":3,
"Width":3,
"Height":3,
"EffectiveAmount":0
}
}
]
}
]
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Count |
总数量 |
Data |
电商店铺EcChannel列表 |
EcChannel对象
参数 |
类型 |
说明 |
Id |
Int |
id |
ChannelName |
String |
店铺名称 |
请求参数:
Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"",
"Data":[
{
"Id":57,
"ChannelName":"cg22222"
},
{
"Id":181,
"ChannelName":"AN2222-US-amazon"
}
]
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
EcOrderId |
Int |
电商订单Id |
返回参数
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
电商面单EcOrderLabel列表 |
EcOrderLabel对象
参数 |
类型 |
说明 |
Id |
Int |
id |
OrderId |
String |
电商订单号 |
EcOrderId |
Int |
电商订单Id |
CarrierName |
String |
快递服务商渠道 |
ShipServiceLevel |
String |
渠道服务 |
TrackingNumber |
String |
快递主单号 |
ShippingPrice |
Decimal |
快递费用 |
LabelPdfs |
String |
快递面单Url |
ShippingWeight |
Decimal |
发货重量 |
LabelId |
Int |
面单Id |
LabelStatus |
Int |
面单状态 0 – 创建 5- 申请退款 6- 退款成功 7- 退款失败 未创建面单 |
ShippingDt |
Date |
创建面单时间 |
OrderNumber |
String |
发货单编号 |
IsSignature |
Bool |
是否签名(默认否) |
WarehouseCode |
String |
仓库编号 |
WarehouseName |
String |
仓库名称 |
EcParcels |
EcParcel |
包裹列表 |
EcShipTo |
EcShipTo |
收件人地址 |
EcParcel对象
参数 |
类型 |
说明 |
Id |
Int |
id |
Weight |
Decimal |
重量 |
Length |
Decimal |
长 |
Width |
Decimal |
宽 |
Height |
Decimal |
高 |
OrderLabelId |
Int |
面单Id |
TrackingCode |
String |
跟踪号 |
Carrier |
String |
快递服务商渠道 |
ServiceLevel |
String |
渠道服务 |
OrderId |
String |
电商订单号 |
Picking |
String |
拣货信息 |
请求参数:
EcOrderId=111&Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"",
"Data":[
{
"Id":6,
"OrderId":"174026496648-8888",
"EcOrderId":108,
"CarrierName":"UPS TEST",
"TrackingNumber":"1Z6F22500329988644",
"ShippingPrice":23.78,
"ShippingDt":"2020-10-13 06:20:56",
"ShipServiceLevel":"UPS Ground",
"LabelPdfs":"http://eeships.uskuaidi.com/UploadFiles/UD/1Z6F22500329988644.pdf",
"ShippingWeight":3,
"Status":1,
"ShipFreightClass":null,
"InsuranceValue":null,
"UpdateStatusCount":null,
"IsUpdateStatus":true,
"NeedUpdateStatus":null,
"OrderNumber":"0000771602595255",
"IsSignature":false,
"OwnerId":77,
"OwnerName":"trans test",
"WarehouseCode":129,
"WarehouseName":"默认仓库",
"EcParcels":[
{
"Id":6,
"Weight":2.5,
"Length":5,
"Width":0.2,
"Height":0.1,
"OrderLabelId":6,
"TrackingCode":"1Z6F22500329988644",
"Carrier":"UPS TEST",
"ServiceLevel":"UPS Ground",
"Reference1":null,
"Reference2":null,
"Reference3":null,
"Code":null,
"OrderId":"174026496648-8888",
"InsuranceValue":null,
"Picking":null
}
],
"EcShipTo":{
"Id":114,
"OrderLabelId":6,
"PostalCode":"02814-2036",
"Name":"Andrew Arsenault",
"Address1":"132 Keach Dam Rd",
"Address2":null,
"Address3":null,
"State":"RI",
"District":null,
"City":"Chepachet",
"Country":null,
"CountryCode":null,
"PhoneNumber":"4019548691",
"Type":0,
"AddrType":2,
"DataType":1
}
},
{
"Id":7,
"OrderId":"174026496648-8888",
"EcOrderId":108,
"CarrierName":"UPS TEST",
"TrackingNumber":"1Z6F22500333198052",
"ShippingPrice":23.78,
"ShippingDt":"2020-10-13 06:22:44",
"ShipServiceLevel":"UPS Ground",
"LabelPdfs":"http://eeships.uskuaidi.com/UploadFiles/UD/1Z6F22500333198052.pdf",
"ShippingWeight":3,
"Status":0,
"ShipFreightClass":null,
"InsuranceValue":null,
"UpdateStatusCount":null,
"IsUpdateStatus":true,
"NeedUpdateStatus":null,
"OrderNumber":"0000771602595363",
"IsSignature":false,
"OwnerId":77,
"OwnerName":"trans test",
"WarehouseCode":129,
"WarehouseName":"默认仓库",
"EcParcels":[
{
"Id":7,
"Weight":2.5,
"Length":5,
"Width":0.2,
"Height":0.1,
"OrderLabelId":7,
"TrackingCode":"1Z6F22500333198052",
"Carrier":"UPS TEST",
"ServiceLevel":"UPS Ground",
"Reference1":null,
"Reference2":null,
"Reference3":null,
"Code":null,
"OrderId":"174026496648-8888",
"InsuranceValue":null,
"Picking":null
}
],
"EcShipTo":{
"Id":115,
"OrderLabelId":7,
"PostalCode":"02814-2036",
"Name":"Andrew Arsenault",
"Address1":"132 Keach Dam Rd",
"Address2":null,
"Address3":null,
"State":"RI",
"District":null,
"City":"Chepachet",
"Country":null,
"CountryCode":null,
"PhoneNumber":"4019548691",
"Type":0,
"AddrType":2,
"DataType":1
}
}
]
}
请求参数:
POST参数名 |
是否必填 |
说明 |
Key |
是 |
Api Key用于校验认证 |
Data |
是 |
EcShipment Json 对象序列化后的字符串 |
EcShipment对象
参数名 |
是否必填 |
类型 |
说明 |
WarehouseCode |
是 |
String |
仓库编码 |
Carrier |
是 |
String |
运营商 |
CarrierServiceLevel |
是 |
String |
运营商服务 |
ShipTo |
是 |
ShipAddr |
收件人信息 |
Parcels |
是 |
List<Parcels> |
包裹列表 |
FreightCalss |
否 |
String |
UPS GFP FREIGHT_CLASS 必填。其他不用填这个参数 |
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服务下单 |
IsNoSku |
否 |
Bool |
是否忽略sku库存(默认否) |
IsCheckStatus |
否 |
Bool |
是否检查店铺平台发货状态(默认否) |
IsSendStatus |
否 |
Bool |
电商平台是否回传物流跟踪号和更新发货状态(默认否) |
ShipAddr对象
参数名 |
是否必填 |
类型 |
说明 |
PostalCode |
是 |
String |
邮编 |
Name |
是 |
String |
姓名 |
Company |
否 |
String |
公司 |
Address1 |
是 |
String |
地址行1 |
Address2 |
否 |
String |
地址行2 |
State |
是 |
String |
州 |
City |
是 |
String |
城市 |
Country |
是 |
String |
国家(US) ,目前只支持美国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返回支持才可用 |
返回对象 Response
属性名 |
说明 |
Code |
状态码 200 - 成功返回 600 – 服务器异常 603 – 参数错误
|
Message |
描述返回错误信息 |
Data |
EcOrder对象 |
示例
Data={"WarehouseCode":"129","Carrier":"UPSTEST","CarrierServiceLevel":"UPS Ground","ShipTo":{"PostalCode":"37419-1438","Name":"April Collins","Company":null,"Address1":"338 shanty lake dr","Address2":"","State":"TN","City":"chattanooga","Country":"US","PhoneNumber":"4234887707","AddrType":0},"Parcels":[{"Weight":3.52,"Length":2.52,"Width":4.54,"Height":16.54}],"SizeFromSys":false,"Remark1":"","WeightUnitType":0,"AutoChangeService":true,"EcOrderId":64399}&Key=88888888888888888888888888888888
返回值
{
"Code":"200",
"Message":"success",
"Data":{
"Id":64399,
"SubTotal":45.51,
"OrderId":"111-7246036-8888",
"ShipStatus":"Shipping",
"OrderStatus":"Unshipped",
"TotalPrice":45.51,
"TotalWeight":4,
"ChannelName":"UUMITTY-US",
"ChannelId":369,
"IsPrime":null,
"OwnerId":77,
"OwnerName":"trans test",
"PurchaseDate":1640820469000,
"ShippingDate":"2022-01-04 10:00:47",
"CarrierName":"UPS TEST",
"TrackingNumber":"1Z6F22500326460996",
"ShippingPrice":23.29,
"ShipServiceLevel":"UPS Ground",
"LabelPdfs":"http://eeships.uskuaidi.com/UploadFiles/UD/2022-01-03/ca299903-69bf-4aa5-a2e8-6676780a9abe.pdf",
"ShippingWeight":4,
"LabelStatus":0,
"LabelId":21864,
"OrderNumber":"000771641261640",
"Channel":"amazon",
"EcSite":"US",
"EcShipTo":{
"Id":86246,
"OrderLabelId":64399,
"PostalCode":"89141-3320",
"Name":"Allison Hernandez",
"Address1":"3064 CIPRO AVE",
"Address2":"",
"Address3":"",
"State":"NV",
"District":"",
"City":"LAS VEGAS",
"Country":"UNITED STATES",
"CountryCode":"US",
"PhoneNumber":"+1 929-436-4790 ext. 05180",
"Type":0,
"AddrType":0,
"DataType":0
},
"EcOrderDetails":[
{
"Id":65776,
"OrderId":"111-7246036-8888",
"EcOrderId":64399,
"Title":"Uumitty 3-Pack 40 L Large Folding Basket, Plastic Collapsible Storage Crate, Black",
"Sku":"IT-RFWF-AUUT",
"Upc":"751300845296",
"Weight":0,
"ProductTaxCode":"",
"QuantityPurchased":1,
"IItemPrice":41.99,
"TotalPrice":41.99,
"PurchaseDate":1640820469000,
"ConSku":{
"Sku":"TP20203",
"EnTitle":"thinkpad",
"CnTitle":"联想电脑",
"Weight":2.5,
"Length":0.3,
"Width":0.2,
"Height":0.1,
"EffectiveAmount":95
}
}
]
}
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
EcOrderId |
Int |
电商订单Id |
LabelId |
Int |
面单Id |
请求参数:
EcOrderId=111&LabelId =123&Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"success",
"Data":null
}
请求参数:
参数 |
类型 |
说明 |
Key |
String |
Api Key用于校验认证 |
EcOrderId |
Int |
电商订单Id |
TrackingNum |
String |
物流跟踪号 |
CarrierName |
String |
快递服务商(UPS Fedex Usps) |
ServiceLevel |
String |
服务商渠道或服务 |
请求参数:
EcOrderId=111& TrackingNum=12324343434& CarrierName =UPS& ServiceLevel =ups test&Key=88888888888888888888888888888888
返回值:
{
"Code":"200",
"Message":"success",
"Data":null
}