一、基本信息

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

/Api/GetWarehouse(获取系统仓库)

请求参数：

Page对象

返回参数

仓库对象

请求：

Data={

     "PageSize": 10,

     "PageNumber": 1

}&Key=88888888888888888888888888888888

返回：

{

    "Code":"200",

    "Message":"",

    "Count":3,

    "Data":[

        {

            "WarehouseCode":"153",

            "WarehouseName":"洛杉矶"

        },

        {

            "WarehouseCode":"148",

            "WarehouseName":"第二仓库"

        },

        {

            "WarehouseCode":"129",

            "WarehouseName":"默认仓库"

        }

    ]

}

/Api/GetExpressList(获取快递和快递服务)

请求参数：

返回参数

请求参数：

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":[

            ]

        }

    ]

}

/Api/CreateSku(创建or编辑SKU)

请求参数：

Sku对象

返回参数

/Api/GetSkuList(获取SKU列表)

请求参数：

Page对象

返回参数

Sku对象

请求：

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

        }

    ]

}

/Api/GetSkuInventoryList (获取SKU库存)

请求参数：

Page对象

返回参数

库存对象

请求：

Data={

     "PageSize": 2,

     "PageNumber": 1

}&Key=88888888888888888888888888888888

返回：

/Api/GetExpressRates(获取费率)

请求参数：

 Shipment对象

ShipAddr对象

Parcel对象

Item对象(new)

返回对象 Response

示例

请求参数：

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 35^th 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

     }]

}

/Api/UpLoadLabel (上传面单 订单为自传label类型) 请求头 

ContentType：application/json 

返回对象 Response

示例：

/Api/UpLoadShippingLabel (上传面单 订单为自传label类型) 请求头 

ContentType：application/json 

返回对象 Response

示例：

/Api/UpLoadLabelBase64 (Base64上传面单 订单为自传label类型)  

返回对象 Response

示例：

/Api/CreateOrder(创建订单)

请求参数：

Shipment对象

ShipAddr对象

Parcel对象

Item对象

返回对象 Response

OrderInfo对象

示例

请求参数：

Data = {

     "Carrier": "ups2",

     " WarehouseCode": "129",

     "CarrierServiceLevel": "Ground",

     "ShipTo": {

         "PostalCode": "60609",

         "Name": "Jing zhang",

         "Address1": "2023 w 35^th 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"

    }

}

/Api/GetOrderInfo(查询订单)

请求参数：

返回对象 Response

OrderInfo对象

示例

请求参数：

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",