文档
测试

采购单查询

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.order.query
必填

请求参数

参数名
类型
描述
必填
outerCode
string
外部采购订单号
可选
pageNo
integer
页码 取值范围:大于零的整数。默认值为1
可选
pageSize
integer
每页条数 取值范围:大于零的整数;最大值:200;默认值:40
可选
timeType
integer
查询时间类型 1修改时间(默认为1),2创建时间--未上线
可选
startModified
string
起始时间 格式:yyyy-MM-dd HH:mm:ss
可选
endModified
string
结束时间 格式:yyyy-MM-dd HH:mm:ss
可选
status
string
单据状态 WAIT_VERIFY 草稿,VERIFYING 待审核,GOODS_NOT_ARRIVED 未到货,GOODS_PART_ARRIVED 部分到货,FINISHED 已完成, GOODS_CLOSED 已关闭
可选
id
integer
采购单id
可选
code
string
采购单号
可选

请求示例

```json { "outerCode": "string", "pageNo": "integer", "startModified": "string", "pageSize": "integer", "endModified": "string", "fields": "string", "status": "string" } ````

响应参数

参数名
类型
描述
total
string
总数
list
object
列表
templateType
string
模板类型
sourceKey
long
对接平台 appKey
sourceId
string
对接平台外部单号outerCode
shortId
long
采购短号
advanceCharge
string
预付款
cancelAmount
double
作废金额(单位:分)
pickWay
int
拿货方式 0 为正常拿货 1 为小程序 命名仿照 erp-caigou queryWay
receiveWarehouseId
string
收货仓库编号,初期设计时,仓库编号可不填,但是仓库名称需要填写
discountAmount
double
优惠金额(单位:分)
templateId
string
模板id
financeAuditorDate
string
财务审核日期
supplier
string
供应商
modified
string
修改日期
id
long
采购订单id
createrId
string
制单人编号
arriveRegisteredTime
string
登记时间
arriveRegisteredBy
string
登记人
itemNumType
string
单多件标识
created
string
制单日期
autoRemark
string
是否自动填充备注
createrName
string
制单人名称
outSid
string
出库单号
totalAmount
double
总金额,不包括优惠的金额(单位:分)
companyId
long
公司id
otherAmount
string
其他费用
auditorId
string
审核人id
financeAuditorId
long
财务审核人编号
auditorRemark
string
审核备注
receiveWarehouseName
string
收货仓库名称
warehouseType
string
仓库类型 0自有,1第三方,2门店仓库
enableStatus
int
启用禁用
auditorDate
string
审核日期
status
string
采购状态 单据状态 WAIT_VERIFY 草稿,VERIFYING 待审核,GOODS_NOT_ARRIVED 未到货,GOODS_PART_ARRIVED 部分到货,FINISHED 已完成, GOODS_CLOSED 已关闭
getGoodsStatus
string
拿货状态 STATUS_GOODS_NOT_GET 未拿货,STATUS_GOODS_PART_GET 部分拿货,STATUS_GOODS_FINISHED 已完成,GOODS_CLOSED 已关闭
sourceOrderId
string
对接平台外部订单号
totalDetailAmount
string
明细折前金额(单位:分)
code
string
单据号码
supplierId
string
供应商编号
flag
string
旗帜
freight
string
运费(单位:分)
actualReceiveNum
string
示例:实收数量总数
remark
string
示例:备注
supplierCode
string
示例:供应商编码
purchaseType
string
示例:采购类型 caigou:采购单 shouhuo:收货单
actualTotalAmount
string
实际总额/采购总额(单位:分)
financeAuditorRemark
string
财务审核备注
expressCompany
string
快递公司
printBy
string
打印人
deliveryDate
string
交货日期
auditorName
string
审核人名称
purchaseReturnNum
string
采退总数
supplierName
string
供应商名称
isFinishProduct
string
是否是成品采购
quantity
string
采购数量
financeAuditorName
string
财务审核人名称
warehouseExternalCode
string
仓库外部编号
arrivedQuantity
int
已到数量
billType
string
账期
receivedAmount
double
已到金额/已到总额(单位:分)
cancelQuantity
string
作废数
receiveQuantity
int
已收数量
templateName
string
模板名称
contractRemark
string
合同备注
purchaseReturnWeNum
long
采退收货总数
finishDate
string
完成日期
suitStatus
string
套件状态 0:无套件 1:有套件 2:有组合装
logisticsType
string
物流方式 1 快递,2 物流,3 自提,4 其他
printTime
string
打印时间
weFinishStatus
string
是否存在已完成收货单
financeId
Long
财务管理账户id
financeName
String
财务管理账户名称

响应示例

```json { "total": 12345, "list": [ { "templateType": 1, "sourceKey": 1, "sourceId": "zhangsan", "shortId": "zhangsan", "advanceCharge": 10000, "cancelAmount": 10000, "pickWay": 1, "receiveWarehouseId": 12345, "discountAmount": 10000, "receiveStatus": "zhangsan", "templateId": 12345, "supplierSort": 1, "financeAuditorDate": "@date", "financeId":123, "financeName":"财务管理账户名称", "supplier": { "code": "zhangsan", "invoiceName": "zhangsan", "city": "zhangsan", "modifierId": 12345, "remark": "zhangsan", "categoryName": "zhangsan", "accountBank": "zhangsan", "province": "zhangsan", "modified": "@date", "id": 12345, "createrId": 12345, "fax": "zhangsan", "email": "zhangsan", "qq": "zhangsan", "zip": "zhangsan", "bankNumber": "zhangsan", "address": "zhangsan", "alipay": "zhangsan", "contactName": "zhangsan", "webAddress": "zhangsan", "created": "@date", "billType": "zhangsan", "mobile": "zhangsan", "wechat": "zhangsan", "tax": "zhangsan", "createrName": "zhangsan", "planReceiveDay": 1, "companyId": 12345, "phone": "zhangsan", "taxId": "zhangsan", "memoni": "zhangsan", "district": "zhangsan", "name": "zhangsan", "modifierName": "zhangsan", "categoryId": "zhangsan", "status": 1 }, "modified": "@date", "id": 12345, "createrId": 12345, "arriveRegisteredTime": "@date", "arriveRegisteredBy": 12345, "itemNumType": 1, "deliveryDateType": 1, "created": "@date", "autoRemark": true, "createrName": "zhangsan", "outSid": "zhangsan", "totalAmount": 10000, "companyId": 12345, "otherAmount": 10000, "auditorId": 12345, "financeAuditorId": 12345, "oldStatus": "zhangsan", "auditorRemark": "zhangsan", "receiveWarehouseName": "zhangsan", "warehouseType": 1, "enableStatus": 1, "auditorDate": "@date", "status": "zhangsan", "getGoodsStatus": "zhangsan", "sourceOrderId": "zhangsan", "totalDetailAmount": 10000, "code": "zhangsan", "supplierId": 12345, "flag": 1, "freight": 10000, "actualReceiveNum": 12345, "remark": "zhangsan", "supplierCode": "zhangsan", "purchaseType": "zhangsan", "actualTotalAmount": 10000, "financeAuditorRemark": "zhangsan", "expressCompany": "zhangsan", "printBy": 12345, "deliveryDate": "@date", "auditorName": "zhangsan", "purchaseReturnNum": 12345, "supplierName": "zhangsan", "isFinishProduct": true, "quantity": 12345, "financeAuditorName": "zhangsan", "warehouseExternalCode": "zhangsan", "arrivedQuantity": 12345, "billType": "zhangsan", "receivedAmount": 10000, "cancelQuantity": 12345, "receiveQuantity": 12345, "receiveQuantityInc": 12345, "templateName": "zhangsan", "contractRemark": "zhangsan", "skuSizeSort": 1, "purchaseReturnWeNum": 12345, "finishDate": "@date", "suitStatus": 1, "logisticsType": 1, "printTime": "@date", "weFinishStatus": 1 } ] } ```

异常示例

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

错误码解释

| 错误码 |错误信息|解决方案| |-|-|-| |25|服务方法(purchase.order.query:1.0)的签名无效|签名参数错误|