First, express query map track
1.1 Interface Format
Provide HTTP POST or GET call interface in uniform format, and return format support JSON, XML, text, HTML data.
1.2 Requesting an Address
Poll.kuaidi100.com/poll/maptra…
Request parameters:
Parameter names | If required | type | instructions |
---|---|---|---|
customer | is | string | Authorization code, pleaseApply for enterprise EditionTo obtain |
sign | is | string | The signature is used to authenticate the identity. MD5 encryption is performed in the sequence of Param + key + Customer (the encrypted string must be in 32-bit uppercase letters) and the + sign is not required |
param | is | param | Concatenated by other fields |
Param data structure:
Parameter names | If required | type | instructions |
---|---|---|---|
com | is | string | Query the express company code, all use lowercase letters |
num | is | string | The number of the queried Courier order is a maximum of 32 characters |
phone | no | string | The telephone number of sender and receiver (mobile phone and fixed phone are acceptable, only one can be filled in. Sf single number is mandatory, and other express companies choose to fill in. If a landline number has an extension number, the extension number does not need to be uploaded. |
from | is | string | Source information, for example, Kingdee Software Park, Nanshan District, Shenzhen city, Guangdong Province |
to | is | string | Destination information, such as international Finance Building, Chaoyang District, Beijing |
show | no | string | Format: 0: JSON (default), 1: XML, 2: HTML, 3: text |
order | no | string | Order of returned results :desc descending (default), ASC ascending |
orderTime | no | string | The ordering time is in the format of YYYY-MM-DD HH: MM: SS, for example, 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":"The 2020-12-16 12:59:59"
}
Copy the code
1.4 Result
The field names | type | Field meaning |
---|---|---|
message | String | Message body, please ignore |
state | Integer | The current status of the express bill includes 13 states, including 0 in transit, 1 Receiving, 2 difficult, 3 receiving, 4 signing back, 5 sending, 6 returning, 7 forwarding, 10 waiting for customs clearance, 11 in customs clearance, 12 cleared, 13 abnormal customs clearance, 14 recipient rejection and so on |
status | Integer | Communication status, please ignore |
condition | String | Express order details status mark, not implemented yet, please ignore |
ischeck | Integer | Please ignore whether to sign the label, and refer to the state field for details |
com | String | Express company code, all lowercase letters |
nu | String | Order no. |
trailUrl | String | Track map link |
arrivalTime | String | Estimated time of arrival |
totalTime | String | The average time |
remainTime | String | How long will it take to get there |
isLoop | Boolean | Is there a loop |
Θ routeInfo | Routing information | |
└ Θ the from | Information about the region of origin | |
└ number | District information coding | |
└ name | District information name | |
└ Θ cur | Current administrative district information | |
└ number | District information coding | |
└ name | District information name | |
└ Θ to | Destination Administrative Region Information | |
└ number | District information coding | |
└ name | District information name | |
Θ data | data | Latest query result, array, contains multiple, full, reverse order (that is, the latest in the first), each item is an object, the object contains fields please expand |
└ context | String | content |
└ time | String | Time, raw format |
└ ftime | String | Time after formatting |
└ status | String | The signature status of this data element will appear only after the Resultv2 mark is submitted in the real-time query interface |
└ areaCode | String | The code of the administrative area corresponding to this data element will appear only after the Resultv2 mark 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": "The 2020-11-30 13:19:56"."context": "The express has arrived at The Shang Yi Station, No.3, Fortune Gold Street courtyard, tel: 18744663997"."ftime": "The 2020-11-30 13:19:56"."areaCode": null."areaName": null."status": "In transit"
}, {
"time": "The 2020-09-12 17:40:58"."context": "[Pinghu Company, Shenzhen city, Guangdong Province] Received by: Liu Jiezhen (18128837173)"."ftime": "The 2020-09-12 17:40:58"."areaCode": "CN440307003000"."areaName": Pinghu, Longgang District, Shenzhen City, Guangdong Province."status": "LanShou"}]."state": "3"."condition": "00"."routeInfo": {
"from": {
"number": "CN4403"."name": "Shenzhen, Guangdong province"
},
"cur": {
"number": "CN6101"."name": "Xi 'an, Shaanxi province"
},
"to": {
"number": "CN6101"."name": "Xi 'an, Shaanxi province"}},"isLoop": false."trailUrl":"https://api.kuaidi100.com/tools/map/bc80574d538262aecc897a469151f0e3"."arrivalTime": "The 2020-12-19 12:00"."totalTime": "2 days, 1 hour."."remainTime": "One day, two hours."
}
Copy the code
1.6 Service description of waybill signing status
The status value | The name of the | meaning |
---|---|---|
0 | In transit | The express is in transit |
1 | LanShou | The express has been collected by the express company |
2 | difficult | Express 100 cannot resolve a state, or a state that requires human intervention, such as the recipient’s wrong phone number. |
3 | Sign after receiving STH | Normal sign for it |
4 | Back to sign | The goods are returned to the consignor for signature |
5 | To send a | The goods are being dispatched |
6 | Back to the | The goods are on their way back to the shipper |
7 | Switch to | Transfer the goods to another express company |
10 | For customs clearance | The goods await customs clearance |
11 | The guanzhong qing | The goods are in the process of customs clearance |
12 | Have customs clearance | The goods have completed the customs clearance process |
13 | Abnormal clearance | The goods are abnormal in the customs clearance process |
14 | A visa | The recipient expressly refused to accept |
1.7 Application examples of trace Link
1.8 Error Return Example
{
"result":false."returnCode":"400"."message":"Can't find the corresponding company."
}
Copy the code
Information code | Information Description | Causes and recommended handling methods |
---|---|---|
200 | The query is successful | The query is successful |
400 | Parameter Permission Problem | The data is incomplete, the corresponding company can not be found, illegal IP, please apply for authorization, this express company is not supported, the tracking number problem, etc |
500 | If no result is found, try again | It means that the query failed and the express company did not obtain effective data |
501 | Server error | Sometimes, if the request is not submitted according to the standard, for example, the parameters of the express company are not filled in according to the document, etc., this error will also be reported |
502 | Busy server | The server of Express 100 is disconnected or temporarily abnormal. Please contact Express 100 for troubleshooting |
503 | Failed to verify the signature | Check the encryption mode. The sequence of param + key + Customer is encrypted by MD5. After the encryption, the string is uppercase |
601 | No permission for this function | No unit is available or no permissions are enabled |
I. Introduction to the API product of express query map track
Express 100 Express query map track interface provides enterprises and end users with map track display of express tracking numbers, text information of logistics nodes and expected delivery time, and visualization of logistics track information.
By invoking the map track interface, map track, logistics node information, estimated arrival time, express order status and other information can be displayed to diversify the display dimensions of logistics information and improve customer query experience.
2. Application scenarios of express query map track API
- In e-commerce web page /APP/ small program, customers view the logistics map track of purchased goods in order details;
- And logistics track text information together to display to customers, visualization of the in-transit status of the order;
- Obtain the information of logistics route city, monitor the delivery time;
- Estimate the arrival time of the package and how long it will take for the package to arrive, identify the status of the package, and send a message to remind customers to sign for it;
Iii. Charging mode of express query map track API
1. Charging method
Express query map track is a value-added service, which supports logistics text information and map link, that is, contains the function of real-time query interface. After registering express 100 enterprise account, you can view the price of map track package and purchase it in the enterprise management background.
2. Fees
New product limited time special, activity time: January 1, 2021 – March 31, 2021, recharge can be opened for use.
The original price $/ | Preferential price/yuan | Single amount | Give/single | Preferential unit price/yuan |
---|---|---|---|---|
2000 | 20000 | 5000 | 0.08 | |
1000 | 10000 | 2000 | About 0.084 | |
500 | 5000 | 500 | About 0.09 | |
100 | 1000 | 0.1 |
Express query map track charge by single, one natural month the same waybill for many times only charge once. The interface is charged separately.
3. Invoice
Express 100 supports issuing VAT invoices. After purchase, users can request invoice from the enterprise management background – expense center – payment record -. General electronic VAT invoice is issued by default, and special VAT invoice can be issued for more than 1000 yuan.
Official source:
Api.kuaidi100.com/document/5f…
Api.kuaidi100.com/document/5f…