采购订单列表 - 铱云开放API 2.0

分页查询采购订单列表

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

开放接口采购订单查询参数

createTimeBegin

number

可选

订单创建时间(开始时间)毫秒时间戳,如果不传任何任何时间(创建,修改，审核)，默认查询3个月的单

createTimeEnd

number

可选

订单创建时间(结束时间)毫秒时间戳

currentPage

integer <int32>

页码，默认1

可选

modifyTimeBegin

number

可选

订单修改时间(开始时间)毫秒时间戳

modifyTimeEnd

number

可选

订单修改时间(结束时间)毫秒时间戳

orderAuditTimeBegin

number

可选

订单审核时间(开始时间)毫秒时间戳

orderAuditTimeEnd

number

可选

订单审核时间(结束时间)毫秒时间戳

orderCodes

array[string]

可选

code列表，最多支持50个

orderStatus

array[string]

可选

订单状态，如果不指定就是全查， ORDER_AUDIT_PENDING：待订单审核 AUDITED：已审核 FINISHED：已完成 CANCELLED：已作废

枚举值:

ORDER_AUDIT_PENDINGAUDITEDFINISHEDCANCELLED

pageSize

integer <int32>

可选

页大小，默认20，最大50

sellerIds

array[integer <int64>]

可选

供应商id列表，如果不指定就是全查，最多支持50个

withAttachments

boolean

可选

是否附带查询订单附件列表

withDetails

boolean

可选

是否附带查询订单商品列表

withRemarks

boolean

可选

是否附带查询订单备注列表

示例

{
  "createTimeBegin": 0,
  "createTimeEnd": 0,
  "currentPage": 0,
  "modifyTimeBegin": 0,
  "modifyTimeEnd": 0,
  "orderAuditTimeBegin": 0,
  "orderAuditTimeEnd": 0,
  "orderCodes": [
    "string"
  ],
  "orderStatus": [
    "ORDER_AUDIT_PENDING"
  ],
  "pageSize": 0,
  "sellerIds": [
    0
  ],
  "withAttachments": true,
  "withDetails": true,
  "withRemarks": true
}

返回响应

🟢200OK

application/json

Body

currentPage

integer <int32>

可选

items

array[object (开放接口-详细采购订单信息) {35}]

可选

addressDetail

string

收货地址-详细地址

可选

buyer

object (开放接口-机构信息)

可选

cityId

integer <int64>

可选

收货地址-地级市区域id

contactName

string

收货联系人

可选

contactPhone

string

收货联系人联系电话

可选

countryId

integer <int64>

可选

收货地址-国家级区域id

createId

integer <int64>

制单人id

可选

createName

string

制单人姓名

可选

createTime

string <date-time>

创建时间

可选

modifyTime

string <date-time>

更新时间

必需

deliveryAddress

string

可选

收货地址，保持与BO字段名称一致

districtId

integer <int64>

可选

收货地址-县级区域id

integer <int64>

可选

isClose

boolean

订单是否关闭

可选

orderAttachments

array [object {8}]

可选

订单附件，如果不指明查询便不会返回

orderAuditTime

string <date-time>

订单审核时间

可选

orderAuditor

string

订单审核人

可选

orderAuditorId

integer <int64>

订单审核人id

可选

orderCode

string

订单号，唯一标识

可选

orderDetails

array[object (开放接口-采购订单商品信息) {37}]

可选

订单详情，如果不指明查询便不会返回

orderRemarks

array[object (开放接口-订单备注信息) {5}]

可选

订单备注，如果不指明查询便不会返回

orderStatus

enum<string>

可选

采购订单状态限制在 ORDER_AUDIT_PENDING：待订单审核 AUDITED：已审核 FINISHED：已完成 CANCELLED：已作废

枚举值:

ORDER_AUDIT_PENDINGAUDITEDFINISHED

orderTotalAmount

number

结算总额

可选

otherAmount

number

其他费用

可选

paidAmount

number

已支付金额

可选

paymentStatus

enum<string>

可选

支付状态 UN_PAID：未支付， PART_PAID：部分支付， PAID：已支付

枚举值:

UN_PAIDPART_PAIDPAID

productTotalAmount

number

商品小计总额

可选

provinceId

integer <int64>

可选

收货地址-省级行政区域id

seller

object (供应商简要信息)

供应商信息

可选

signStatus

enum<string>

可选

签收状态，同时表示采购入库的状态 NONE：未入库 PART：部分入库 FULL：已入库

枚举值:

NONEPARTFULL

yjdfRelatedCode

string

可选

被代发/直发单号，例如客户订单号

yjdfType

enum<string>

可选

代发/直发类型, NO:未直发, ZF:直发

枚举值:

NOZF

supplierAuditStatus

string

可选

供应商审核状态NONE:待确认 CONFIRMED:已确认 REFUSE:已拒绝

warehouseId

integer

下单仓库id

必需

warehouseName

string

下单仓库名称

可选

pageSize

integer <int32>

可选

totalCount

integer <int64>

可选

totalPage

integer <int64>

可选

示例

{
  "currentPage": 0,
  "items": [
    {
      "addressDetail": "string",
      "buyer": {
        "code": "string",
        "id": 0,
        "name": "string"
      },
      "cityId": 0,
      "contactName": "string",
      "contactPhone": "string",
      "countryId": 0,
      "createId": 0,
      "createName": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "modifyTime": "2019-08-24T14:15:22Z",
      "deliveryAddress": "string",
      "districtId": 0,
      "id": 0,
      "isClose": true,
      "orderAttachments": [
        {
          "createId": 0,
          "createName": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "fileName": "string",
          "fileSize": 0,
          "fileType": "string",
          "fileUrl": "string",
          "id": 0
        }
      ],
      "orderAuditTime": "2019-08-24T14:15:22Z",
      "orderAuditor": "string",
      "orderAuditorId": 0,
      "orderCode": "string",
      "orderDetails": [
        {
          "auxUnitId": 0,
          "auxUnitName": "string",
          "auxUnitNumbers": 0,
          "baseUnitId": 0,
          "baseUnitName": "string",
          "baseUnitNumbers": 0,
          "brandId": 0,
          "brandName": "string",
          "categoryId": 0,
          "categoryName": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "discountAmount": 0,
          "id": 0,
          "modifyTime": "2019-08-24T14:15:22Z",
          "orderCode": "string",
          "originalPrice": 0,
          "productBarCode": "string",
          "productCode": "string",
          "productImageUrl": "string",
          "productName": "string",
          "productShortName": "string",
          "productSku": 0,
          "productSpec": "string",
          "productSpu": 0,
          "type": "NORMAL",
          "purchaseNumbers": 0,
          "rate": 0,
          "remark": "string",
          "salePrice": 0,
          "saleRate": 0,
          "shortCode": "string",
          "signAuxNumber": 0,
          "signNumber": 0,
          "subtotal": 0,
          "unitId": 0,
          "unitName": "string",
          "weight": 0
        }
      ],
      "orderRemarks": [
        {
          "content": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "id": 0,
          "modifyTime": "2019-08-24T14:15:22Z",
          "orderCode": "string"
        }
      ],
      "orderStatus": "ORDER_AUDIT_PENDING",
      "orderTotalAmount": 0,
      "otherAmount": 0,
      "paidAmount": 0,
      "paymentStatus": "UN_PAID",
      "productTotalAmount": 0,
      "provinceId": 0,
      "seller": {
        "code": "string",
        "id": 0,
        "name": "string"
      },
      "signStatus": "NONE",
      "yjdfRelatedCode": "string",
      "yjdfType": "NO",
      "supplierAuditStatus": "string",
      "warehouseId": 0,
      "warehouseName": "string"
    }
  ],
  "pageSize": 0,
  "totalCount": 0,
  "totalPage": 0
}