文档中心 > API类目 > 快递方�API

dsc.shipping.list.get (获�快递方�列表API)

获�快递方�列表API,获�地区相关信�。

公共�数

请求地�:
环境 HTTP请求地� HTTPS请求地�
正�环境 http://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);

�应示例

  • XML
  • JSON
<dsc>
<info>
<list>
<item id="0">
<shipping_id>1</shipping_id>
<shipping_code>sto_express</shipping_code>
<shipping_name>申通快递</shipping_name>
</item>
<item id="1">
<shipping_id>2</shipping_id>
<shipping_code>sf_express</shipping_code>
<shipping_name>顺丰速�</shipping_name>
</item>
</list>
</info>
<filter>
<page>1</page>
<page_size>15</page_size>
<record_count>13</record_count>
<page_count>1</page_count>
</filter>
<page_count>1</page_count>
<record_count>13</record_count>
</dsc>
{
"info": {
"list": [{
"shipping_id": "1",
"shipping_code": "sto_express",
"shipping_name": "申通快递",
},
{
"shipping_id": "2",
"shipping_code": "sf_express",
"shipping_name": "顺丰速�",
}],
"filter": {
"page": 1,
"page_size": 15,
"record_count": 13,
"page_count": 1
},
"page_count": 1,
"record_count": 13
}
}

异常示例

  • XML
  • JSON
<dsc>
<result>success</result>
<error>0</error>
<msg>�功获�数�</msg>
</dsc>
{
"result": "success",
"error": 0,
"msg": "�功获�数�",
}

错误�解释

错误� 错误�述 解决方案
error 返回值

0:�功获�数�

1:数�为空值

返回
顶部