文档
测试

采退单查询列表

websocket测试
POST
请求地址/router

系统相关界面

"界面路径：【采购】----【采退单管理】----【查询】"

请求地址

|环境|服务地址(HTTP/HTTPS)| |-|-| |V2正式环境| https://gw.superboss.cc/router| **2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**

公共参数

调用任何一个API都必须传入的参数，目前支持的公共参数有： | 参数名称 | 参数类型 | 是否必须 | 参数描述 | | --- | --- | --- | --- | | method | string | 是 | API接口名称 | | appKey | string | 是 | 分配给应用的AppKey | | timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 | | format | string | 否 | 响应格式。默认为json格式，可选值：json | | version | string | 是 | API协议版本 可选值：1.0 | | sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 | | sign | string | 是 | 签名 | | session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

请求头

参数名
类型
描述
必填
Content-Type
string
multipart/form-data
必填

API接口地址

参数名
类型
描述
必填
method
string
purchase.return.list.query
必填

请求参数

参数名
类型
描述
必填
outerCode
string
外部采购订单号
可选
pageNo
integer
页码 取值范围:大于零的整数。默认值为1
可选
timeType
integer
查询时间类型 1修改时间（默认为1），2创建时间--未上线
可选
startModified
string
起始时间 格式:yyyy-MM-dd HH:mm:ss
可选
endModified
string
结束时间 格式:yyyy-MM-dd HH:mm:ss
可选
pageSize
integer
每页条数 取值范围:大于零的整数;最大值：200；默认值：40
可选
status
string
单据状态 0 :已作废 1 :待出库 2 :已审核 「已废弃」 4 :出库中 3 :已出库 5:草稿
可选
code
string
单据号
可选
tagName
string
标签名称
必填
financeStatus
string
财审状态 待财审：WAIT_FINANCE，已财审：FINANCED
必填

请求示例

```json { "id": "long" } ````

响应参数

参数名
类型
描述
total
string
总数
list
object
列表
templateType
string
模板类型
stockRegionCodes
string
库区编码
discountAmount
string
折扣金额（单位：分）
templateId
string
快递模板
isAssignSection
string
是否指定货位
province
string
省
gmModified
string
修改时间
busyId
string
业务id
actualReturnNum
string
实际退货数
payment
string
实付金额（含运费）（单位：分）
id
string
id
allAllocate
string
采退单明细是否全部配货 0：否；1：是
outerCode
string
外部编号
receiver
string
收货人
mergeId
string
关联的合单id
returnSkuTypeNum
string
采退单中sku的种类数
splitBySupplier
string
是否按照供应商进行拆分生成采退单，PDA生成采退单可能需要按供应商拆分生成 0：否；1：是
isActualReturnNum
string
是否有实际退货数量
busyType
string
业务类型
createrName
string
制单人名称
waveStatus
string
波次状态
outSid
string
出库单号
totalAmount
string
商品总金额（单位：分）
companyId
string
公司id
othersFee
string
其他金额（单位：分）
prSourceId
string
采退单外部单号
warehouseId
string
退货仓库Id
phone
string
手机
purchaseOrderId
string
采购单Id
isMerge
string
是否合单
district
string
区
enableStatus
string
有效标记，1：有效 2：隐藏（合单隐藏单）
outTime
string
出库时间
status
string
单据状态 0 :已作废 1 :待出库 2 :已审核 「已废弃」 4 :出库中 3 :已出库 5:草稿
code
string
采购退货单号
supplierId
string
供应商Id
pickerNames
string
波次拣选员
inWarehouseName
string
调入仓库名称
city
string
市
outLocation
string
出库位置,货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区/拣选暂存区 1/2/3/4/5/6
remark
string
备注
totalCount
string
数量
warehouseName
string
仓库名称
wssType
string
暂存区类型
inWarehouseId
string
调入仓库id
actualTotalAmount
string
实际总额（单位：分）
statusName
string
状态名称
supplierName
string
供应商名称
address
string
地址
warehouseExternalCode
string
仓库外部编号
pickerIds
string
波次拣选员Ids
postFee
string
运费（单位：分）
gmCreate
string
创建时间
mergeType
string
合并类型，v1/v2，默认值为0 ,v2版本设置为1
waveId
string
波次号
feeShareType
string
金额分摊方式
busyCode
string
业务单据号
returnNum
string
退货数量
templateName
string
模板名称
sortType
string
排序类型 0:无，1：按商品排序
logisticsType
string
物流方式
supplierCode
string
供应商编码
labels
array
标签集合
id
long
标签ID
name
string
标签名称
style
string
标签样式
financeStatus
string
财审状态 待财审：WAIT_FINANCE，已财审：FINANCED

响应示例

```json { "total": 12345, "list": [ { "templateType": 1, "stockRegionCodes": "zhangsan", "discountAmount": 10000, "templateId": 12345, "isAssignSection": true, "province": "zhangsan", "gmModified": "@date", "busyId": 12345, "actualReturnNum": 12345, "payment": 10000, "id": 12345, "allAllocate": 1, "outerCode": "zhangsan", "receiver": "zhangsan", "mergeId": 12345, "returnSkuTypeNum": 1, "splitBySupplier": 1, "isActualReturnNum": true, "busyType": "zhangsan", "createrName": "zhangsan", "waveStatus": 1, "outSid": "zhangsan", "totalAmount": 10000, "companyId": 12345, "othersFee": 10000, "prSourceId": "zhangsan", "warehouseId": 12345, "phone": "zhangsan", "purchaseOrderId": 12345, "isMerge": 1, "district": "zhangsan", "warehouseType": 1, "enableStatus": 1, "outTime": "@date", "status": 1, "code": "zhangsan", "supplierId": 12345, "pickerNames": "zhangsan", "inWarehouseName": "zhangsan", "city": "zhangsan", "outLocation": 1, "freight": 10000, "remark": "zhangsan", "totalCount": 1, "warehouseName": "zhangsan", "wssType": "zhangsan", "inWarehouseId": 12345, "actualTotalAmount": 10000, "statusName": "zhangsan", "supplierName": "zhangsan", "address": "zhangsan", "warehouseExternalCode": "zhangsan", "pickerIds": "zhangsan", "postFee": 10000, "gmCreate": "@date", "mergeType": 1, "waveId": 12345, "dbNo": 1, "feeShareType": 1, "busyCode": "zhangsan", "returnNum": 12345, "templateName": "zhangsan", "sortType": 1, "wlbTemplateType": "zhangsan", "logisticsType": 1 } ] } ```

异常示例

```` { "code": "25", "msg": "服务方法(purchase.return.list.query:1.0)的签名无效", "success": false, "trace_id": "3553483395423660" } ````

错误码解释

| 错误码 |错误信息|解决方案| |-|-|-| |25|服务方法(purchase.return.list.query:1.0)的签名无效|签名参数错误|
上一篇 采退单保存
nextDoc 采退单详情
本文档使用易文档编写, 更新时间: 2024-08-29 10:58