当前位置: API文档

goods_query.php(查询货品档案)

¥标准

1.接口说明

   1.1 接口描述:获取ERP的货品档案资料,“货品档案”其他系统称为“物料档案”“商品档案”等
   1.2 适用版本:客户端 V2.4.0.5及以上版本
   1.3 增量获取:按照ERP内货品档案最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件,返回的结果不包含在ERP货品档案已停用的货品数据。
   1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。
   1.4 注意事项:本接口如果不传start_time和end_time,则spec_no和goods_no必须传一个;当请求参数传了spec_no和goods_no其中一个或者两个都传了的时候,start_time和end_time不生效。

2.调用场景

2.1 自研商城、SCM、SRM、财务系统、SAP等系统的对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://sandbox.wangdian.cn/openapi2/goods_query.php
正式环境http://api.wangdian.cn/openapi2/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 业务请求参数

名称字段类型长度
必须描述
商家编码spec_novarchar40代表单品(SKU)所有属性的唯一编码,用于获取指定的系统单品的数据,SKU概念介绍,单击这里
货品编号goods_novarchar40代表货品(SPU)所有属性的唯一编号,用于指定获取系统货品的数据,SPU概念介绍,单击这里
品牌编号brand_novarchar32品牌编号
分类名称class_namevarchar32类别名称
条码barcodevarchar64条码
开始时间start_timedatetime
按最后修改时间增量查询数据,start_time作为开始时间,格式:YYYY-MM-DD HH:MM:SS
结束时间end_timedatetime
按最后修改时间增量查询数据,end_time作为结束时间,格式:YYYY-MM-DD HH:MM:SS
分页大小page_sizeint
每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里
页号page_noint
页号,不传默认从0页开始

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
错误码codeint11状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint11符合条件的数据条数,用来分页 当page_no = 0时返回
货品节点goods_listdata[]
响应参数的1级数据节点,包含SPU所有属性信息的数据节点,节点下数据字段详见下述“goods_list”和"spec_list"

   4.2 业务响应参数

    goods_list

名称字段类型长度
必须描述
货品IDgoods_idint11货品表主键
货品编号goods_novarchar40代表SPU所有属性的唯一编号,用于系统货品的区分,SPU概念介绍,单击这里
货品名称goods_namevarchar255货品名称
简称short_namevarchar255简称
货品别名aliasvarchar255货品别名
货品类别goods_typetinyint1货品类别  0:其它, 1:销售货品, 2:原材料, 3:包装物, 4:周转材料, 5:虚拟商品, 6:固定资产,7:保修配件
规格数spec_countint11规格数
拼音pinyinvarchar40拼音
品牌编号brand_novarchar32品牌编号
品牌brand_namevarchar64品牌名称
备注remarkvarchar512备注
自定义属性1prop1varchar255自定义属性1
自定义属性2prop2varchar255自定义属性2
自定义属性3prop3varchar255自定义属性3
自定义属性4prop4varchar255自定义属性4
自定义属性5prop5varchar255自定义属性5
自定义属性6prop6varchar255自定义属性6
产地originvarchar64产地
分类class_namevarchar64分类名称
基本单位unit_namevarchar20基本单位名称
辅助单位aux_unit_namevarchar20辅助单位名称
标记名称flag_namevarchar32标记名称
创建时间goods_createddatetime
格式:YYYY-MM-DD HH:MM:SS。ERP客户端需升级至V2.3.8.6及以上版本可获取此字段
最后修改时间goods_modifieddatetime
格式:YYYY-MM-DD HH:MM:SS
单品节点spec_listdata[]
响应参数的2级数据节点,包含sku所有属性信息的数据节点,节点下数据字段详见下述"spec_list"

    spec_list

名称字段类型长度
必须描述
规格IDspec_idvarchar40规格ID
商家编码spec_novarchar40代表单品(SKU)所有属性的唯一编号,用于系统单品的区分,SKU概念介绍,单击这里
规格码spec_codevarchar40规格码
主条码barcodevarchar50主条码
规格名称spec_namevarchar100规格名称
货品IDgoods_idint11货品ID
最低价lowest_pricedecimal19,4最低价
零售价retail_pricedecimal19,4零售价
批发价wholesale_pricedecimal19,4批发价
会员价member_pricedecimal19,4会员价
市场价market_pricedecimal19,4市场价
自定义价格1custom_price1decimal19,4自定义价格1
自定义价格2custom_price2decimal19,4自定义价格2
销售积分sale_scoreint11销售积分
打包积分pack_scoreint11打包积分
拣货积分pick_scoreint11拣货积分
有效期天数validity_daysint11保质期
最佳销售天数sales_daysint11最佳销售天数
最佳收获天数receive_daysint11最佳收获天数
重量weightdecimal19,4重量
lengthdecimal19,4长(CM)
widthdecimal19,4宽(CM)
heightdecimal19,4高(CM)
启用序列号is_sn_enabletinyint40不启用序列号 1强序列号 2弱序列号
是否允许负库存is_allow_neg_stocktinyint10(不允许负库存);1(允许负库存)
是否出库不验货is_not_need_examinetinyint10(出库不验货);1(出库必须验货)
是否允许0成本is_zero_costtinyint10(不允许0成本);1(允许0成本)
是否允许低于成本价is_lower_costtinyint10(不允许低于成本价);1(允许低于成本价)
是否航空禁运is_not_use_airtinyint10(航空不禁运) 1(航空禁运);
税率tax_ratedecimal8,4税率
大件类别large_typetinyint10非大件1普通大件2独立大件
备注remarkvarchar512备注
创建时间spec_createddatetime
格式:YYYY-MM-DD HH:MM:SS。ERP客户端需升级至V2.3.8.6及以上版本可获取此字段
最后修改时间spec_modifieddatetime
格式:YYYY-MM-DD HH:MM:SS
自定义1prop1varchar255自定义1
自定义2prop2varchar255自定义2
自定义3prop3varchar255自定义3
自定义4prop4varchar255自定义4
自定义5prop5varchar255自定义5
自定义6prop6varchar255自定义6
图片img_urlvarchar1024图片url
基本单位spec_unit_namevarchar20基本单位名称
辅助单位spec_aux_unit_namevarchar20辅助单位名称

5.请求示例

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

    //添加查询参数
    $c->putApiParam('start_time','2018-08-01 00:00:00');
    $c->putApiParam('end_time','2018-08-11 00:00:00');
    $json = $c->wdtOpenApi();
    var_dump($json);
    
?>
JAVA
package com.wangdian.api.goods;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.wangdian.api.WdtClient;

public class GoodsQuery {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        WdtClient client = new WdtClient("", "", "", "");
        Map<String, String> params = new HashMap<String, String>();
        params.put("start_time", "2018-12-01 00:00:00");
        params.put("end_time", "2018-12-06 00:00:00");
        try {
            String response = client.execute("goods_query.php", params);
            System.out.println(response);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;

namespace GoodsQuery
{
    class GoodsQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/goods_query.php";
            client.putParams("start_time", "2018-08-01 00:00:00");
            client.putParams("end_time", "2018-08-11 00:00:00");
            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": "0",
    "message": "",
    "total_count": "1",
    "goods_list": [{
        "goods_id": "1",
        "goods_no": "WDTPDA",
        "goods_name": "旺店通手持终端",
        "short_name": "",
        "alias": "",
        "goods_type": "1",
        "spec_count": "2",
        "pinyin": "",
        "brand_no": "BD201811230002",
        "brand_name": "旺店通",
        "remark": "",
        "prop1": "",
        "prop2": "",
        "prop3": "",
        "prop4": "",
        "prop5": "",
        "prop6": "",
        "origin": "",
        "class_name": "PDA",
        "class_id": "5",
        "unit_name": null,
        "aux_unit_name": null,
        "flag_name": null,
        "goods_created": "2018-11-23 13:53:07",
        "goods_modified": "2019-01-25 22:58:10",
        "spec_list": [{
            "spec_id": "1",
            "goods_id": "1",
            "spec_no": "WDTPDA-BLACK006",
            "spec_code": "BLACK006",
            "barcode": "WDTPDA-BLACK006",
            "spec_name": "旺店通手持终端黑色006型",
            "lowest_price": "1.0000",
            "retail_price": "1.0000",
            "wholesale_price": "1.0000",
            "member_price": "1.0000",
            "market_price": "1.0000",
            "custom_price1": "0.0000",
            "custom_price2": "0.0000",
            "sale_score": "1",
            "pack_score": "1",
            "pick_score": "2",
            "validity_days": "0",
            "sales_days": "0",
            "receive_days": "0",
            "weight": "0.0000",
            "length": "0.0000",
            "width": "0.0000",
            "height": "0.0000",
            "is_sn_enable": "0",
            "is_allow_neg_stock": "1",
            "is_not_need_examine": "0",
            "is_zero_cost": "1",
            "is_lower_cost": "0",
            "is_not_use_air": "0",
            "tax_rate": "0.0000",
            "large_type": "0",
            "remark": "",
            "spec_created": "2018-11-23 13:53:07",
            "spec_modified": "2019-05-15 16:12:56",
            "prop1": "",
            "prop2": "",
            "prop3": "",
            "prop4": "",
            "prop5": "",
            "prop6": "",
            "img_url": "http://www.h27.com/static/uploadfile/file/2019-01-25/5c4ad08885932.jpg",
            "spec_aux_unit_name": null,
            "spec_unit_name": null
        }, {
            "spec_id": "21453",
            "goods_id": "1",
            "spec_no": "WDTPDA-BLACK007",
            "spec_code": "BLACK007",
            "barcode": "WDTPDA-BLACK007",
            "spec_name": "旺店通手持终端黑色007型",
            "lowest_price": "2399.0000",
            "retail_price": "2699.0000",
            "wholesale_price": "1999.0000",
            "member_price": "2699.0000",
            "market_price": "2699.0000",
            "custom_price1": "0.0000",
            "custom_price2": "0.0000",
            "sale_score": "1",
            "pack_score": "1",
            "pick_score": "2",
            "validity_days": "0",
            "sales_days": "0",
            "receive_days": "0",
            "weight": "0.0000",
            "length": "0.0000",
            "width": "0.0000",
            "height": "0.0000",
            "is_sn_enable": "0",
            "is_allow_neg_stock": "1",
            "is_not_need_examine": "0",
            "is_zero_cost": "1",
            "is_lower_cost": "0",
            "is_not_use_air": "0",
            "tax_rate": "0.0000",
            "large_type": "0",
            "remark": "",
            "spec_created": "2018-12-22 13:25:40",
            "spec_modified": "2019-05-15 16:12:56",
            "prop1": "",
            "prop2": "",
            "prop3": "",
            "prop4": "",
            "prop5": "",
            "prop6": "",
            "img_url": "http://baidu.com",
            "spec_aux_unit_name": null,
            "spec_unit_name": null
        }]
    }]
}

   6.2 异常响应示例

JSON
{
    "code": "20",
    "message": "请求范围过宽,请增加请求参数条件过滤"
}



常用工具