商家退单列表 - 铱云开放API 2.0

请求参数

Header 参数

access_token

string

必需

oauth2接口获取的access_token

x-client-id

string

必需

申请对接时的clientId

Body 参数application/json

createTimeBegin

string <date-time>

可选

订单创建时间(开始时间)

createTimeEnd

string <date-time>

可选

订单创建时间(结束时间)

currentPage

integer <int32>

当前页，默认：1

可选

modifyTimeBegin

string <date-time>

可选

订单修改时间(开始时间)

modifyTimeEnd

string <date-time>

可选

订单修改时间(结束时间)

orderAuditTimeBegin

string <date-time>

可选

订单审核时间(开始时间)

orderAuditTimeEnd

string <date-time>

可选

订单审核时间(结束时间)

orderCodes

array[string]

可选

code列表，最多支持50个

orderStatus

array[string]

可选

退单状态，如果不指定就是全查

枚举值:

AUDITEDCANCELLEDFINISHEDINITIALIZEDORDER_AUDIT_PENDINGRECEIPT_AUDIT_PENDINGSUBMIT_PENDING

pageSize

integer <int32>

可选

每页大小，默认：20，最大100

<= 100

paymentStatuses

array[string]

可选

付款状态，如果不指定就是全查

枚举值:

PAIDPAID_CHECKINGPART_PAIDWAIT_PAY

receiveStatus

array[string]

可选

发货状态，如果不指定就是全查

枚举值:

FULLNONEPART

sellerIds

array[integer <int64>]

可选

商家id列表，如果不指定就是全查

withAttachments

boolean

可选

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

withDetails

boolean

可选

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

withRemarks

boolean

可选

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

示例

{
    "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": "2019-08-24T14:15:22Z",
    "orderAuditTimeEnd": "2019-08-24T14:15:22Z",
    "orderCodes": [
        "string"
    ],
    "orderStatus": [
        "AUDITED"
    ],
    "pageSize": 100,
    "paymentStatuses": [
        "PAID"
    ],
    "receiveStatus": [
        "FULL"
    ],
    "sellerIds": [
        0
    ],
    "withAttachments": true,
    "withDetails": true,
    "withRemarks": true
}

返回响应

🟢200OK

application/json

Body

currentPage

integer <int32>

可选

items

array [object {29}]

可选

buyer

object

可选

createId

integer <int64>

制单人id

可选

createName

string

制单人姓名

可选

createTime

string <date-time>

创建时间

可选

deliveryStatus

enum<string>

可选

退货或收货状态: 买方视角是退货状态，卖方视角是收货状态，UNRETURN：未退货；RETURNED：已退货；UNRECEIVE：未收货；RECEIVED：已收货；WAIT_RECEIVE：待收货。注意：买方（下退单的机构）：未退货，已退货，卖方：未收货，待收货，已收货

枚举值:

RECEIVEDRETURNEDUNRECEIVEUNRETURNWAIT_RECEIVE

integer <int64>

可选

lowerReturnOrderCode

string

可选

上游退单时源退货单单号

lowerReturnStorageBillNum

string

可选

上游退单时源退货单入库单号

modifyTime

string <date-time>

修改时间

可选

orderAuditTime

string <date-time>

退单审核时间

可选

orderAuditor

string

退单审核人

可选

orderAuditorId

integer <int64>

退单审核人id

可选

orderCode

string

订单号

可选

orderDetails

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

退单详情

可选

orderRemarks

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

退单备注

可选

orderSource

enum<string>

订单来源

可选

枚举值:

APPPOSWEBWECHAT

orderStatus

enum<string>

订单状态

可选

枚举值:

AUDITEDCANCELLEDFINISHEDINITIALIZEDORDER_AUDIT_PENDINGRECEIPT_AUDIT_PENDINGSUBMIT_PENDING

orderTotalAmount

number

结算总额

可选

orderType

enum<string>

退单类型

可选

枚举值:

ALLOTMENTMERCHANTNORMALNORMAL_DEPRECATEDPURCHASE

originalOrderCode

string

可选

源单号，直发采购退单/商家退单时有值

otherAmount

number

其他费用

可选

paymentStatus

enum<string>

退款状态

可选

枚举值:

PAIDPAID_CHECKINGPART_PAIDWAIT_PAY

productTotalAmount

number

商品小计总额

可选

receivableAmount

number

应收应付金额

可选

receiveStatus

enum<string>

可选

收货状态，使用出库枚举表示

枚举值:

FULLNONEPART

relatedCode

string

可选

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

seller

object

可选

sourceBuyerName

string

原订单买方名称

可选

sourceCreatorName

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",
            "deliveryStatus": "RECEIVED",
            "id": 0,
            "lowerReturnOrderCode": "string",
            "lowerReturnStorageBillNum": "string",
            "modifyTime": "2019-08-24T14:15:22Z",
            "orderAuditTime": "2019-08-24T14:15:22Z",
            "orderAuditor": "string",
            "orderAuditorId": 0,
            "orderCode": "string",
            "orderDetails": [
                {
                    "auxUnitId": 0,
                    "auxUnitName": "string",
                    "auxUnitNumbers": 0,
                    "auxUnitNumbersAuxUnitName": "string",
                    "baseUnitId": 0,
                    "baseUnitName": "string",
                    "baseUnitNumbers": 0,
                    "brandId": 0,
                    "brandName": "string",
                    "categoryId": 0,
                    "categoryIds": [
                        0
                    ],
                    "categoryName": "string",
                    "categoryNames": [
                        "string"
                    ],
                    "combinationProductExt": "string",
                    "combinationProductUnitId": 0,
                    "createTime": "2019-08-24T14:15:22Z",
                    "customPrice": true,
                    "discountAmount": 0,
                    "id": 0,
                    "initialPrice": 0,
                    "modifyTime": "2019-08-24T14:15:22Z",
                    "orderCode": "string",
                    "originalPrice": 0,
                    "productBarCode": "string",
                    "productCode": "string",
                    "productImageUrl": "string",
                    "productName": "string",
                    "productNameWithCodeAndSpecText": "string",
                    "productNameWithSpecText": "string",
                    "productShortName": "string",
                    "productSku": 0,
                    "productSpec": "string",
                    "productSpecText": "string",
                    "productSpu": 0,
                    "productType": "COMBO",
                    "purchaseNumbers": 0,
                    "rate": 0,
                    "remark": "string",
                    "salePrice": 0,
                    "saleRate": 0,
                    "shelfStatus": 0,
                    "shortCode": "string",
                    "skuStatus": 0,
                    "sortingTagId": 0,
                    "sortingTagName": "string",
                    "subtotal": 0,
                    "type": "MANUAL_GIFT",
                    "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"
                }
            ],
            "orderSource": "APP",
            "orderStatus": "AUDITED",
            "orderTotalAmount": 0,
            "orderType": "ALLOTMENT",
            "originalOrderCode": "string",
            "otherAmount": 0,
            "paymentStatus": "PAID",
            "productTotalAmount": 0,
            "receivableAmount": 0,
            "receiveStatus": "FULL",
            "relatedCode": "string",
            "seller": {
                "id": 0,
                "code": "string",
                "name": "string"
            },
            "sourceBuyerName": "string",
            "sourceCreatorName": "string"
        }
    ],
    "pageSize": 0,
    "totalCount": 0,
    "totalPage": 0
}