文档中心 > API类目 > 商品货品API

dsc.product.area.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

请求参数

名称 类型 是否必须 示例值 更多限制 描述
product_id Number 可选 货品ID
product_sn Number 可选 (唯一性) 货品编码
(建议同[goods_id]参数一起使用)
goods_id Number 可选 (非唯一性) 商品ID
area_id Number 可选 (非唯一性) 仓库地区ID
(不能单独使用,获取仓库 dsc.warehouse.info.get 的region_id值)
page Number 可选 1 默认 列表分页当前页
page_size Number 可选 15 默认 列表分页每页显示条数
format type 必须 json json或xml 接口类型

响应参数

名称 类型 示例值 描述
product_id Number 货品ID
goods_id Number 商品ID
goods_attr String 519|528 属性ID名称(ID值拼接格式:519|528)
product_sn String 货品编码
bar_code String 货品条形码
product_number Number 货品库存
product_price float 货品价格
product_promote_price float 货品促销价
product_market_price float 货品市场价格
product_warn_number Number 货品警告库存
area_id Number 地区ID(对应仓库地区API:region_id,region_type 值为 1)

请求示例

  • PHP
$url="http(s)://www.xxx.com/api.php?app_key=A788F457-1A7D-4CC7-ABA0-BFE212BCCD9A&method=dsc.product.area.list.get&format=xml"
$Http = new Http();
$Http->doGet($url);

响应示例

  • XML
  • JSON
<dsc>
<info>
<list>
<item id="0">
<product_id>1</product_id>
<goods_id>154</goods_id>
<goods_attr>519|528</goods_attr>
<product_sn>154HP0001</product_sn>
<bar_code>154BAR0001</bar_code>
<product_number>999</product_number>
<product_price>167.54</product_price>
<product_promote_price>146.2</product_promote_price>
<product_market_price>300</product_market_price>
<product_warn_number>20</product_warn_number>
<area_id>411</area_id>
</item>
<item id="1">
<product_id>2</product_id>
<goods_id>154</goods_id>
<goods_attr>518|531</goods_attr>
<product_sn>154HP0002</product_sn>
<bar_code>154BAR0002</bar_code>
<product_number>849</product_number>
<product_price>157.54</product_price>
<product_promote_price>136.2</product_promote_price>
<product_market_price>300</product_market_price>
<product_warn_number>20</product_warn_number>
<area_id>411</area_id>
</item>
</list>
</info>
<filter>
<page>1</page>
<page_size>15</page_size>
<record_count>36</record_count>
<page_count>3</page_count>
</filter>
<page_count>3</page_count>
<record_count>36</record_count>
</dsc>
{
"info": {
"list": [{
"product_id": "1",
"goods_id": "154",
"goods_attr": "519|528",
"product_sn": "154HP0001",
"bar_code": "154BAR0001",
"product_number": "999",
"product_price": "167.54",
"product_promote_price": "146.2",
"product_market_price": "300",
"product_warn_number": "20",
"area_id": "411",
},
{
"product_id": "2",
"goods_id": "154",
"goods_attr": "518|531",
"product_sn": "154HP0002",
"bar_code": "154BAR0002",
"product_number": "849",
"product_price": "157.54",
"product_promote_price": "136.2",
"product_market_price": "300",
"product_warn_number": "20",
"area_id": "411",
}],
"filter": {
"page": 1,
"page_size": 15,
"record_count": 36,
"page_count": 3
},
"page_count": 3,
"record_count": 36
}
}

异常示例

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

错误码解释

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

0:成功获取数据

1:数据为空值

返回
顶部