文档中心 > API类目 > 新零售供应链API

alibaba.ascp.channel.region.sellable.item.query (可售品池查询接口)

区域可售商品查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
region_item_sellable_query_request RegionItemSellableQueryRequest 可选 查询入参
  • └ province_code
  • String
  • 可选
  • 330000
  • 省份编码,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ city_code
  • String
  • 可选
  • 330100
  • 城市编码,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ street_code
  • String
  • 可选
  • 330110005
  • 街道编码,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ page_size
  • Number
  • 必须
  • 1000
  • 单页查询数量,最大值 1000
  • └ sub_channel_code
  • String
  • 必须
  • tmcspm_qyg
  • 二级渠道编码。如:tmcspm_qyg、qygMkt_erp
  • └ scroll_id
  • String
  • 可选
  • ABCDEFG
  • 滚动ID,除了第一次查询不用传递,后续查询都得带上前一次查询结果里的 scroll_id。 ● 同步响应的情况下:第1页无需传递scroll_id,从第2页开始每次传递前一页返回值里的scroll_id。 ● 异步响应的情况下:第一次请求无需传递scroll_id,等待奇门通知后,第1页查询传递奇门通知里的scroll_id,从第2页开始每次传递前一页返回值里的scroll_id。
  • └ area_code
  • String
  • 可选
  • 330110
  • 区县编码,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ street_name
  • String
  • 可选
  • 五常街道
  • 街道名称,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ city_name
  • String
  • 可选
  • 杭州市
  • 城市名称,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ area_name
  • String
  • 可选
  • 余杭区
  • 区县名称,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ page_index
  • Number
  • 必须
  • 1
  • 分页查询页码,从1开始,查询下一页时则累加一次,最大页数为totalCount/page_size 向上取整。查询过程请不要跳页,否则不保证返回结果准确性。 ● 同步响应的情况下:totalCount仅会在查询第1页的时候返回。 ● 异步响应的情况下:totalCount仅会在奇门通知里返回。
  • └ country_code
  • String
  • 可选
  • 1
  • 国家编码,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ request_id
  • String
  • 必须
  • 124
  • 请求ID,某个时刻用相同查询条件从第一页查询到最后一页表示一次完整的请求,在本次完整请求的每页查询均传递相同的requestId,并确保同一个分销商不同完整请求的requestId全局唯一
  • └ country_name
  • String
  • 可选
  • 中国
  • 国家名称,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ province_name
  • String
  • 可选
  • 浙江省
  • 省份名称,国、省、市、区县、街道,要么全部传递编码,要么全部传递名称,每一级都得传递,除非某一级行政区划确实不存在
  • └ channel_code
  • String
  • 必须
  • tmallchaoshipm
  • 一级市场。如:tmallchaoshipm、qygMkt

响应参数

名称 类型 示例值 描述
biz_success Boolean true 执行结果
module RegionSellableItemResponse 返回主体
  • └ scroll_id
  • String
  • ABCDEFG
  • 滚动ID,仅同步响应返回,查询下一页都得带上前一页查询返回值里的 scroll_id
  • └ total_count
  • Number
  • 1
  • 总数量,仅同步响应第1页返回,其他场景不返回,返回的总数量和查询出来每页数量汇总之间可能存在差异。
  • └ response_type
  • Number
  • 1
  • 1: 同步响应 2: 异步响应
  • item_list
  • RegionItemDto []
  • 可售商品列表
  • └ item_id
  • Number
  • 123242
  • 商品ID
biz_error_message String no_service 错误信息
biz_error_code String 无错误码 错误码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAscpChannelRegionSellableItemQueryRequest req = new AlibabaAscpChannelRegionSellableItemQueryRequest();
AlibabaAscpChannelRegionSellableItemQueryRequest.RegionItemSellableQueryRequest obj1 = new AlibabaAscpChannelRegionSellableItemQueryRequest.RegionItemSellableQueryRequest();
obj1.setProvinceCode("330000");
obj1.setCityCode("330100");
obj1.setStreetCode("330110005");
obj1.setPageSize(1000L);
obj1.setSubChannelCode("tmcspm_qyg");
obj1.setScrollId("ABCDEFG");
obj1.setAreaCode("330110");
obj1.setStreetName("五常街道");
obj1.setCityName("杭州市");
obj1.setAreaName("余杭区");
obj1.setPageIndex(1L);
obj1.setCountryCode("1");
obj1.setRequestId("124");
obj1.setCountryName("中国");
obj1.setProvinceName("浙江省");
obj1.setChannelCode("tmallchaoshipm");
req.setRegionItemSellableQueryRequest(obj1);
AlibabaAscpChannelRegionSellableItemQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_ascp_channel_region_sellable_item_query_response>
    <biz_success>true</biz_success>
    <module>
        <scroll_id>ABCDEFG</scroll_id>
        <total_count>1</total_count>
        <response_type>1</response_type>
        <item_list>
            <region_item_dto>
                <item_id>123242</item_id>
            </region_item_dto>
        </item_list>
    </module>
    <biz_error_message>no_service</biz_error_message>
    <biz_error_code>无错误码</biz_error_code>
</alibaba_ascp_channel_region_sellable_item_query_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部