Developer Documentation
Query pick-up addres

1.Description

Place ISP orders in a single step on seller's website. Query the pick-up address of the seller after selecting the pick-up mode.

2.Scenario

 Place ISP orders in a single step on seller's website. Query the pick-up address of the seller after selecting the pick-up mode.

 

3.Request Information

URL

http://openapi.winit.com.cn/openapi/service

UAT
Action 
action:ums.address.getByPickupService

Authentication

Token,md5

Format

json

Protocol

http,post

Rate Limitation

Default 300 requests per minute, can request increase on needs



4.Request Parameter


Name

Type

Length

Required

Description

Example

winitProductCode

String

100

Y

Product Code


dispatchType

String

100

Y

Delivery Method(C: China Post; P: Pick-up; S: Shipment



5、Response Parameter

Name

Type

Length

Description

Description


id

long

20

Y

Address ID


addressServiceIdlong20YAddress Service ID
codeString50YAddress code

countryCode

String

100

Y

Country Code


countryNameString100YCountry Name
cityCodeString100YCity code
cityNameString100YCity
stateString100YState
stateNameString100YDistrict(province
districtCodeString100YDistrict code
detailCnString100Y Address in Chinese
detailEnString100Y Address in English
doorplateString100YHausnummer
detail1String100YStreet1
detail2String100YStreet2

postCode

String

100

Y

zip code


contactPersonString100YContact Person
contactNumberString100YPhone Number
emailString100NEmail
isdefaultString1YIsDefault
userIdString20YUser Id

6、Request Example

{

    "action": "ums.address.getByPickupService", 

    "app_key": "qiongjierui@163.com", 

    "data": {

        "dispatchType": "C", 

        "winitProductCode": "PPTestProduct"

    }, 

    "format": "json", 

    "language": "zh_CN", 

    "platform": "sw", 

    "sign": "FDF4BB91F5E0B421679C2373D9B2DAFC", 

    "sign_method": "md5", 

    "timestamp": "2015-06-16 00:09:09", 

    "version": "1.0"

}

Response Example

{

    "code": "0", 

    "data": {

        "list": [

            {

                "addressServiceId": 0, 

                "cityCode": "SZ", 

                "cityName": "shenzheng", 

                "code": "13", 

                "contactNumber": "8888", 

                "contactPerson": "88888", 

                "countryCode": "CN", 

                "countryName": "China", 

                "detail1": "", 

                "detail2": "", 

                "detailCn": "taba", 

                "detailEn": "taba", 

                "distrctCode": "NA", 

                "doorplate": "", 

                "email": "", 

                "id": 305, 

                "isdefault": "Y", 

                "postCode": "518000", 

                "state": "GD", 

                "stateName": "GuangDong", 

                "userId": 1000044

            }, 

            {

                "addressServiceId": 0, 

                "cityCode": "SZ", 

                "cityName": "shengzheng", 

                "code": "15", 

                "contactNumber": "333", 

                "contactPerson": "tama1", 

                "countryCode": "CN", 

                "countryName": "China", 

                "detail1": "", 

                "detail2": "", 

                "detailCn": "tama1", 

                "detailEn": "tama1", 

                "distrctCode": "NA", 

                "doorplate": "", 

                "email": "", 

                "id": 307, 

                "postCode": "518000", 

                "state": "GD", 

                "stateName": "GuangDong", 

                "userId": 1000044

            }, 

            {

                "addressServiceId": 0, 

                "cityCode": "SZ", 

                "cityName": "shengzheng", 

                "code": "8", 

                "contactNumber": "333", 

                "contactPerson": "test", 

                "countryCode": "CN", 

                "countryName": "China", 

                "detail1": "", 

                "detail2": "", 

                "detailCn": "test", 

                "detailEn": "test", 

                "distrctCode": "NA", 

                "doorplate": "", 

                "email": "", 

                "id": 277, 

                "isdefault": "N", 

                "postCode": "518000", 

                "state": "GD", 

                "stateName": "GuangDong", 

                "userId": 1000044

            }

        ]

    }, 

    "msg": "OPERATION SUCCESS"

}


Response Description

Success response:outbound order number.

Error response:Error code, Error message