当前位置: API文档

接口说明

查询慧经营已结账&对账成功的退款数据汇总。

调用场景

财务软件对接生成收款退款单。

请求地址

环境奇门地址服务名

测试环境

http://332wh0cyoi.api.taobao.com/router/qmtest

wdt.hjy.recon.dztk.summary.query

生产环境

http://332wh0cyoi.api.taobao.com/router/qm

请求方式

 POST

请求参数

参数名称参数类型是否必选参数描述示例

hjySign

String

慧经营参数签名

e549e097f97123bc7fa3cfc1354796b2

appId

String

租户应用标识

b018b1134f854fb48019d47dd424e5f9

sid

String

卖家账号

hjy001

nextRequestId

String

每页200条,用于分页,查询时返回,下一页查询时传入,返回false,说明查询结束

1760506606618202114

periodMark

String

对账标识,与对账周期时间不能同时为空

1代表最后一个已结账对账周期,最大为3

startDate

String

账期开始日期,需要与账期结束日期一起传

2023-03-21

endDate

String

账期结束日期,需要与账期开始日期一起传

2023-03-21

refundTypes

String[]

退款类型,可以批量

["已取消","退货入库","仅退款"]

shopNos

String[]

店铺编码

["Db001"]

响应数据

公共响应数据

参数名称参数类型是否必选参数描述参数示例

resultCode

String

业务响应码

200

message

String

业务响应码描述

success

sub_resultCode

String

二级响应码

""

sub_detail

String

二级响应码描述

""

solution

String

解决方案

""

nextRequestId

String

默认一页200条。每次查询返回一个值,客户需要用这个值再查,如果返回 false 说明查询结束

1760506606618202114

data

Object[]

返回结果数据

[]

业务响应数据:data

参数名称参数类型是否必选参数描述参数示例

shopNo

String

店铺编码

Db001

shopName

String

店铺名称

第一个店铺

periodStartDate

String

账期开始日期

2023-03-21

periodEndDate

String

账期结束日期

2023-03-22

summaryNo

String

汇总单号

HZBH0001

refundType

String

退款类型

已取消

summaryAmount

String

退款金额

30.0000

请求demo

{
    "endDate": "2024-03-31",
    "appId": "fa330697b64a49a9a4f6fe6b7fef57a7",
    "shopNos": [
        "01000011801"
    ],
    "refundTypes": [
        "退货退款"
    ],
    "periodMark": "1",
    "startDate": "2023-10-01",
    "sid": "hjytest41"
}

响应demo

{
    "response": {
        "data": [
            {
                "periodStartDate": "2023-10-01",
                "refundType": "已取消",
                "shopName": "shopname3",
                "summaryAmount": "-90.0",
                "summaryNo": "TKHZ595677185854280346",
                "shopNo": "0100001180",
                "periodEndDate": "2024-03-31"
            }
        ],
        "message": "接口调用成功",
        "nextRequestId": "false",
        "resultCode": "200",
        "solution": "",
        "sub_detail": "业务处理成功",
        "sub_resultCode": "SUCCESS"
    }
}


常用工具