文档中心 > API类目 > 仓库地区API

dsc.warehouse.insert.post (获取单条仓库地区信息API)

获取单条仓库地区信息API,获取仓库地区相关信息。

公共参数

请求地址:
环境 HTTP请求地址 HTTPS请求地址
正式环境 http://www.xxx.com/api.php https://www.xxx.com/api.php
公共请求参数:
名称 类型 是否必须 描述
method String API接口名称
app_key String API接口AppKey

请求参数

名称 类型 是否必须 示例值 更多限制 描述
data array 必须 array('region_id' => 4, 'region_code' => BJ0001, 'regionId' => 2, 'parent_id' => 0, 'region_name' => '北京', 'region_type' => 1) 转为JSON或XML 更新参数
format type 必须 json json或xml 接口类型

响应参数

名称 类型 示例值 描述
region_id Number 仓库地区ID
region_code String 仓库地区编码CODE
(备注:适用于v2.3及以上版本)
regionId Number 地区ID
parent_id Number 父级ID
region_name String 仓库地区名称
region_type Number 仓库地区层级(0:仓库;1:省份;2:市级;3:县级地区;4:乡镇街道)
agency_id Number 办事处的ID

请求示例

  • PHP(json格式)
  • PHP(xml格式)
$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.warehouse.insert.post&format=json"
$Http = new Http();
 
$data=array(
'regionId' => '2',
'parent_id' => '1',
'region_name' => '北京',
"region_code": "BJ0001",
'region_type' => '1',
'agency_id' => '0'
)
 
$data = json_encode($data); // 对变量进行 JSON 编码
$argument=array(
'data' => $data
)
 
$Http->doPost($url, $argument);
$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.warehouse.insert.post&format=xml"
$Http = new Http();
 
$data = '<?xml version="1.0" encoding="utf-8"?>
<dsc>
<regionId>2</regionId>
<region_code>BJ0001</region_code>
<parent_id>1</parent_id>
<region_name>北京</region_name>
<region_type>1</region_type>
<agency_id>0</agency_id>
</dsc>';
 
$data = htmlspecialchars($data); // 将特殊字符转换为 HTML 实体
$argument = array(
'data' => $data
);
 
$Http->doPost($url, $argument);

异常示例

  • XML
  • JSON
<dsc>
<result>success</result>
<error>0</error>
<msg>数据提交成功</msg>
</dsc>
{
"result": "success",
"error": 0,
"msg": "数据提交成功",
}

错误码解释

错误码 错误描述 解决方案
error 返回值

0:数据提交成功

1:数据提交失败,参数不存在

2:存在不可传参的参数

3:已存在相同数据,无法添加

4:关键参数不存在或值为空

5:当前名称数据已存在,无法添加

6:名称值不能为空或传参名称不存在

返回
顶部