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

分页查询采购退单列表

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

createTimeBegin

number

可选

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

createTimeEnd

number

可选

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

currentPage

number

页码，默认1

可选

modifyTimeBegin

number

可选

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

modifyTimeEnd

number

可选

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

orderAuditTimeBegin

number

可选

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

orderAuditTimeEnd

integer

可选

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

orderCodes

array[string]

可选

code列表，最多支持50个

orderStatus

array[string]

可选

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

枚举值:

ORDER_AUDIT_PENDINGAUDITEDRECEIPT_AUDIT_PENDINGFINISHEDCANCELLED

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 (开放接口-详细采购退单信息) {23}]

可选

buyer

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

可选

createId

integer <int64>

制单人id

可选

createName

string

制单人姓名

可选

createTime

string <date-time>

创建时间

可选

integer <int64>

可选

lowerReturnOrderCode

string

可选

上游退单时源退货单单号，关联对应下游客户的退单号

modifyTime

string <date-time>

修改时间

可选

orderAttachments

array[object (开放接口-退单附件信息) {10}]

退单附件

可选

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: 待审核, RECEIPT_AUDIT_PENDING：待收货审核, AUDITED: 已审核, FINISHED: 已完成, SUBMIT_PENDING: 待提交, CANCELLED: 已作废

枚举值:

ORDER_AUDIT_PENDINGRECEIPT_AUDIT_PENDINGAUDITEDFINISHEDSUBMIT_PENDINGCANCELLED

orderTotalAmount

number

结算总额

可选

otherAmount

number

其他费用

可选

paymentStatus

enum<string>

可选

退款状态 WAIT_PAY: 待支付, PAID: 已支付, PART_PAID: 部分支付

枚举值:

WAIT_PAYPAIDPART_PAID

productTotalAmount

number

商品小计总额

可选

seller

object (供应商简要信息)

供应商信息

可选

signNumber

number

订货单位已出库数量

可选

signNumberPending

number

订货单位待出库数量

可选

stockOutStatus

enum<string>

可选

出库状态 NONE: 未入库, PART: 部分入库, FULL: 已入库

枚举值:

NONEPARTFULL

pageSize

integer <int32>

可选

totalCount

integer <int64>

可选

totalPage

integer <int64>

可选

示例

{
  "currentPage": 0,
  "items": [
    {
      "buyer": {
        "code": "string",
        "id": 0,
        "name": "string"
      },
      "createId": 0,
      "createName": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "id": 0,
      "lowerReturnOrderCode": "string",
      "modifyTime": "2019-08-24T14:15:22Z",
      "orderAttachments": [
        {
          "createId": 0,
          "createName": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "fileName": "string",
          "fileSize": 0,
          "fileType": "string",
          "fileUrl": "string",
          "id": 0,
          "modifyTime": "2019-08-24T14:15:22Z",
          "orderCode": "string"
        }
      ],
      "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,
      "paymentStatus": "WAIT_PAY",
      "productTotalAmount": 0,
      "seller": {
        "code": "string",
        "id": 0,
        "name": "string"
      },
      "signNumber": 0,
      "signNumberPending": 0,
      "stockOutStatus": "NONE"
    }
  ],
  "pageSize": 0,
  "totalCount": 0,
  "totalPage": 0
}