当前位置: API文档
stockout_order_query.php(查询出库单管理)
1.1 接口描述:获取旺店通ERP各种业务类型的出库单及货品明细信息 |
1.2 适用版本:客户端 V2.6.0.8及以上版本 |
1.3 增量获取:如果状态(status)未传值或者值大于等于95时按照出库时间增量获取数据,如果状态(status)小于95时按照最后修改时间增量获取数据,请求时输入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 SAP、线下ERP、SRM、SCM等系统对接 |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/stockout_order_query.php |
正式环境 | https://api.wangdian.cn/openapi2/stockout_order_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 | 10 | 否 | 每页返回条数,输入值范围1~100,不传默认40,使用举例单击这里 |
页号 | page_no | int | 10 | 否 | 不传值默认从0页开始 |
出库单类型 | order_type | tinyint | 1 | 否 | 2调拨出库,3采购退货出库,4盘亏出库,5生产出库,7其他出库,8多发出库,9纠错出库,10保修配件出库,11初始化出库,12jit拣货出库,13委外出库 |
出库单状态 | status | tinyint | 1 | 否 | 出库单状态5:已取消,50:待审核,55:已审核,95:已发货,110:已完成(默认查已发货已完成单据),113:异常发货 |
仓库编号 | warehouse_no | varchar | 40 | 否 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置)(不支持一次推送多个仓库编号) |
源单号 | src_order_no | varchar | 40 | 否 | 源单号 |
出库单号 | stockout_no | varchar | 40 | 否 | 出库单号,传该字段可以不传时间 |
外部API单号 | outer_no | varcher | 40 | 否 | 外部系统出库单的唯一单据编号,传该字段可以不传开始时间和结束时间(创建出库单时所传outer_no字段) |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 10 | 否 | 符合条件的数据条数,用来分页 当page_no = 0时返回 |
出库单详情 | stockout_list | data[] | 否 | 响应参数的1级数据节点,包含当前页的出库单及其明细的数据节点,节点下数据字段详见下述“stockout_list”和" details_list" |
stockout_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
出库单主键id | stockout_id | int | 11 | 是 | 出库单主键id |
出库单号 | order_no | varchar | 40 | 是 | 出库单号 |
出库单号 | stockout_no | varchar | 40 | 是 | 出库单号 |
源单号 | src_order_no | varchar | 40 | 是 | 源单号,上层单据的业务单号 |
仓库编号 | warehouse_no | varchar | 40 | 是 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),用于获取指定仓库数据信息 |
状态 | status | int | 4 | 是 | 出库单状态,5:已取消,50:待审核,55:已审核,95:已发货,110:已完成(默认查已发货已完成单据),113:异常发货 |
出库时间 | consign_time | date | 是 | 出库时间,格式:yyyy-MM-dd HH:mm:ss | |
出库单类型 | order_type | int | 4 | 是 | 出库单类型,2调拨出库,3采购退货出库,4盘亏出库,5生产出库,7其他出库,8多发出库,9纠错出库,10保修配件出库,11初始化出库,12jit拣货出库,13委外出库 |
出库单类型名称 | order_type_name | varchar | 40 | 是 | 出库单类型名称 |
出库单子类型 | subtype | varchar | 256 | 是 | 出库单子类型 |
出库原因 | stockout_reason | varchar | 32 | 是 | 出库原因 |
数量 | goods_count | decimal | (19,4) | 是 | 货品数量 |
货品总销售金额 | goods_total_amount | decimal | (19,4) | 是 | 货品总销售金额 |
货品总成本金额 | goods_total_cost | decimal | (19,4) | 是 | 货品总成本金额 |
邮费 | post_fee | decimal | (19,4) | 是 | 邮费 |
物流单号 | logistics_no | varchar | 40 | 是 | 物流单号(该出库单的运单号) |
包装费 | package_fee | decimal | (19,4) | 是 | 包装费 |
收件人 | receiver_name | varchar | 40 | 是 | 该字段已废弃 |
国家 | receiver_country | smallint | 6 | 是 | 国家 |
省份 | receiver_province | varchar | 40 | 是 | 省份 |
城市 | receiver_city | varchar | 40 | 是 | 城市 |
地区 | receiver_district | varchar | 60 | 是 | 地区 |
详细地址 | receiver_address | varchar | 256 | 是 | 该字段已废弃 |
收件人移动电话 | receiver_mobile | varchar | 40 | 是 | 该字段已废弃 |
收件人固定电话 | receiver_telno | varchar | 40 | 是 | 该字段已废弃 |
邮编 | receiver_zip | varchar | 20 | 是 | 邮编 |
重量 | weight | decimal | (19,4) | 是 | 重量 |
备注 | remark | varchar | 255 | 是 | 备注 |
外部单号 | outer_no | varchar | 40 | 是 | 外部单号 |
操作员姓名 | operator_name | varchar | 40 | 是 | 操作员姓名 |
物流方式 | logistics_type | smallint | 6 | 是 | 响应值为代表物流方式的数字,数字对应的物流方式名称单击这里 |
物流编号 | logistics_code | varchar | 20 | 是 | 代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置) |
物流公司名称 | logistics_name | varchar | 40 | 是 | erp对应的物流公司名称 |
最后修改时间 | modified | datetime | 是 | 单据最后修改时间,格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | stock_check_time | datetime | 是 | 单据创建时间,格式:yyyy-MM-dd HH:mm:ss | |
Sku详情节点 | details_list | data[] | 是 | 响应参数的2级数据节点,包含当出库单货品属性信息的数据节点,节点下数据字段详见下述" details_list" |
details_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
出库单主键id | stockout_id | int | 11 | 是 | 出库单主键id |
出库单明细id | rec_id | int | 11 | 是 | 出库单明细id |
上层单据明细主键 | src_order_detail_id | int | 11 | 是 | 上层单据明细主键 |
商家编码 | spec_no | varchar | 40 | 是 | 代表所单品(sku)所有属性的唯一编码,用于获取系统单品的数据,SKU概念介绍,单击这里 |
货品数量 | goods_count | decimal | (19,4) | 是 | 货品数量 |
销售价 | sell_price | decimal | (19,4) | 是 | 销售价 |
品牌编号 | brand_no | varchar | 32 | 是 | 品牌编号 |
品牌名称 | brand_name | varchar | 64 | 是 | 品牌名称 |
货品名称 | goods_name | varchar | 255 | 是 | 货品名称 |
货品编号 | goods_no | varchar | 40 | 是 | 代表SPU所有属性的唯一编号,用于获取系统货品的数据,SPU概念介绍,单击这里 |
规格名称 | spec_name | varchar | 100 | 是 | 规格名称 |
规格编号 | spec_code | varchar | 20 | 是 | 规格编号 |
成本价 | cost_price | decimal | (19,4) | 是 | 成本价 |
总销售金额 | total_amount | decimal | (19,4) | 是 | 总销售金额 |
重量 | weight | decimal | (19,4) | 是 | 重量 |
备注 | remark | varchar | 64 | 是 | 备注 |
单位 | goods_unit | varchar | 20 | 是 | 货品单位 |
批次号 | batch_no | varchar | 20 | 是 | 批次号 |
批次备注 | batch_remark | varchar | 255 | 是 | 批次备注 |
有效期 | expire_date | datetime | 是 | 有效期,格式:yyyy-MM-dd HH:mm:ss | |
商品类型 | goods_type | tinyint | 4 | 是 | 1销售商品 2原材料 3包装 4周转材料5虚拟商品 0其它 |
货位列表节点 | position_list | data[] | 是 | 响应参数的3级数据节点,节点下数据字段详见下述“position_list”列表 |
position_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
货位ID | position_id | int | 11 | 是 | 货位ID |
货位编号 | position_no | varchar | 40 | 是 | 货位编号 |
货位出库数量 | position_goods_count | decimal | (19,4) | 是 | 货位出库数量 |
出库单明细id | stockout_order_detail_id | varchar | 11 | 是 | 出库单明细id |
货位主键id | rec_id | varchar | 11 | 是 | 货位主键id |
入库单号明细id | stock_spec_detail_id | varchar | 11 | 是 | 入库单号明细id |
入库单明细id | stockin_detail_id | varchar | 11 | 是 | 入库单明细id |
批次id | batch_id | varchar | 11 | 是 | 批次id |
批次号 | batch_no | varchar | 20 | 是 | 批次号 |
成本价 | cost_price | decimal | (19,4) | 是 | 成本价 |
最后更新时间 | modified | datetime | 是 | 最后修改时间,格式:yyyy-MM-dd HH:mm:ss | |
先进先出计价用 | v_stock_spec_detail_id | varchar | 20 | 是 | 先进先出计价用 |
有效期 | expire_date | datetime | 是 | 有效期,格式:yyyy-MM-dd HH:mm:ss | |
创建时间 | created | datetime | 是 | 创建时间,格式:yyyy-MM-dd HH:mm:ss |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": "13", "message": "仓库不存在warehouse_no:333" } |