Skip to content

查询商品列表2.0

拥有此API的权限集
商品管理-查询

请求方式及url

  • 请求方式:POST
  • 请求头:Content-Type:application/json
  • 接口地址:https://api.xiaoe-tech.com/xe.goods.list.get/4.0.0
  • 频率限制:10秒3000次

接口调试

请求参数
响应结果
暂无响应数据

请求参数

参数名必选类型说明
access_tokenstring专属token
pageint分页,默认第一页
page_sizeint页数 默认10条,最大100,超过100默认返回100条
goods_namestring商品名称(支持模糊)
resource_typeint资源类型 :1-图文,2-音频,3-视频,4-直播,5-会员,6-专栏,7-圈子,8-大专栏,9-活动管理,16-付费打卡,20-电子书,21-实物商品,23-超级会员,25-训练营营期,29-线下课,31-小班课,34-练习,35-班课,37-大班课,41-有价优惠券,42-课时包,45-AI互动课,46-付费问答,47-付费问答-答主,50-课程(训练营pro)
has_distributeint是否参与推广0-未参与 1-参与 不传默认返回所有数据
sale_statusint上架状态1上架 0下架 2待上架 3-上架+待上架 不传默认返回所有数据
is_return_deletedint是否删除 0正常 1已删除 不传默认返回所有数据
is_return_forbidint商品是否被封禁:0 = 否,1 = 是 不传默认返回所有数据
is_return_stop_sellint是否停售:0否 1是 不传默认返回所有数据
is_return_sell_typeint售卖方式:1 = 独立售卖,2 = 关联售卖(商品放入专栏/会员/训练营中售卖) 不传默认返回所有数据
is_return_displayint是否显示:0否(隐藏状态) 1是(显示状态) 不传默认返回所有数据
is_return_sell_modearray售卖类型(1-自营 2-内容市场 3-课程商品) 不传默认返回所有数据
is_return_zero_priceint是否返回0元商品:0否 1是 不传默认返回所有价格包括0元的商品
is_return_passwordint是否加密(0-不加密 1--加密) 不传默认返回所有商品
is_return_publicint是否公开售卖(0-不公开 1-公开) 不传默认返回所有商品
start_timestring创建开始时间筛选start_time传了则end_time必填包含等于时间范围查询不能超过15天,时间格式YYYY-mm-dd H:i:s
end_timestring创建结束时间筛选end_time传了则start_time必填包含等于时间范围查询不能超过15天,时间格式YYYY-mm-dd H:i:s

请求示例

{
    "resource_type":"21",
    "access_token":"xe_xxxxx",
    "page":1,
    "page_size":10
}

返回参数

参数名类型说明备注
codeint状态码0为请求成功,其它为请求失败
msgstring请求状态描述信息
data.current_pageint当前页数
data.listarray商品列表

data.list商品列表

参数名类型说明备注
app_idstring店铺ID
idintid
resource_idstring资源id(唯一值)
spu_idstring统一商品id
spu_typestring统一商品类型
goods_category_idstring商品分类id
goods_namestring商品名称
goods_imgarray商品封面图(默认封面图)
custom_coverstring主图视频自定义封面
sell_typeint付费类型付费类型:1 = 独立售卖,2 = 关联售卖
price_lowint商品最低价(取自sku中最低价值)单位:分
price_highint商品高价(取自最低价所在sku对应划线价)单位:分
price_lineint划线价(取值price_low所在sku划线价)单位:分
visit_numint访问量
goods_tagstring商品标签
goods_tag_is_showint商品标签是否展示0:不展示;1:展示
sale_statusint上架状态0下架 1上架 2待上架
is_timing_saleint是否定时上架1是 0否
timing_salestring定时上架时间
sale_atstring上架的时间
has_distributeint是否参与推广分销0 = 否,1 = 是
video_img_urlstring主图视频封面url
is_goods_packageint是否带货0 否 1 是
is_displayint是否显示0否(隐藏状态) 1是(显示状态)
is_stop_sellint是否停售0否 1是
is_forbidint商品是否被封禁0 = 否,1 = 是
is_ignoreint商品是否被忽略0 = 否,1 = 是
limit_purchaseint限购数量
stock_deduct_modeint扣库存方式0付款减库存 1拍下减库存
appraise_numint评价数
show_stockint是否展示库存0-不展示 1-展示
is_bestint是否精品0否 1是
is_hotint是否热销产品0否 1是
is_newint是否新品0否 1是
is_recomint是否推荐0否 1是
distribution_patternint配送方式
freightint运费(单位:分)
audit_reasonstring审核原因
audit_timestring审核时间
audit_user_idstring审核人user_id
spu_extendstring业务侧扩展字段
parent_spu_idstring父级的spu_id
parent_app_idstring父级的app_id
is_uniform_freightint是否是统一运费1:统一运费 2:运费模板
freight_template_idint运费模板ID
img_url_compressedstring压缩后的列表配图url
is_deletedint是否删除0正常 1已删除
created_atstring创建时间
updated_atstring更新时间
attrarray属性信息
extendarray扩展
extend[0].sell_numint售卖数量
totalint总数

返回示例

{
    "code": 0,
    "data": {
        "current_page": 1,
        "list": [
            {
                "app_id": "apppcHqlTPT3482",
                "appraise_num": 0,
                "audit_reason": "",
                "audit_time": "0000-00-00 00:00:00",
                "audit_user_id": null,
                "attr": [],
                "can_sold_end": "0000-00-00 00:00:00",
                "can_sold_start": "0000-00-00 00:00:00",
                "created_at": "2022-05-31 18:48:10",
                "custom_cover": "",
                "distribution_pattern": 1,
                "extend": [],
                "freight": 0,
                "freight_template_id": 0,
                "goods_category_id": "",
                "goods_img": [
                    "https://wechatapppro-1252524126.file.myqcloud.com/apppcHqlTPT3482/image/b_u_5b73e35149a67_ypMtbWtO/kvw18b1x0vfo.jpg"
                ],
                "goods_name": "有价优惠券外部码库值测试",
                "goods_tag": "有价优惠券",
                "goods_tag_is_show": 1,
                "has_distribute": 0,
                "id": 72896,
                "img_url_compressed": "https://wechatapppro-1252524126.file.myqcloud.com/apppcHqlTPT3482/image/b_u_5b73e35149a67_ypMtbWtO/kvw18b1x0vfo.jpg",
                "is_best": 0,
                "is_deleted": 0,
                "is_display": 1,
                "is_forbid": 0,
                "is_free": 0,
                "is_goods_package": 0,
                "is_hot": 0,
                "is_ignore": 0,
                "is_new": 0,
                "is_password": 0,
                "is_public": 1,
                "is_recom": 0,
                "is_single": 1,
                "is_stop_sell": 0,
                "is_timing_sale": 0,
                "is_uniform_freight": 1,
                "limit_purchase": 0,
                "parent_app_id": "",
                "parent_spu_id": "",
                "period": -1,
                "period_type": 0,
                "period_value": "",
                "price_high": 300,
                "price_line": 0,
                "price_low": 300,
                "pv": 0,
                "resource_id": "g_61a4a307a6344_DfOA1bCn",
                "resource_type": 41,
                "sale_at": "2021-11-29 17:53:12",
                "sale_status": 1,
                "sell_mode": 1,
                "sell_type": 1,
                "show_stock": 1,
                "spu_extend": "",
                "spu_id": "g_61a4a307a6344_DfOA1bCn",
                "spu_type": "VCP",
                "stock_deduct_mode": 0,
                "timing_sale": "",
                "updated_at": "0000-00-00 00:00:00",
                "uv": 0,
                "video_img_url": "",
                "visit_num": 0,
                "wx_goods_category_id": ""
            }
        ],
        "total": 46598
    },
    "msg": "success"
}