Express 100 map track query API interface case

Time:2021-6-2

1、 Express query map track

1.1 interface format

Provide unified HTTP post or get call interface, and return format, support JSON, XML, text, HTML data.

1.2 request address

https://poll.kuaidi100.com/po…

Request parameters:

Parameter name Is it required type explain
customer yes string Authorization code, pleaseApply for Enterprise Editionobtain
sign yes string The signature is used to verify the identity. MD5 encryption is performed in the order of param + key + customer (note that the encrypted string must be converted to 32-bit uppercase), without the “+” sign
param yes param Splicing by other fields

Param data structure:

Parameter name Is it required type explain
com yes string The code of the inquiry express company shall be in lowercase letters
num yes string The maximum length of the inquiry express order number is 32 characters
phone no string The telephone number of the sender and receiver (both mobile phone and fixed line telephone, only one can be filled in, SF order number is required, other express companies can choose to fill in. If the landline number has an extension number, the extension number does not need to be uploaded.)
from yes string Departure information, such as: Kingdee Software Park, Nanshan District, Shenzhen City, Guangdong Province
to yes string Destination information, such as: International Finance building, Chaoyang District, Beijing
show no string Return format: 0: JSON format (default), 1: XML, 2: HTML, 3: text
order no string Return result sort: desc descending (default), ASC ascending
orderTime no string The order placing time, in the format of (yyyy MM DD HH: mm: SS), such as: 2020-12-16 12:59:59

1.3 request instance

customer=**
  sign=**
  param={
    "com":"ems",
    "num":"em263999513jp",
    "phone":"13868688888",
    "From": Kingdee Software Park, Nanshan District, Shenzhen City, Guangdong Province,
    "To": "international finance building, Chaoyang District, Beijing",
    "show":"0",
    "order":"desc",
    "orderTime":"2020-12-16 12:59:59"
  }

1.4 return results

Field name type Field meaning
message String Message body, please ignore
state Integer The current status of express bill includes: 0 in transit, 1 collect, 2 difficult, 3 sign in, 4 return, 5 dispatch, 6 return, 7 transfer, 10 waiting for customs clearance, 11 clearing, 12 cleared, 13 abnormal customs clearance, 14 refused to sign
status Integer Communication status, please ignore
condition String Express bill details status flag, not implemented yet, please ignore
ischeck Integer Please ignore the sign in flag. Please refer to the state field for details
com String Express company code, all in small letters
nu String Odd Numbers
trailUrl String Track Map Links
arrivalTime String Estimated time of arrival
totalTime String Average time
remainTime String How long will it take to arrive
isLoop Boolean Is there a loop
ΘrouteInfo Routing information
└Θfrom Departure District Information
└number District Information Coding
└name District Information Name
└Θcur Current district information
└number District Information Coding
└name District Information Name
└Θto Destination district information
└number District Information Coding
└name District Information Name
Θdata data The latest query result, array, contains multiple items, full quantity, reverse order (that is, the latest one is at the top), each item is an object, and the object contains fields, please expand
└ context String content
└ time String Time, original format
└ ftime String Time after formatting
└status String The sign in status corresponding to this data element will only appear after the resultv2 tag is submitted in the real-time query interface
└areaCode String The code of the administrative region corresponding to this data element will appear only after the resultv2 tag is submitted in the real-time query interface
└areaName String The name of the administrative region corresponding to this data element will appear only after the resultv2 tag is submitted in the real-time query interface

1.5 provide data content

{
    "message": "ok",
    "nu": "YT4781863654577",
    "ischeck": "1",
    "com": "yuantong",
    "status": "200",
    "data": [{
        "time": "2020-11-30 13:19:56",
        "Context": "Yuantong cooperation point [meow station] Express has arrived at the bottom business station, No. 3, Fortune Street courtyard, Tel: 18744663997",
        "ftime": "2020-11-30 13:19:56",
        "areaCode": null,
        "areaName": null,
        "Status": "on the way"
    }, {
        "time": "2020-09-12 17:40:58",
        "Context": "[Pinghu company, Shenzhen, Guangdong Province] received by: Liu Jiezhen (18128837173)",
        "ftime": "2020-09-12 17:40:58",
        "areaCode": "CN440307003000",
        "Areaname": "Pinghu, Longgang District, Shenzhen, Guangdong",
        "Status": "collection"
    }],

    "state": "3",
    "condition": "00",
    "routeInfo": {
        "from": {
            "number": "CN4403",
            "Name": "Shenzhen, Guangdong"
        },
        "cur": {
            "number": "CN6101",
            "Name": "Xi'an, Shaanxi"
        },
        "to": {
            "number": "CN6101",
            "Name": "Xi'an, Shaanxi"
        }
    },
    "isLoop": false,
       "trailUrl":"https://api.kuaidi100.com/tools/map/bc80574d538262aecc897a469151f0e3",
    "arrivalTime": "2020-12-19 12:00",
    "Totaltime": "2 days, 1 hour,",
    "Remaintime": "1 day, 2 hours"
}

1.6 waybill sign in status service description

State value name meaning
0 On the way The express is in transit
1 Collect The express has been accepted by the express company
2 difficult Express 100 can not resolve the status, or it needs manual intervention, such as the recipient’s phone error.
3 Sign for Normal sign in
4 Withdrawal of signature Return the goods to the consignor and sign for them
5 Dispatch The goods are being dispatched
6 return The goods are on the way back to the consignor
7 Switching The goods are transferred to other express companies for mailing
10 To be cleared Goods waiting for customs clearance
11 Customs clearance in progress The goods are in the process of customs clearance
12 Cleared The goods have been cleared
13 Abnormal customs clearance The goods are abnormal in the process of customs clearance
14 deny sb. a visa The addressee expressly refuses

1.7 application example of track link

<img style=”zoom:60%”>

1.8 error return example

{
"result":false,
"returnCode":"400",
"Message": "corresponding company not found"
}
Information code Information content description Causes and suggested treatment
200 query was successful query was successful
400 Parameter permission problem Incomplete data, unable to find the corresponding company, illegal IP, please apply for authorization, do not support this express company, order number problem, etc
500 No result, please check again every other time It means that the query failed and the express company didn’t get valid data
501 Server error Sometimes, if the server of express 100 does not submit the request according to the specification, such as the express company’s parameters are not filled in according to the document requirements, this error will also be reported
502 Server busy Express 100 server out of the management gap or temporary exception, please contact express 100 to check the reason
503 Failed to verify signature Please check the encryption method. MD5 encryption is performed in the order of param + key + customer. After encryption, the string is converted to uppercase
601 No permission for this function There is no available quantity or permission to open

1、 Product introduction of express map track query API

Express 100 Express query map track interface provides enterprises and end users with map track display of express order number, text information of logistics node and estimated delivery time, and visualizes logistics track information.

By calling the map track interface, it can display map track, logistics node information, estimated arrival time, express bill status and other information, diversify logistics information display dimensions, and improve customer query experience.

2、 Application scenarios of Express query map trajectory API

  1. In the e-commerce website / APP / applet, customers can view the logistics map track of the purchased goods in the order details;
  2. Display to customers together with text information of logistics track to visualize the in transit status of orders;
  3. Obtain the information of the logistics route city and monitor the express delivery efficiency;
  4. Estimate the arrival time of the package, and prompt how long it will take for the package to arrive, identify the express delivery status, and send SMS to remind customers to sign in;

3、 Express map query API charging mode

1. Charging method

Express query map track is a value-added service, which supports logistics text information and map link, that is, it contains the function of real-time query interface. After registering the express 100 enterprise account, you can use it in the enterprise management backgroundView map track packagePrice and buy.

2. Charging price

Limited time special offer for new products, activity time: from January 1, 2021 to March 31, 2021, which can be put into use after recharging.

Original price / yuan Preferential price / yuan Single quantity Gift / bill Preferential unit price / yuan
3000 2000 20000 5000 0.08
1500 1000 10000 2000 About 0.084
750 500 5000 500 About 0.09
150 100 1000 0.1

Express query map track is charged by bill, and the same waybill is only charged once for multiple queries in a natural month. The interface is charged separately.

3. Invoice

Express 100 supports the issuance of VAT invoice. After purchase, users can request invoice in the enterprise management background expense center payment record. The default value-added tax ordinary invoice, more than 1000 yuan can support the value-added tax special invoice.

Official source document:

http://api.kuaidi100.com/docu…

http://api.kuaidi100.com/docu…