当前位置: API文档

vip_api_goods_query.php(查询平台货品)

¥增值

1.接口说明

   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.调用场景

   2.1 其他

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境https://sandbox.wangdian.cn/openapi2/vip_api_goods_query.php
正式环境https://api.wangdian.cn/openapi2/vip_api_goods_query.php

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
本开放平台“自助对接”功能模块内自助申请,获取方式点击这里
时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版APi服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
APi输入参数签名结果,签名算法介绍单击这里

   3.3 业务请求参数

名称字段类型长度
必须描述
开始时间start_timedatetime
按最后修改时间增量查询数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss
结束时间end_timedatetime
按最后修改时间增量查询数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss
分页大小page_sizeint
每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为30,使用举例单击这里
页号page_noint

页号,不传默认从0页开始
店铺编号shop_novarchar

代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置,查看路径ERP→设置→基本设置→店铺→店铺列表),用于创建指定店铺单据信息,测试环境店铺编号查看测试环境分配邮件。

4.响应参数

   4.1 公共响应参数

名称字段类型长度必须描述
错误码codeint40状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint10只有,page_no = 0 时才返回的符合条件的数据总条数,用来分页
平台商品列表节点goods_list[ ]data[ ]
响应参数的级数据节点,包含当前页的库存管理信息的数据节点,节点下数据字段详见下述“goods_list”列表

   4.2 业务响应参数

goods_list

名称字段类型长度
必须描述
表主键
rec_idint
20

平台货品表主键
店铺编号shop_novarchar255
代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义
店铺名称shop_namevarchar255
ERP内支持自定义的店铺名称
平台idplatform_idsmallint6
响应值为代表平台的iD数值,数值对应的平台名称单击这里
平台货品idapi_goods_idvarchar40
平台货品id
平台规格idapi_spec_id
varchar40
平台规格id
平台货品名称api_goods_namevarchar255
平台货品名称
平台规格名称api_spec_namevarchar100
平台规格名称
最后修改时间modifieddatetime
表主键对应数据最后更新时间,时间格式:yyyy-MM-dd HH:mm:ss

api_spec_no


无意义,可忽略
平台货品编码outer_idvarchar40
平台货品编码,举例:淘宝商家后台一级商家编码
平台规格编码spec_outer_idvarchar40
平台规格编码,举例:淘宝商家后台二级商家编码
平台库存stock_numdecimal19,4平台单品(sku)库存
价格
pricedecimal19,4平台零售价
类目cidvarchar255平台类目
图片链接pic_urlvarchar255图片链接
店铺idshop_idsmallint6店铺列表主键
平台规格码spec_codevarchar40平台规格编码
平台sku属性串spec_sku_propertiesvarchar1024平台sku属性串,如 1627207:3232483;1630696:3284570'
条码barcodevarchar255平台上的条码,多个条码用逗号分隔
匹配编码match_codevarchar40如果是根据商家编码自动匹配的,那么这个字段记录了商家编码,可以是货品的编码+规格的编码
品牌idbrand_idvarchar11品牌ID
外部编码outer_code varchar100outder_id,outer_spec_id计算出来的
创建时间createddatetime
创建时间   时间格式:yyyy-MM-dd HH:mm:ss
是否手动匹配is_manual_matchtinyint10  自动匹配 1 手动匹配 2 绑定到菜鸟联盟
分类class_id_pathvarchar255分类
同步规则策略idstock_syn_rule_idvarchar11在此映射记录上起作用的同步规则策略id,0表示手工设置的个性化策略,-1表示没有任何匹配上任何库存同步规则
同步规则策略编号stock_syn_rule_novarchar40在此映射记录上起作用的同步规则策略编号
库存计算方法的掩码stock_syn_maskvarchar11库存计算方法的掩码
同步百分比stock_syn_percentvarchar11
同步百分比
百分比附加值stock_syn_plusdecimal19,4 百分比附加值
最小同步库存量stock_syn_mindecimal19,4最小同步库存量
是否停止库存同步
is_disable_syntinyint1停止库存同步
后台信息同步库存disable_syn_untilvarchar11后台信息同步库存,直接到达这个时间(unix timestamp)
停止同步原因disabled_reasonvarchar255停止同步原因
最后同步库存量last_syn_numdecimal19,4最后同步库存量
最后同步时间last_syn_timedatetime 
最后同步时间,时间格式:yyyy-MM-dd HH:mm:ss
定时上架时间list_timedatetime 
定时上架时间,时间格式:yyyy-MM-dd HH:mm:ss
定时下架时间delist_timedatetime 
定时下架时间,时间格式:yyyy-MM-dd HH:mm:ss
库存是否发生变化
is_stock_changedtinyint1
最后一次库存同步后,库存有没发生变化
库存变化时自增量stock_change_countvarchar11
库存变化时自增
是否更新is_updatetinyint1
是否刚刚更新过此记录
修改标记modify_flagvarchar11
修改标记,商家编码变化,值为1
标记idflag_idvarchar11
手动修改的标记
掩码mask varchar11
'掩码,1临时延时 2组合装同步多仓库总库存计算的虚拟值 4多仓库存同步
最大同步库存stock_syn_maxvarchar11
最大同步库存
阿里巴巴区别1688|lstreserve_s varchar50
阿里巴巴区别1688|lst
活动状态is_deletedtinyint1
是否已经删除,status的一个备份 ,返回0正常货品,1平台删除,2手动删除
占用库存hold_stockint11
按照平台扣减库存方式,占用的库存量
占用方式hold_stock_typetinyint1
平台扣减库存方式:1拍下减库存 ,2付款减库存
自动上架
is_auto_listingtinyint1
是否自动上架,返回值0否,1是
自动下架is_auto_delistingtinyint1
是否自动上架,返回值0否,1是
状态
statustinyint1
平台货品状态:'0删除 1在架 2下架',
匹配类型match_target_typetinyint1
返回值:0未匹配, 1匹配单品商家编码,2匹配组合装商家编码
系统商家编码

merchant_no

varchar255
match_target_type=1时返回的为单品商家编码、match_target_type=2时返回的为组合装商家编码
系统商家编码主键match_target_idvarchar255
match_target_type=1时返回的为单品商家编码id、match_target_type=2时返回的为组合装商家编码id
系统货品名称merchant_namevarchar255match_target_type=1时返回的为单品货品名称、match_target_type=2时返回的为组合装货品名称
系统规格名称merchant_codevarchar255match_target_type=1时返回的为单品规格名称、match_target_type=2时返回为“空”

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = 'apidevnew2';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2_dev/vip_api_goods_query.php';

    //添加查询参数
    $c->putApiParam('start_time','2019-01-01 00:00:00');
    $c->putApiParam('end_time','2019-01-30 00:00:00');
    $c->putApiParam('shop_no','manmao2test');
    $c->putApiParam('page_no', '0');
    $c->putApiParam('page_size','10');
    $json = $c->wdtOpenApi();
    var_dump($json);
    
?>
JAvA
package com.wangdian.api.vip;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.alibaba.fastjson.JSON;
import com.wangdian.api.WdtClient;
public class VipApiGoodsQuery {

    public static void main(String[] args) {
        WdtClient client = new WdtClient("传入sid", "传入appkey", "传入appsecret", "传入url");
        //测试环境sid、appkey、密钥请到旺店通开放平台-自助对接-申请测试环境内查看,测试环境url=https://sandbox.wangdian.cn/openapi2/
        //调用正式环境时请将sid、appkey、appsecret切换为实际参数,参数在旺店通开放平台-自助对接-应用管理内应用状态为已上线的应用中查看,调用正式环境注意切换正式环境url=https://api.wangdian.cn/openapi2/
        
        Map<String, String> params = new HashMap<String, String>();
        params.put("start_time", "2019-01-01 00:00:00");
        params.put("end_time", "2019-01-30 00:00:00");
        params.put("page_no", "0");
        params.put("page_size", "10");
        params.put("shop_no", "manmao2test");        try {
            String response = client.execute("vip_api_goods_query.php", params);
            System.out.println(response);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;
namespace VipApiGoodsQuery
{
    class VipApiGoodsQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/vip_api_goods_query.php";
            client.putParams("start_time", "2019-01-01 00:00:00");
            client.putParams("end_time", "2019-01-30 00:00:00");
            client.putParams("shop_no", "manmao2test");
            client.putParams("page_no", "0");
            client.putParams("page_size", "10");
            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}
python
import WdtClient

t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/')
params = {}
params.update({"start_time": '2021-01-01 00:00:00'})
params.update({"end_time": '2021-01-01 00:59:59'})
params.update({"page_size": '100'})
params.update({"page_no": '0'})

response = t.execute("vip_api_goods_query.php", params)
print(response)

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "ok",
    "total_count": "210",
    "goods_list": [{
        "rec_id": "17",
        "shop_no": "manmao2test",
        "shop_name": "manmao2test",
        "platform_id": "127",
        "match_target_id": "4",
        "match_target_type": "1",
        "api_goods_id": "0000",
        "api_spec_id": "0000",
        "api_goods_name": "测试用例0",
        "api_spec_name": "5474",
        "modified": "2019-01-03 17:29:34",
        "api_spec_no": "",
        "outer_id": "11",
        "spec_outer_id": "qqq",
        "stock_num": "496.0000",
        "price": "20.0000",
        "cid": "",
        "pic_url": "",
        "is_deleted": "2",
        "hold_stock": "0.0000",
        "hold_stock_type": "0",
        "is_auto_listing": "1",
        "is_auto_delisting": "1",
        "status": "1",
        "merchant_no": "qqq",
        "merchant_name": "5474",
        "merchant_code": "dfd"
    }, {
        "rec_id": "18",
        "shop_no": "manmao2test",
        "shop_name": "manmao2test",
        "platform_id": "127",
        "match_target_id": "4",
        "match_target_type": "1",
        "api_goods_id": "0001",
        "api_spec_id": "0001",
        "api_goods_name": "测试用例1",
        "api_spec_name": "5474",
        "modified": "2019-01-03 17:29:34",
        "api_spec_no": "",
        "outer_id": "11",
        "spec_outer_id": "qqq",
        "stock_num": "496.0000",
        "price": "20.0000",
        "cid": "",
        "pic_url": "",
        "is_deleted": "2",
        "hold_stock": "0.0000",
        "hold_stock_type": "0",
        "is_auto_listing": "1",
        "is_auto_delisting": "1",
        "status": "1",
        "merchant_no": "qqq",
        "merchant_name": "5474",
        "merchant_code": "dfd"
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 2104,
    "message": "start_time与end_time时间跨度不能超过最大范围 30天"
}



常用工具