һϢ

1.ͨŷʽ:

HTTPPOST

2.ݸʽ

ӦݲJSON

3.

ContentType : application/x-www-form-urlencoded

Key

l key(32λ)˾ṩվʶַʶͼԴδȨķǷʡ

l ¼ϵͳϽ->ϢȡApi Key

ʵҪдӿ˵

/Api/GetWarehouse(ȡϵͳֿ)

˵

Key

String

У֤

Data

Page лַ

 

Page

Ƿ

˵

PageSize

Int

ÿҳС

PageNumber

Int

ڼҳ

 

ز

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

 

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":"Ĭϲֿ"
        }
    ]
}

/Api/GetExpressList(ȡݺͿݷ)

˵

Key

String

У֤

 

 

ز

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

 

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

            ]
        }
    ]
}

/Api/GetSkuList(ȡSKUб)

˵

Key

String

У֤

Data

Page лַ

Page

Ƿ

˵

PageSize

Int

ÿҳС

PageNumber

Int

ڼҳ

 

ز

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

 

Message

شϢ

Count

Data

SKUб

 

 

Sku

˵

Sku

String

Sku

SelfCode

String

Sku

CnTitle

String

EnTitle

String

Ӣ

Weight

Decimal

Length

Decimal

Width

Decimal

Height

Decimal

SafetyAmount

Int

ȫ

 

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)

˵

Key

String

У֤

Data

Pageлַ

 

Page

Ƿ

˵

PageSize

Int

ÿҳС

PageNumber

Int

ڼҳ

Sku

String

Sku

WarehouseCode

String

ֿ

 

ز

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

 

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

 

/Api/GetExpressRates(ȡ)

POST

Ƿ

˵

Key

ݹ˾ŵ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 C 쳣

603 C

 

Message

شϢ

Rate

Rate Json C Ϣ

 

ʾ

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

     }]

}

/Api/UpLoadLabel (ϴ浥 ΪԴlabel) ͷ 

ContentTypeapplication/json 

POST

Ƿ

˵

Key

ݹ˾ŵ key

thumbnail-file

ļ   pdf ļ

ض Response

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

  

Message

شϢ

Data

url

ʾ

 

 

/Api/UpLoadShippingLabel (ϴ浥 ΪԴlabel) ͷ 

ContentTypeapplication/json 

POST

Ƿ

˵

Key

ݹ˾ŵ key

TraceNumber

浥ٺ

OrderId

id

thumbnail-file

ļ   pdf ļ

ض Response

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

  

Message

شϢ

Data

url

ʾ

 

 

/Api/UpLoadLabelBase64 (Base64ϴ浥 ΪԴlabel)  

POST

Ƿ

˵

Key

ݹ˾ŵ key

Base64String

ļBase64ַ

FileName

ļ

ض Response

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

  

Message

شϢ

Data

url

ʾ

 

/Api/CreateOrder()

POST

Ƿ

˵

Key

ݹ˾ŵkey

Data

Shipment Json лַ

Shipment

Ƿ

˵

OrderNum

String

ţ 

WarehouseCode

String

ֿ

Carrier

String

Ӫ

CarrierServiceLevel

String

Ӫ̷

ShipTo

ShipAddr

ռϢ

Parcels

List<Parcels>

б

ItemList

List<Item>

SkuϢб

SizeFromSys

Bool

FalseijԴΪ׼Trueijȡϵͳ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

Դ labelCarrierTypeΪLTL/FTLʱ

ǷԶ浥BOL

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 C 쳣

603 C

 

Message

شϢ

Data

OrderInfo

 

OrderInfo

˵

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

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

/Api/GetOrderInfo(ѯ)

POST

Ƿ

˵

Key

ݹ˾ŵkey

Data

Json ַ

 

ض Response

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

 

Message

شϢ

Data

OrderInfo Json C 浥Ϣ

 

OrderInfo

˵

OrderNum

String

ţ8λҪȨޣԶɡȨޣд

Carrier

String

Ӫ

CarrierServiceLevel

String

Ӫ̷

Created

String

ʱ

Status

Int

״̬

0- 

1- ܾ()

2- 

3- Ѽ

4- ѷ

ExpressStatus

Int

0- 

1- ȡ

2- ˳ɹ

3- ʧ

4- δã

5- Ѿܾã

6- 

7- سɹ

8- ʧ

Weight

Decimal

ShippingFee

Decimal

˷

TraceNumber

String

ٵ

LabelUrl

String

浥صַ

WarehouseName

String

ֿ

WarehouseCode

String

ֿ

TotalFee

Decimal

ܷ

 

ʾ

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"
        }
    ]
}

/Api/InterceptOrder()

POST

Ƿ

˵

Key

ݹ˾ŵkey

OrderNum

 

ض Response

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

 

Message

شϢ

 

ʾ

OrderNum=KV10645076260&Key = 88888888888888888888888888888888

ֵ

{"Code":"200","Message":""} 

/Api/CancelOrder(ȡ)

POST

Ƿ

˵

Key

ݹ˾ŵkey

OrderNum

 

ض Response

˵

Code

״̬

200 - ɹ

600 C 쳣

603 C

 

Message

شϢ

 

ʾ

OrderNum=KV10645076260&Key = 88888888888888888888888888888888

ֵ

{
    "Code":"200",
    "Message":"ȡɹ"
}

 

/Api/CreateInRequest (Ԥⵥ)

POST

Ƿ

˵

Key

ݹ˾ŵ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