API文档

vip_stock_outside_wms_query.php（查询委外出入库单）

1.接口说明

1.1 接口描述：获取委外出入库单及货品明细数据

1.2 适用版本：客户端 V2.4.5.6及以上版本

1.3 增量获取：按照旺店通ERP各业务类型入库单的最后修改时间增量获取数据，请求时输入start_time和end_time作为时间跨度的筛选条件。

1.4 时间跨度：start_time和end_time最大跨度为30天，开始时间和结束时间取值范围为闭区间取值，例如2018-11-01 00:00:00至2018-11-30 23:59:59，建议根据获取数据量的多少适当减小时间跨度。

2.调用场景

2.1 数据分析、SAP、财务系统等系统对接

3.请求参数说明

3.1 请求地址

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

3.2 公共请求参数

名称	字段	类型	必须	描述
卖家账号	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输入参数签名结果，签名算法介绍单击这里

3.3 业务请求参数

名称	字段	类型	长度	必须	描述
仓库编号	warehouse_no	varchar	40	否	代表仓库所有属性的唯一编码，用于仓库区分，ERP内支持自定义（ERP仓库界面设置），用于获取指定仓库单据信息(不支持一次推送多个仓库编号)
单据状态	status	int	4	否	可选值：10 取消 20编辑中 30待审核 40待推送 50推送失败 60待出库 65待入库 70 部分出库 75部分入库 80 已完成（该字段需和order_type共同使用）
出入类别	order_type	int	4	否	可选值：1（出库），2（入库）（默认为1）
外部单号	outer_no	varchar	40	否	外部单号
接口外部单号	api_outer_no	varchar	40	否	“vip_wms_stockinout_order_push.php（创建委外出入库单）”创建单据时推送过来的外部系统唯一标识编号。
委外单号	order_no	varchar	40	否	创建委外出入库单成功后系统生产的单号，示例“WK201905280002”，通过“vip_wms_stockinout_order_push.php”创建委外出入库单成功后响应参数会返回此单号
开始时间	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	10	否	每页返回数据条数，参数输入值范围1~100，不传此参数默认page_size=40，使用举例单击这里
页号	page_no	int	10	否	不传值默认从0页开始

4.响应参数

4.1 公共响应参数

名称	字段	类型	长度	必须	描述
错误码	code	int	11	是	状态码:0表示成功,其他表示失败
错误描述	message	varchar	255	是	错误描述
数据条数	total_count	int	10	否	符合条件的数据条数，用来分页当page_no = 0时返回
出库单列表节点	order_list	data[ ]		否	响应参数的1级数据节点，包含当前页的JIT出库单及其明细的数据节点,节点下数据字段详见下述“stockout_list”和" details_list"

4.2 业务响应参数

order_list

名称	字段	类型	长度	必须	描述
单据主键id	order_id	int	11	是	单据主键id
委外单号	order_no	varchar	40	是	委外单号，默认WK开头
仓库编号	warehouse_no	varchar	40	是	代表仓库所有属性的唯一编码，用于仓库区分，ERP内支持自定义（ERP仓库界面设置)
国家	receiver_country	smallint	6	是	国家
便签条数	note_count	smallint	6	是	便签条数
单据状态	status	tinyint	4	是	状态：10 取消 20编辑中 30待审核 40待推送 50推送失败 60待出库 65待入库 70 部分出库 75部分入库 80 已完成
处理状态	wms_status	tinyint	4	是	状态：0 待处理,1 处理失败,2 处理成功,3 客户端处理中,4 服务器处理中
推送信息	error_info	varchar	255	是	推送信息
制单人id	operator_id	int	11	是	制单人id
审核人id	check_operator_id	int	11	是	审核人id
仓库id	warehouse_id	int	11	是	仓库id
仓库类型	warehouse_type	tinyint	4	是	仓库类型
运输模式	transport_mode	tinyint	4	是	运输模式：0.到仓自提，1.快递，2.干线物流
物流公司id	logistics_id	int	11	是	物流公司id
物流费用	logistics_fee	decimal	(19,4)	是	物流费用
创建时间	created	datetime	datetime	是	创建时间，格式：yyyy-MM-dd HH:mm:ss
备注	remark	varchar	255	是	备注
单据类别	order_type	tinyint	4	是	单据类别：1.委外出库单 2.委外入库单
其他费用	other_fee	decimal	(19,4)	是	其他费用
货品数量	goods_count	decimal	(19,4)	是	货品数量
货品种类数	goods_type_count	decimal	(19,4)	是	货品种类数
实际数量	goods_real_count	decimal	(19,4)	是	实际数量
审核时间	check_time	datetime	datetime	是	审核时间，格式：yyyy-MM-dd HH:mm:ss
最后修改时间	modified	datetime	datetime	是	最后修改时间，格式：yyyy-MM-dd HH:mm:ss
联系人	receiver_name	varchar	40	是	联系人
省份	receiver_province	int	11	是	省份代码
城市	receiver_city	int	11	是	城市代码
区县	receiver_district	int	11	是	区县代码
邮编	receiver_zip	varchar	20	是	邮编信息
省市区	receiver_area	varchar	255	是	省市区
地址	receiver_address	varchar	255	是	地址
移动电话	receiver_mobile	varchar	40	是	移动电话
固定电话	receiver_telno	varchar	40	是	固定电话
自定义属性1	prop1	varchar	255	是	自定义属性1
自定义属性2	prop2	varchar	255	是	自定义属性2
自定义属性3	prop3	varchar	255	是	自定义属性3
自定义属性4	prop4	varchar	255	是	自定义属性4
接口外部单号	api_outer_no	varchar	40	是	接口外部单号
外部单号	outer_no	varchar	40	是	外部单号
仓储单号	wms_outer_no	varchar	40	是	仓储单号
物流单号	logistics_no	varchar	40	否	物流单号,获取此字段前需将版本升级至V2.3.9.1及以上的稳定版本
审核员名称	check_operator_name	varchar	40	是	审核员名称
操作员名称	operator_name	varchar	40	是	操作员名称
货品列表节点	details_list	data[ ]		是	响应参数的2级数据节点，包含单个入库单所有货品属性信息的数据节点，节点下数据字段详见下述“stockin_list”列表

details_list

名称	字段	类型	长度	必须	描述
单据主键id	order_id	int	11	是	单据主键id
主键	rec_id	int	11	是	主键（与业务无关）
委外单号	order_no	varchar	40	是	委外单号，默认WK开头
规格ID	spec_id	int	11	是	规格ID
辅助单位量	num2	decimal	(19,4)	是	辅助单位量
基本单位	base_unit_id	smallint	6	是	基本单位
单位换算关系	unit_ratio	decimal	(19,4)	是	单位换算关系
批次	batch_id	int	11	是	批次
创建时间	created	datetime			创建时间
最后修改时间	modified	datetime			最后修改时间
货品id	goods_id	int	11	是	货品id
货品简称	short_name	varchar	255	是	货品简称
商家编码	spec_no	varchar	40	是	代表单品(sku)所有属性的编码，SKU概念介绍,单击这里
条形码	barcode	varchar	40	是	条形码
单位id	unit_id	int	11	是	单位id
品牌id	brand_id	int	11	是	品牌id
批次号	batch_no	varchar	40	是	批次号
批次备注	batch_remark	varchar	255	是	批次备注
货位id	position_id	varchar	40	是	货位id
货位编号	position_no	varchar	40	是	货位编号
货品数量	num	decimal	(19,4)	是	货品数量
已出入库数量	inout_num	decimal	(19,4)	是	已出入库数量
成本价	price	decimal	(19,4)	是	成本价
备注	remark	varchar	255	是	入库单备注
物流公司id	logistics_id	int	11	是	物流公司id
物流单号	logistics_no	varchar	40	是	物流单号
品牌名称	brand_name	varchar	64	是	品牌名称
货品名称	goods_name	varchar	64	是	货品名称
货品编号	goods_no	varchar	40	是	代表货品(spu)所有属性的编号，SPU概念介绍,单击这里
规格名称	spec_name	varchar	100	是	规格名称
规格码	spec_code	varchar	40	是	规格码
单位	goods_unit	varchar	20	是	货品单位
有效期	expire_date	datetime		是	有效期，格式：yyyy-MM-dd HH:mm:ss

5.请求示例

PHP	<?php require_once("../WdtClient.php"); $c = new WdtClient; $c->sid = ''; $c->appkey = ''; $c->appsecret = ''; $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2_dev/vip_stock_outside_wms_query.php'; //添加查询参数 $c->putApiParam('warehouse_no', 'qmdb'); $c->putApiParam('status', '80'); $c->putApiParam('order_type', '1'); $c->putApiParam('outer_no', 'OQT201612190015'); $c->putApiParam('order_no', 'WK201612190001'); $c->putApiParam('start_time', '2016-12-01 00:00:00'); $c->putApiParam('end_time', '2016-12-30 00:00:00'); $c->putApiParam('page_size', '10'); $c->putApiParam('page_no', '0'); $json = $c->wdtOpenApi(); var_dump($json); ?>
JAVA	package com.wangdian.api.vip; import java.io.IOException; import java.util.HashMap; import java.util.Map; import com.wangdian.api.WdtClient; public class VipStockOutsideWmsQuery { 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", "2016-12-01 00:00:00"); params.put("end_time", "2016-12-30 00:00:00"); params.put("page_no", "0"); params.put("page_size", "10"); params.put("warehouse_no", "qmdb"); params.put("status", "80"); params.put("order_type", "1"); params.put("outer_no", "OQT201612190015"); params.put("order_no", "WK201612190001"); try { String response = client.execute("vip_stock_outside_wms_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 VipStockOutsideWmsQuery{ class VipStockOutsideWmsQuery{ static void Main(string[] args){ WdtClient client = new WdtClient(); client.sid = ""; client.appkey = ""; client.appsecret = ""; client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/vip_stock_outside_wms_query.php"; client.putParams("warehouse_no", "qmdb"); client.putParams("status", "80"); client.putParams("order_type", "1"); client.putParams("outer_no", "OQT201612190015"); client.putParams("order_no", "WK201612190001"); client.putParams("start_time", "2016-12-01 00:00:00"); client.putParams("end_time", "2016-12-30 00:00:00"); client.putParams("page_size", "10"); client.putParams("page_no", "0"); 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({"outer_no": ''}) params.update({"start_time": '2021-01-01 00:00:00'}) params.update({"end_time": '2021-01-01 00:59:59'}) params.update({"page_size": '40'}) params.update({"page_no": '0'}) response = t.execute("vip_stock_outside_wms_query.php", params) print(response)

6.响应示例

6.1 正常响应示例

JSON

{
  "code": "0",
  "message": "",
  "total_count": "1",
  "order_list": [
    {
      "order_id": "264",
      "order_no": "WK201905280002",
      "outer_no": "",
      "wms_outer_no": "",
      "remark": "324234321131",
      "order_type": "2",
      "status": "30",
      "wms_status": "0",
      "error_info": "",
      "operator_id": "-1",
      "check_operator_id": "0",
      "warehouse_id": "33",
      "warehouse_type": "11",
      "transport_mode": "0",
      "logistics_id": "0",
      "logistics_no": "",
      "logistics_fee": "0.0000",
      "other_fee": "0.0000",
      "total_price": "1111.0000",
      "goods_count": "1.0000",
      "goods_type_count": "1",
      "goods_real_count": "0.0000",
      "check_time": "0000-00-00 00:00:00",
      "modified": "2019-05-28 13:49:26",
      "created": "2019-05-28 13:49:26",
      "receiver_name": "1111345346",
      "receiver_province": "110000",
      "receiver_city": "110100",
      "receiver_district": "110108",
      "receiver_zip": "",
      "receiver_area": "北京 北京市 海淀区",
      "receiver_address": "1111",
      "receiver_mobile": "32423432",
      "receiver_telno": "",
      "prop1": "32423432",
      "prop2": "32423432",
      "prop3": "32423432",
      "prop4": "32423432",
      "api_outer_no": "1131",
      "warehouse_no": "qimen001",
      "details_list": [
        {
          "rec_id": "680",
          "order_id": "264",
          "order_no": "WK201905280002",
          "goods_id": "47278",
          "goods_name": "盖-承鄞蓝色06",
          "short_name": "",
          "goods_no": "g-cy006",
          "spec_code": "",
          "spec_name": "蓝色",
          "spec_no": "G-CY006",
          "barcode": "g-cy006",
          "unit_id": "0",
          "brand_id": "0",
          "batch_no": null,
          "position_id": "0",
          "position_no": null,
          "num": "1.0000",
          "inout_num": "0.0000",
          "price": "1111.0000",
          "remark": "",
          "logistics_id": "0",
          "logistics_no": "",
          "goods_unit": null,
          "brand_name": "无"
        }
      ]
    }
  ]
}

6.2 异常响应示例

JSON	{ "code": 1060, "message": "充值余额为0或应用已欠费，请联系商务充值 " }