## 获取快递公司列表(deliveryCompany) >[info] 场景说明:获取平台支持的快递公司列表,用于订单发货能实时查看物流跟踪信息,该返回结果会受平台启用哪个物流插件而返回不同的数据 ### 是否需要获取用户TOKEN `否` ***** ### 请求地址 ``` POST http://api.xxx.com/delivery/company ``` ### 公共请求参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | appid | string | 必须 | 平台提供的唯一APPID | | version | string | 必须 | 接口版本号,固定填:v3 | | sign\_type | string | 必须 | 签名类型,目前只支持md5 | | timestamp | string | 必须 | 发起时间戳,格式为:yyyy-mm-dd hh::ii::ss | | format | string | 必须 | 返回的数据格式,只支持json | | sign | string | 必须 | 请求参数的签名,请参考:[签名规则](signature.md) | | token | string | 必须 | 访问TOKEN | | params | string | 必须 | 请求参数的集合,除公共参数外,所有请求参数都必须放在这个参数中传递,json\_encode后送入 | 应用请求参数`params`格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | 无 | | | | ### 请求示例 ``` { "appid": "您的APPID", "version": "v3", "sign_type": "md5", "timestamp": "2020-8-10 12:00:00", "format": "json", "sign": "op0987yhjmngt54rtg2wgdfvcder2765", "params": null } ``` ***** ### 公共返回参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | integer | 必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) | | message | string | 必须 | 请求成功/失败的描述信息 | | \+ data | array | 必须 | 返回结果,如果没有指定用返回空 | | └ list | list | 必须 | 快递公司列表 | 返回`data->list`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | string | 必须 | 快递公司代码 | | name | string | 必须 | 快递公司名称 | ### 返回数据示例 ``` { "code": 0, "message": "成功", "data": { "list": [ { "code": "shunfeng", "name": "顺丰速递", }, { "code": "shentong", "name": "申通", } ] } } ```