Query logistics company information
Interface address: http://api.vv-tool.com/tool/erps/companies
Interface introduction: Batch query logistics orders and return the logistics information status details of orders Click to view details
Request method: POST
Return format: JSON
Interface charges: Deduction account balance
Frequency limit: 10 times / second
Request header parameters
parameter | type | Mandatory | value | Example |
---|---|---|---|---|
Authorization | string | yes | Authorize access_token | Bearer 1798c6aadec33d1bc2f5b707f1049aefexxxx |
Request parameters
parameter | type | Mandatory | describe |
---|---|---|---|
fields | String[] | yes | List of fields to return. Optional values: all fields in the LogisticCompany structure; Multiple fields are separated by "," commas. For example: id,code,name,reg_mail_no description: id: logistics company ID code: logistics company code name: logistics company name reg_mail_no: the corresponding waybill rules of the logistics company |
is_recommended | Boolean | no | Whether to query the recommended logistics company. Optional values: true,false. If this parameter is not provided, all logistics companies supporting telephone contact will be returned. |
order_mode | string | no | Recommend the order placement method of the logistics company. Optional values: offline (telephone contact / self contact), online (online order), all (i.e. telephone contact and online order). This parameter is only used for is_ When recommended is true. In other words, it is only available for recommended logistics companies. If this parameter is not selected, the logistics company that supports telephone contact in the recommended logistics will be returned. |
vvtype | int | no | Normal version 1, default version 1 is not transmitted, enhanced version 2, and enhanced version 2 needs to be transmitted |
Request example
fields:id,code,name,reg_mail_no
Request code example
cURL request code example
curl --location --request POST 'http://api.vv-tool.com/tool/erps/companies' \ --header 'Authorization: Bearer 1798c6aadec33d1bc2f5b707f1049aefexxxx' \ --header 'Cookie: __yjs_duid=1_dee3bfba5b90592372d209eda95c772a1616035269331; PHPSESSID=eg6rdq9svo8iisp0qdn8de28ds; _csrf=28d4b1b6a1a8187c94992e5c050d1d0c86b827c40735e28f2ae103584e094711a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%2252FhR6NNpbAyiE0zgVtqOXqPgIGWS7QY%22%3B%7D' \ --form 'fields="id,code,name,reg_mail_no"'
PHP request code example
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'http://api.vv-tool.com/tool/erps/companies', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => array('fields' => 'id,code,name,reg_mail_no'), CURLOPT_HTTPHEADER => array( 'Authorization: Bearer 1798c6aadec33d1bc2f5b707f1049aefexxxx', 'Cookie: __yjs_duid=1_dee3bfba5b90592372d209eda95c772a1616035269331; PHPSESSID=eg6rdq9svo8iisp0qdn8de28ds; _csrf=28d4b1b6a1a8187c94992e5c050d1d0c86b827c40735e28f2ae103584e094711a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%2252FhR6NNpbAyiE0zgVtqOXqPgIGWS7QY%22%3B%7D' ), )); $response = curl_exec($curl); curl_close($curl); echo $response;
JAVA request code example
OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM) .addFormDataPart("fields","id,code,name,reg_mail_no") .build(); Request request = new Request.Builder() .url("http://api.vv-tool.com/tool/erps/companies") .method("POST", body) .addHeader("Authorization", "Bearer 1798c6aadec33d1bc2f5b707f1049aefexxxx") .addHeader("Cookie", "__yjs_duid=1_dee3bfba5b90592372d209eda95c772a1616035269331; PHPSESSID=eg6rdq9svo8iisp0qdn8de28ds; _csrf=28d4b1b6a1a8187c94992e5c050d1d0c86b827c40735e28f2ae103584e094711a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%2252FhR6NNpbAyiE0zgVtqOXqPgIGWS7QY%22%3B%7D") .build(); Response response = client.newCall(request).execute();
Response parameters
parameter | type | describe |
---|---|---|
code | int | Error code 0 is success |
msg | string | Return code description |
msec | int | Interface execution time |
time | int | Interface return time |
id | int | Identification of logistics company |
code | String | Identification of logistics company |
name | String | Abbreviation of logistics company |
reg_mail_no | String | Waybill number validation regular expression |
withholding_money | int | Deduction amount of this interface (counting coupons) |
Return data
{ "code": 0, "msg": "success", "msec": 1193, "time": 1612416107, "data":[ { "withholding_money": 1, "id":44555, "code":"AB15555", "name":"pingpaiming", "reg_mail_no":"^[0-9]{12}$" } ] }
Response code
code | Code description | Solution |
---|---|---|
0 | success | |
100 | Request parameter error | Check whether your request parameters are correct |
101 | The request timed out. Please try again | Check your network or contact customer service for solutions |
103 | Wangwang account does not exist | Check whether the Wangwang number you entered is correct |
200 | System error, please contact customer service | Check whether your interface address is filled in correctly, and contact customer service for other problems |
202 | System error, please try again later | Try again later, or contact the docking group |
203 | The current interface is not supported | |
204 | Request exception: no permission for this interface, please go to the official website to open an official interface. | Go to the official website to open the interface permission |
204 | Request exception: the number of API calls is insufficient. Please go to the website to redeem the number. | Go to the official website to recharge the number of calls of the interface |
401 | Invalid identity certificate | Add access to the request header_ Token, update the token again |
404 | Request path or request mode error | Please change the request mode or check whether the path is correct |