退单列表 - 铱云开放API 2.0

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

buyerIds

array[integer <int64>]

可选

退货方机构id，数组

orderCodes

array[string]

退单号集合，数值

可选

createTimeBegin

string <date-time>

可选

退单创建时间(开始时间)，毫秒时间戳，开始时间及结束时间不能超1年

createTimeEnd

string <date-time>

可选

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

currentPage

integer <int32>

当前页，默认：1

可选

modifyTimeBegin

string <date-time>

可选

退单修改时间(开始时间)，毫秒时间戳，开始时间及结束时间不能超1年

modifyTimeEnd

string <date-time>

可选

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

orderAuditTimeBegin

integer

可选

订单审核时间(开始时间)，毫秒时间戳，开始时间及结束时间不能超1年

orderAuditTimeEnd

integer

可选

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

orderStatus

array[string]

可选

退单状态，如果不指定就是全查 ORDER_AUDIT_PENDING:待审核 AUDITED:审核通过 FINISHED:已完成 SUBMIT_PENDING:待提交 CANCELLED:已取消 RECEIPT_AUDIT_PENDING:待收货审核

枚举值:

ORDER_AUDIT_PENDINGAUDITEDFINISHEDSUBMIT_PENDINGCANCELLEDRECEIPT_AUDIT_PENDING

pageSize

integer <int32>

可选

每页大小，默认：20，最大支持50

sort

string

可选

排序列名:排序方式 column1:asc,column2:desc，暂只支持：createTime:desc|createTime:asc

withDetails

boolean

可选

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

withRemarks

boolean

可选

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

示例

{
  "buyerIds": [
    0
  ],
  "orderCodes": [
    "string"
  ],
  "createTimeBegin": "2019-08-24T14:15:22Z",
  "createTimeEnd": "2019-08-24T14:15:22Z",
  "currentPage": 0,
  "modifyTimeBegin": "2019-08-24T14:15:22Z",
  "modifyTimeEnd": "2019-08-24T14:15:22Z",
  "orderAuditTimeBegin": 0,
  "orderAuditTimeEnd": 0,
  "orderStatus": [
    "ORDER_AUDIT_PENDING"
  ],
  "pageSize": 0,
  "sort": "string",
  "withDetails": true,
  "withRemarks": true
}

返回响应

🟢200OK

application/json

Body

currentPage

integer <int32>

可选

items

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

可选

buyer

object

可选

createId

integer <int64>

制单人id

可选

createName

string

制单人姓名

可选

createTime

string <date-time>

创建时间

可选

integer <int64>

可选

modifyTime

string <date-time>

修改时间

可选

orderAuditTime

string <date-time>

退单审核时间

可选

orderAuditor

string

退单审核人

可选

orderAuditorId

integer <int64>

退单审核人id

可选

orderCode

string

订单号，唯一标识

可选

orderDetails

array[object (开放接口-退单商品信息) {28}]

退单详情

可选

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

退单金额

可选

paymentStatus

enum<string>

可选

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

枚举值:

WAIT_PAYPAIDPART_PAID

relatedCode

string

可选

关联单据编码（按原单退货对应来源订单）

storageBillNum

string

可选

出库单号,按出库单退货时有值

pageSize

integer <int32>

可选

totalCount

integer <int64>

可选

totalPage

integer <int64>

可选

示例

{
  "currentPage": 0,
  "items": [
    {
      "buyer": {
        "id": 0,
        "code": "string",
        "name": "string"
      },
      "createId": 0,
      "createName": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "id": 0,
      "modifyTime": "2019-08-24T14:15:22Z",
      "orderAuditTime": "2019-08-24T14:15:22Z",
      "orderAuditor": "string",
      "orderAuditorId": 0,
      "orderCode": "string",
      "orderDetails": [
        {
          "auditRemark": "string",
          "createTime": "2019-08-24T14:15:22Z",
          "discountAmount": 0,
          "id": 0,
          "modifyTime": "2019-08-24T14:15:22Z",
          "orderCode": "string",
          "originalPrice": 0,
          "productCode": "string",
          "productName": "string",
          "productSku": 0,
          "productSpu": 0,
          "reasonId": 0,
          "reasonName": "string",
          "remark": "string",
          "salePrice": 0,
          "saleRate": 0,
          "subtotal": 0,
          "type": "NORMAL",
          "rate": 0,
          "baseUnitId": 0,
          "baseUnitName": "string",
          "baseUnitNumbers": 0,
          "unitId": 0,
          "unitName": "string",
          "purchaseNumbers": 0,
          "auxUnitId": 0,
          "auxUnitName": "string",
          "auxUnitNumbers": 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,
      "paymentStatus": "WAIT_PAY",
      "relatedCode": "string",
      "storageBillNum": "string"
    }
  ],
  "pageSize": 0,
  "totalCount": 0,
  "totalPage": 0
}