当前位置: API文档
vip_api_goods_query.php(查询平台货品)
1.1 接口描述:获取旺店通ERP的平台货品信息 |
1.2 适用版本:客户端 v2.4.5.0及以上版本 |
1.3 增量获取:按照平台货品的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。 |
1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。 |
1.5 注意事项:本接口不返回淘系订单数据,相关平台规则单击这里。淘系订单数据获取办法单击这里。其他平台的敏感信息会根据平台规则同步调整。 |
2.1 其他 |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/vip_api_goods_query.php |
正式环境 | https://api.wangdian.cn/openapi2/vip_api_goods_query.php |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 | |
时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版APi服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
签名 | sign | String | 是 | APi输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
开始时间 | start_time | datetime | 是 | 按最后修改时间增量查询数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss | |
结束时间 | end_time | datetime | 是 | 按最后修改时间增量查询数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss | |
分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为30,使用举例单击这里 | |
页号 | page_no | int | 否 | 页号,不传默认从0页开始 | |
店铺编号 | shop_no | varchar | 否 | 代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置,查看路径ERP→设置→基本设置→店铺→店铺列表),用于创建指定店铺单据信息,测试环境店铺编号查看测试环境分配邮件。 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 10 | 否 | 只有,page_no = 0 时才返回的符合条件的数据总条数,用来分页 |
平台商品列表节点 | goods_list[ ] | data[ ] | 是 | 响应参数的级数据节点,包含当前页的库存管理信息的数据节点,节点下数据字段详见下述“goods_list”列表 |
goods_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
表主键 | rec_id | int | 20 | 是 | 平台货品表主键 |
店铺编号 | shop_no | varchar | 255 | 是 | 代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义 |
店铺名称 | shop_name | varchar | 255 | 是 | ERP内支持自定义的店铺名称 |
平台id | platform_id | smallint | 6 | 是 | 响应值为代表平台的iD数值,数值对应的平台名称单击这里 |
平台货品id | api_goods_id | varchar | 40 | 是 | 平台货品id |
平台规格id | api_spec_id | varchar | 40 | 是 | 平台规格id |
平台货品名称 | api_goods_name | varchar | 255 | 是 | 平台货品名称 |
平台规格名称 | api_spec_name | varchar | 100 | 是 | 平台规格名称 |
最后修改时间 | modified | datetime | 是 | 表主键对应数据最后更新时间,时间格式:yyyy-MM-dd HH:mm:ss | |
api_spec_no | 无意义,可忽略 | ||||
平台货品编码 | outer_id | varchar | 40 | 是 | 平台货品编码,举例:淘宝商家后台一级商家编码 |
平台规格编码 | spec_outer_id | varchar | 40 | 是 | 平台规格编码,举例:淘宝商家后台二级商家编码 |
平台库存 | stock_num | decimal | 19,4 | 是 | 平台单品(sku)库存 |
价格 | price | decimal | 19,4 | 是 | 平台零售价 |
类目 | cid | varchar | 255 | 是 | 平台类目 |
图片链接 | pic_url | varchar | 255 | 是 | 图片链接 |
店铺id | shop_id | smallint | 6 | 是 | 店铺列表主键 |
平台规格码 | spec_code | varchar | 40 | 是 | 平台规格编码 |
平台sku属性串 | spec_sku_properties | varchar | 1024 | 是 | 平台sku属性串,如 1627207:3232483;1630696:3284570' |
条码 | barcode | varchar | 255 | 是 | 平台上的条码,多个条码用逗号分隔 |
匹配编码 | match_code | varchar | 40 | 是 | 如果是根据商家编码自动匹配的,那么这个字段记录了商家编码,可以是货品的编码+规格的编码 |
品牌id | brand_id | varchar | 11 | 是 | 品牌ID |
外部编码 | outer_code | varchar | 100 | 是 | outder_id,outer_spec_id计算出来的 |
创建时间 | created | datetime | 是 | 创建时间 时间格式:yyyy-MM-dd HH:mm:ss | |
是否手动匹配 | is_manual_match | tinyint | 1 | 是 | 0 自动匹配 1 手动匹配 2 绑定到菜鸟联盟 |
分类 | class_id_path | varchar | 255 | 是 | 分类 |
同步规则策略id | stock_syn_rule_id | varchar | 11 | 是 | 在此映射记录上起作用的同步规则策略id,0表示手工设置的个性化策略,-1表示没有任何匹配上任何库存同步规则 |
同步规则策略编号 | stock_syn_rule_no | varchar | 40 | 是 | 在此映射记录上起作用的同步规则策略编号 |
库存计算方法的掩码 | stock_syn_mask | varchar | 11 | 是 | 库存计算方法的掩码 |
同步百分比 | stock_syn_percent | varchar | 11 | 是 | 同步百分比 |
百分比附加值 | stock_syn_plus | decimal | 19,4 | 是 | 百分比附加值 |
最小同步库存量 | stock_syn_min | decimal | 19,4 | 是 | 最小同步库存量 |
是否停止库存同步 | is_disable_syn | tinyint | 1 | 是 | 停止库存同步 |
后台信息同步库存 | disable_syn_until | varchar | 11 | 是 | 后台信息同步库存,直接到达这个时间(unix timestamp) |
停止同步原因 | disabled_reason | varchar | 255 | 是 | 停止同步原因 |
最后同步库存量 | last_syn_num | decimal | 19,4 | 是 | 最后同步库存量 |
最后同步时间 | last_syn_time | datetime | 是 | 最后同步时间,时间格式:yyyy-MM-dd HH:mm:ss | |
定时上架时间 | list_time | datetime | 是 | 定时上架时间,时间格式:yyyy-MM-dd HH:mm:ss | |
定时下架时间 | delist_time | datetime | 是 | 定时下架时间,时间格式:yyyy-MM-dd HH:mm:ss | |
库存是否发生变化 | is_stock_changed | tinyint | 1 | 是 | 最后一次库存同步后,库存有没发生变化 |
库存变化时自增量 | stock_change_count | varchar | 11 | 是 | 库存变化时自增 |
是否更新 | is_update | tinyint | 1 | 是 | 是否刚刚更新过此记录 |
修改标记 | modify_flag | varchar | 11 | 是 | 修改标记,商家编码变化,值为1 |
标记id | flag_id | varchar | 11 | 是 | 手动修改的标记 |
掩码 | mask | varchar | 11 | 是 | '掩码,1临时延时 2组合装同步多仓库总库存计算的虚拟值 4多仓库存同步 |
最大同步库存 | stock_syn_max | varchar | 11 | 是 | 最大同步库存 |
阿里巴巴区别1688|lst | reserve_s | varchar | 50 | 是 | 阿里巴巴区别1688|lst |
活动状态 | is_deleted | tinyint | 1 | 是 | 是否已经删除,status的一个备份 ,返回0正常货品,1平台删除,2手动删除 |
占用库存 | hold_stock | int | 11 | 是 | 按照平台扣减库存方式,占用的库存量 |
占用方式 | hold_stock_type | tinyint | 1 | 是 | 平台扣减库存方式:1拍下减库存 ,2付款减库存 |
自动上架 | is_auto_listing | tinyint | 1 | 是 | 是否自动上架,返回值0否,1是 |
自动下架 | is_auto_delisting | tinyint | 1 | 是 | 是否自动上架,返回值0否,1是 |
状态 | status | tinyint | 1 | 是 | 平台货品状态:'0删除 1在架 2下架', |
匹配类型 | match_target_type | tinyint | 1 | 是 | 返回值:0未匹配, 1匹配单品商家编码,2匹配组合装商家编码 |
系统商家编码 | merchant_no | varchar | 255 | 是 | match_target_type=1时返回的为单品商家编码、match_target_type=2时返回的为组合装商家编码 |
系统商家编码主键 | match_target_id | varchar | 255 | 是 | match_target_type=1时返回的为单品商家编码id、match_target_type=2时返回的为组合装商家编码id |
系统货品名称 | merchant_name | varchar | 255 | 是 | match_target_type=1时返回的为单品货品名称、match_target_type=2时返回的为组合装货品名称 |
系统规格名称 | merchant_code | varchar | 255 | 是 | match_target_type=1时返回的为单品规格名称、match_target_type=2时返回为“空” |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": 2104, "message": "start_time与end_time时间跨度不能超过最大范围 30天" } |