文档帮助中心
dsc.shipping.list.get (获取快递方式列表API)
获取快递方式列表API，获取地区相关信息。
公共参数
请求地址：
公共请求参数：
| 环境 | HTTP请求地址 | HTTPS请求地址 |
|---|---|---|
| 正式环境 | https://www.xxx.com/api.php | https://www.xxx.com/api.php |
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| method | String | 是 | API接口名称 |
| app_key | String | 是 | API接口AppKey |
请求参数
| 名称 | 类型 | 是否必须 | 示例值 | 更多限制 | 描述 |
|---|---|---|---|---|---|
| page | Number | 可选 | 1 | 默认 | 列表分页当前页 |
| page_size | Number | 可选 | 15 | 默认 | 列表分页每页显示条数 |
| format | type | 必须 | json | json或xml | 接口类型 |
响应参数
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| shipping_id | Number | 快递方式ID | |
| shipping_code | String | 快递编码 | |
| shipping_name | String | 快递名称 | |
| shipping_desc | String | 快递描述 | |
| insure | float | 0.00 | 保价费用，单位元，或者是百分数，该值直接输出为报价费用 |
| support_cod | Number | 是否支持货到付款【1：支持，0：不支持】 | |
| enabled | Number | 该配送方式是否被禁用【1：可用，0：禁用】 | |
| shipping_print | Text | 快递打印模板 | |
| print_bg | Text | 图片文件 | |
| config_lable | Text | 自提点地址 | |
| print_model | Number | 打印单模板 | |
| shipping_order | Number | 排序 | |
| customer_name | String | 快递鸟账号 | |
| customer_pwd | String | 快递鸟密码 | |
| month_code | String | 快递鸟月结编码 | |
| send_site | String | 快递鸟网点标识 |
请求示例
PHP
- $url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.shipping.list.get&format=xml"
- $Http = new Http();
- $Http->doGet($url);
错误码解释
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| error | 返回值 | 0：成功获取数据 1：数据为空值 |
