当前位置: API文档
stockout_order_query_return.php(查询采购退货出库单)
1.1 接口描述:获取旺店通ERP的采购退货出库单及其明细信息 |
1.2 适用版本:客户端 V2.4.5.6及以上版本 |
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,建议根据获取数据量的多少适当减小时间跨度。 |
2.1 财务系统、SAP、数据分析等系统的对接 |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/stockout_order_query_return.php |
正式环境 | https://api.wangdian.cn/openapi2/stockout_order_query_return.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 | |
出库单号 | stockout_no | varchar | 否 | 采购退货出库单号 | |
仓库编号 | warehouse_no | varchar | 40 | 否 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置) |
出库单状态 | status | tinyint | 1 | 否 | 出库单状态5:已取消,50:待审核,55:已审核,95:已发货,110:已完成(默认查已发货已完成单据) |
页号 | page_no | int | 10 | 否 | 不传值默认从0页开始 |
分页大小 | page_size | int | 10 | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里 |
上层单据编号 | src_order_no | varchar | 40 | 否 | 上层单据编号,默认为采购退货单号,传该字段可以不传开始时间和结束时间 |
外部API单号 | outer_no | varchar | 40 | 否 | 外部系统采购退货出库单的唯一单据编号,传该字段可以不传开始时间和结束时间(创建采购退货出库单时所传outer_no字段) |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 40 | 是 | 状态码: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 | 是 | 系统出库单号,默认为CK开头 |
源单号 | src_order_no | varchar | 40 | 是 | 该源单号为退货单号 |
仓库编号 | warehouse_no | varchar | 40 | 是 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置) |
状态 | status | int | 4 | 是 | 出库状态5:已取消,50:待审核,55:已审核,95:已发货,110:已完成 |
出库时间 | consign_time | datetime | 是 | 出库时间,格式:yyyy-MM-dd HH:mm:ss | |
源单据类别 | order_type | int | 4 | 是 | 源单据类别 1销售订单, 2调拨出库, 3采购退货出库, 4盘亏出库, 5生产出库, 6现款销售出库, 7其他出库, 8多发出库, 9纠错出库,10保修配件出库, 11初始化出库, 12jit拣货出库 13委外出库 |
源单据类型名称 | order_type_name | varchar | 40 | 是 | 源单据类型名称 |
出库子类型 | subtype | varchar | 256 | 是 | 出库子类型 |
货品数量 | 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 | 是 | 代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置) |
包装费 | package_fee | decimal | (19,4) | 是 | 包装费 |
收件人 | receiver_name | varchar | 40 | 是 | 该字段已废弃 |
国家 | receiver_country | int | 6 | 是 | 国家 |
省份 | receiver_province | int | 11 | 是 | 省份 |
城市 | receiver_city | int | 11 | 是 | 城市 |
地区 | receiver_district | int | 11 | 是 | 地区 |
详细地址 | receiver_address | varchar | 是 | 该字段已废弃 | |
收件人移动电话 | receiver_mobile | varchar | 是 | 该字段已废弃 | |
收件人固定电话 | receiver_telno | varchar | 是 | 该字段已废弃 | |
邮编 | receiver_zip | varchar | 20 | 是 | 邮编 |
重量 | weight | decimal | (19,4) | 是 | 重量 |
备注 | remark | varchar | 60 | 是 | 备注 |
出库原因 | stockout_reason | varchar | 32 | 是 | 出库原因 |
外部单号 | outer_no | varchar | 40 | 是 | 外部单号 |
操作人 | operator_name | varchar | 40 | 是 | 操作人 |
省市区 | receiver_area | varchar | 255 | 是 | 省市区空格分开 |
采购退货单号 | return_no | varchar | 20 | 是 | 采购退货单号 |
供应商编号 | provider_no | varchar | 20 | 是 | 代表供应商所有属性的唯一编码,用于供应商区分,ERP内支持自定义(ERP供应商界面设置) |
供应商名称 | provider_name | varchar | 64 | 是 | 供应商名称 |
最后修改时间 | modified | datetime | 是 | 出库单的最后更新时间,格式:YYYY-MM-DD HH:MM:SS | |
采购退货单外部单号 | pr_api_outer_no | varchar | 40 | 是 | 采购退货单的外部单号 |
最后引用采购单号 | last_load_purchase_no | varchar | 40 | 是 | 最后引用采购单号 |
分拣单打印状态 | picklist_print_status | tinyint | 4 | 是 | 默认为'0',分拣单打印状态 0未打印 1打印中 2已打印 3无需打印 |
物流单打印状态 | logistics_print_status | tinyint | 4 | 是 | 默认为'0',物流单打印状态,0未打印 1打印中 2已打印 3无需打印 |
发货单打印状态 | sendbill_print_status | tinyint | 4 | 是 | 默认为'0',发货单打印状态,0未打印 1待打中 2已打印 3无需打印 |
出库单号 | stockout_no | varchar | 40 | 是 | 出库单号 |
源单据类别 | src_order_type | tinyint | 4 | 是 | 源单据类别 1销售订单, 2调拨出库, 3采购退货出库, 4盘亏出库, 5生产出库, 6现款销售出库, 7其他出库, 8多发出库, 9纠错出库,10保修配件出库, 11初始化出库, 12jit拣货出库 13委外出库' |
源单据id | src_order_id | int | 11 | 是 | 源单据id |
处理状态 | wms_status | int | 4 | 是 | 处理状态 0 待处理 1 推送失败 2 推送成功 3 接口取消成功系统驳回失败 4 服务器正在处理 5 WMS返回发货信息 6 异步标记,推送申请成功 |
错误信息 | error_info | varchar | 255 | 是 | 接口处理错误信息 |
仓库类别 | warehouse_type | tinyint | 4 | 是 | 默认为'0',仓库类别(0不限 1普通仓库 2自动流传外部 3京东仓储 4科捷 5百世物流 6SKU360 7通天晓 8中联网仓 9顺丰仓储 10网仓2号 11奇门仓储 12旺店通仓储 13心怡仓储 14力威仓储 15京东沧海 16云集仓储 17POS 18虎符 20外部链路型 22抖店云仓 126分销委外仓 127其它) |
出库的仓库id | warehouse_id | smallint | 6 | 是 | 出库的仓库id |
客户id | customer_id | int | 11 | 是 | 默认为'0',客户id |
冻结原因 | freeze_reason | smallint | 6 | 是 | 默认为'0',冻结原因 |
是否分配 | is_allocated | tinyint | 1 | 是 | 默认为'0',是否分配 |
出库状态 | consign_status | int | 11 | 是 | 默认为'0',出库状态 1验货 2称重 4出库 8物流同步 16分拣 32档口, 64拣货 |
面单状态 | ebill_status | tinyint | 4 | 是 | 默认为'0',电子面单,获取状态 |
制单人 | operator_id | int | 11 | 是 | 默认为'0',制单人 |
货品种类数量 | goods_type_count | smallint | 6 | 是 | 默认为'0',货品种类数量 |
MD5字符串值 | md5_str | varchar | 40 | 是 | 默认为'',MD5字符串值,用于单据排序 |
预留字段 | raw_goods_count | decimal | (19,4) | 是 | 默认为'0',预留字段 |
出库类别 | custom_type | smallint | 6 | 是 | 默认为'0',其他出库自定义子类别0,1,2,3,4 |
接收环 | receiver_ring | varchar | 20 | 是 | 默认为'',京东三环内(未使用) |
配送时间 | to_deliver_time | varchar | 20 | 是 | 默认为'',配送时间 |
配送中心 | pre_charge_time | varchar | 20 | 是 | 默认为'',配送中心 |
物流公司id | logistics_id | smallint | 6 | 是 | 默认为'0',物流公司id |
未知成本销售总额 | unknown_goods_amount | decimal | (19,4) | 是 | 默认为'0.0000',未知成本销售总额 |
预估邮费成本 | calc_post_cost | decimal | (19,4) | 是 | 默认为'0.0000',预估邮费成本 |
邮费成本 | post_cost | decimal | (19,4) | 是 | 默认为'0.0000',邮费成本 |
预估重量 | calc_weight | decimal | (19,4) | 是 | 默认为'0.0000',预估重量 |
快递给的重量 | post_weight | decimal | (19,4) | 是 | 默认为'0.0000',快递给的重量 |
包装 | package_id | int | 11 | 是 | 默认为'0',包装 |
包装成本 | package_cost | decimal | (19,4) | 是 | 默认为'0.0000',包装成本 |
是否包含发票 | has_invoice | tinyint | 1 | 是 | 默认为'0',是否包含发票 |
打单员 | printer_id | int | 11 | 是 | 默认为'0',打单员 |
拣货出错次数 | pick_error_count | int | 11 | 是 | 默认为'0',拣货出错次数 |
拣货操作员id | picker_id | int | 11 | 是 | 默认为'0',拣货操作员id |
包裹分拣员id | sorter_id | int | 11 | 是 | 默认为'0',包裹分拣员id |
验货操作员id | examiner_id | int | 11 | 是 | 默认为'0',验货操作员id |
发货人id | consigner_id | int | 11 | 是 | 默认为'0',发货人id |
打包员 | packager_id | int | 11 | 是 | 默认为'0',打包员 |
打包积分 | pack_score | int | 11 | 是 | 默认为'0',打包积分 |
拣货积分 | pick_score | int | 11 | 是 | 默认为'0',拣货积分 |
签出员工id | checkouter_id | int | 11 | 是 | 默认为'0',签出员工id |
监视员 | watcher_id | int | 11 | 是 | 默认为'0',监视员 |
分拣单编号 | picklist_no | varchar | 40 | 是 | 默认为'',分拣单编号 |
分拣单中序号 | picklist_seq | smallint | 6 | 是 | 默认为'0',订单在分拣单中序号 |
发票打印状态 | invoice_print_status | tinyint | 4 | 是 | 默认为'0',发票打印状态 |
颜色标记 | flag_id | smallint | 6 | 是 | 默认为'0',颜色标记 |
物流单模板id | logistics_template_id | smallint | 6 | 是 | 默认为'0', 物流单模板id |
发货单模板id | sendbill_template_id | smallint | 6 | 是 | 默认为'0',发货单模板id |
货位分配方式 | pos_allocate_mode | tinyint | 1 | 是 | 默认为'0',货位分配方式:0系统自动分配, 1手动指定货位分配 2手动指定有效期批次货位 |
便签条数 | note_count | smallint | 6 | 是 | 默认为'0',便签条数 |
出库原因 | reason_id | int | 11 | 是 | 默认为'0',其他出库原因 |
锁定策略id | lock_id | int | 11 | 是 | 默认为'0',锁定策略id |
保留 | reserve | varchar | 40 | 是 | 默认为'0',保留 |
截停原因 | block_reason | int | 11 | 是 | 默认为'0',截停原因1申请退款2已退款4地址被修改8发票被修改16物流被修改32仓库变化64备注修改128更换货品256添加货品512放弃抢单1024其他原因2048拦截赠品4096拦截天猫换货8192买家留言变更16384货品平台规格名变更 |
打印批次 | batch_no | varchar | 40 | 是 | 默认为'',打印批次 |
出库单审核时间 | stock_check_time | datetime | 是 | 出库单审核时间 | |
拣货员名称 | picker_name | varchar | 40 | 是 | 拣货员名称 |
包裹分拣员名称 | sorter_name | varchar | 40 | 是 | 包裹分拣员名称 |
验货员名称 | examiner_name | varchar | 40 | 是 | 验货员名称 |
发货员名称 | consigner_name | varchar | 40 | 是 | 发货员名称 |
打包员名称 | packager_name | varchar | 40 | 是 | 打包员名称 |
签出员工名称 | checkouter_name | varchar | 40 | 是 | 签出员工名称 |
监视员名称 | watcher_name | varchar | 40 | 是 | 监视员名称 |
货品列表节点 | details_list | data | 是 | 响应参数的2级数据节点,包含的采购退货出库单及其明细的数据节点,节点下数据字段详见下述“detail_list”列表 |
detail_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
出库明细主键id | rec_id | int | 11 | 是 | 出库明细主键id |
出库单主键id | stockout_id | int | 11 | 是 | 出库单主键id |
商家编码 | spec_no | varchar | 40 | 是 | 代表单品(SKU)所有属性的唯一编号,用于系统单品的区分,SKU概念介绍单击这里 |
货品数量 | goods_count | decimal | (19,4) | 是 | 货品数量 |
销售价 | sell_price | decimal | (19,4) | 是 | 销售价 |
品牌编号 | brand_no | varchar | 50 | 是 | 品牌编号 |
品牌名称 | brand_name | varchar | 64 | 是 | 品牌名称 |
货品名称 | goods_name | varchar | 255 | 是 | 货品名称 |
货品编号 | goods_no | varchar | 100 | 是 | 代表SPU所有属性的唯一编号,用于系统货品的区分,SPU概念介绍单击这里 |
规格名称 | spec_name | varchar | 255 | 是 | 规格名称 |
规格编号 | spec_code | varchar | 40 | 是 | 规格编号 |
成本价 | cost_price | decimal | (19,4) | 是 | 成本价 |
总货款 | total_amount | decimal | (19,4) | 是 | 总货款 |
重量 | weight | decimal | (19,4) | 是 | 重量 |
货品类别 | goods_type | int | 1 | 是 | 1销售商品 2原材料 3包装 4周转材料5虚拟商品 0其它 |
单位名称 | goods_unit | varchar | 20 | 是 | 单位名称 |
批次号 | batch_no | varchar | 20 | 是 | 批次号 |
批次备注 | batch_remark | varchar | 255 | 是 | 批次备注 |
有效期 | expire_date | datetime | 是 | 有效期,格式:yyyy-MM-dd HH:mm:ss | |
备注 | remark | varchar | 255 | 是 | 备注 |
货品id | goods_id | int | 11 | 是 | 货品id |
规格id | spec_id | int | 11 | 是 | 默认为'0',规格id |
货位 | position_id | int | 11 | 是 | 默认为'0',货位,指出库货位 |
源单据类别 | src_order_type | tinyint | 4 | 是 | 默认为'1',源单据类别 1销售订单2,调拨出库3,采购出库4,生产出库5,盘亏出库6,其他出库 |
源单据细节id | src_order_detail_id | int | 11 | 是 | sales_trade_order表的主键 |
基本单位 | base_unit_id | smallint | 6 | 是 | 默认为'0',基本单位 |
辅助单位 | unit_id | smallint | 6 | 是 | 默认为'0',辅助单位 |
单位换算 | unit_ratio | decimal | (19,4) | 是 | 默认为'1.0000',单位换算 |
辅助数量 | num2 | decimal | (19,4) | 是 | 默认为'0.0000,辅助数量 |
货品数量 | num | decimal | (19,4) | 是 | 货品数量 |
价格 | price | decimal | (19,4) | 是 | 默认为'0.0000,最终价格 |
出库批次 | batch_id | int | 11 | 是 | 默认为'0',指定出库批次 |
是否验货 | is_examined | tinyint | 1 | 是 | 默认为'0',是否验货,用于挂起,已标记为验货的不需要再验货 |
是否包装 | is_package | tinyint | 1 | 是 | 默认为'0',是否包装 |
是否允许0成本 | is_zero_cost | tinyint | 1 | 是 | 默认为'0',是否允许0成本 |
类型 | scan_type | tinyint | 1 | 是 | 默认为'0',0未验货,1扫描验货,2手工验货 |
最后修改时间 | modified | datetime | 是 | 最后修改时间 | |
创建时间 | created | datetime | 是 | 创建时间 | |
货位列表节点 | position_list | data[] | 是 | 响应参数的3级数据节点,节点下数据字段详见下述“position_list”列表 |
position_list
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
货位ID | position_id | int | 11 | 是 | 货位ID |
货位编号 | position_no | varchar | 40 | 是 | 货位编号 |
货位出库数量 | position_goods_count | int | 11 | 是 | 货位出库数量 |
有效期 | expire_date | datetime | 是 | 有效期,格式:yyyy-MM-dd HH:mm:ss | |
批次ID | batch_id | int | 11 | 是 | 批次ID |
批次号 | batch_no | varchar | 20 | 是 | 出库批次 |
货品批次备注 | batch_remark | varchar | 255 | 是 | 货品批次备注 |
入库单号 | stockin_no | varchar | 40 | 是 | 入库单号 |
备注 | remark | varchar | 255 | 是 | 备注 |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": 2104, "message": "start_time与end_time时间跨度不能超过最大范围 30天" } |