文档中心 > API类目 > 本地生活广告API

alibaba.alsc.union.kbcpx.refund.order.get (本地生活媒体推广用户维权订单数据报表)

本地生活媒体推广用户维权订单数据报表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
date_type Number 必须 1
  • 默认值:1
  • 时间维度,1.订单结算时间 2.维权创建时间 3.维权完成时间 4更新时间
    end_date String 可选 2021-09-14 10:00:00 查询截止时间
    biz_unit Number 必须 1
  • 默认值:1
  • 1-CPA 2-CPS
    page_size Number 必须 10
  • 默认值:10
  • 每页返回数据大小,默认10,最大返回50
    page_number Number 必须 1
  • 默认值:1
  • 页码,默认第一页,取值范围1~50
    start_date String 必须 2021-09-14 10:00:00 查询起始时间
    flow_type String 可选 1 场景值,支持多场景(英文逗号分隔)查询7卡券订单,8卡券核销订单,10-媒体出资CPS红包,11-媒体出资霸王餐加码红包
    pid String 可选 alsc_0000_1111_2222 推广位pid
    order_id String 可选 2022111xxxx 淘宝子订单号或饿了么订单号

    响应参数

    名称 类型 示例值 描述
    result RefundOrderDetailReportDTO [] [] 用户维权订单list
    • └ title
    • String
    • 商品标题
    • 商品标题
    • └ pic_url
    • String
    • https://xxx
    • 商品图片url
    • └ shop_name
    • String
    • 店铺名称
    • 店铺名称
    • └ pay_amount
    • String
    • 30.00
    • 付款金额
    • └ settle_time
    • String
    • 2021-09-01 10:00:00
    • 订单结算时间
    • └ explain_start_time
    • String
    • 2021-09-01 10:00:00
    • 维权创建时间
    • └ explain_end_time
    • String
    • 2021-09-10 10:00:00
    • 维权结束时间
    • └ biz_order_id
    • String
    • 123456789
    • 淘宝子单号
    • └ parent_order_id
    • String
    • 123456789
    • 淘宝主单号
    • └ main_item_id
    • String
    • 123456789
    • 主商品ID,针对CPS订单
    • └ main_item_title
    • String
    • 主商品信息
    • 主商品信息,针对CPS订单
    • └ explain_state
    • Number
    • 0
    • 维权状态,0-维权成功 1-维权创建 2-维权关闭 3-维权失败
    • └ return_commission_state
    • Number
    • 0
    • 维权成功后的佣金返回状态 0-待返回 1-已返回
    • └ refund_amount
    • String
    • 30.00
    • 维权退款金额
    • └ settle
    • String
    • 28.00
    • 应返回商家金额
    • └ gmt_modified
    • String
    • 2021-09-01 10:00:00
    • 更新时间
    • └ sid
    • String
    • 123
    • 会员标识(开通SID权限后下单返回)
    • └ platform_type
    • Number
    • 1
    • 1口碑,2饿了么
    • └ activity_id
    • Number
    • 12
    • 活动ID
    • └ pid
    • String
    • alsc_xxx_xxx_xxx
    • pid
    • └ relation_order_id
    • Number
    • 2239121
    • 卡券订单号
    • └ flow_type
    • Number
    • 1
    • 场景值,7卡券订单,8卡券核销订单。16/17囤券券订单,18囤券券外卖订单
    • └ activity_info_remark_list
    • String
    • null
    • 活动信息明细
    • └ channel_right_id
    • String
    • 1234
    • 权益ID(flow_type=10或11时为媒体出资活动ID)
    • └ ext_info
    • String
    • null
    • 订单扩展信息
    result_success Boolean true 接口返回是否正确
    biz_error_desc String 入参不能为空 接口错误描述
    total_count Number 100 当前查询条件下总的记录
    biz_error_code Number 201 接口错误码

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    AlibabaAlscUnionKbcpxRefundOrderGetRequest req = new AlibabaAlscUnionKbcpxRefundOrderGetRequest();
    req.setDateType(1L);
    req.setEndDate("2021-09-14 10:00:00");
    req.setBizUnit(1L);
    req.setPageSize(10L);
    req.setPageNumber(1L);
    req.setStartDate("2021-09-14 10:00:00");
    req.setFlowType("1");
    req.setPid("alsc_0000_1111_2222");
    req.setOrderId("2022111xxxx");
    AlibabaAlscUnionKbcpxRefundOrderGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alibaba_alsc_union_kbcpx_refund_order_get_response>
        <result>
            <refund_order_detail_report_d_t_o>
                <title>商品标题</title>
                <pic_url>https://xxx</pic_url>
                <shop_name>店铺名称</shop_name>
                <pay_amount>30.00</pay_amount>
                <settle_time>2021-09-01 10:00:00</settle_time>
                <explain_start_time>2021-09-01 10:00:00</explain_start_time>
                <explain_end_time>2021-09-10 10:00:00</explain_end_time>
                <biz_order_id>123456789</biz_order_id>
                <parent_order_id>123456789</parent_order_id>
                <main_item_id>123456789</main_item_id>
                <main_item_title>主商品信息</main_item_title>
                <explain_state>0</explain_state>
                <return_commission_state>0</return_commission_state>
                <refund_amount>30.00</refund_amount>
                <settle>28.00</settle>
                <gmt_modified>2021-09-01 10:00:00</gmt_modified>
                <sid>123</sid>
                <platform_type>1</platform_type>
                <activity_id>12</activity_id>
                <pid>alsc_xxx_xxx_xxx</pid>
                <relation_order_id>2239121</relation_order_id>
                <flow_type>1</flow_type>
                <activity_info_remark_list>null</activity_info_remark_list>
                <channel_right_id>1234</channel_right_id>
                <ext_info>null</ext_info>
            </refund_order_detail_report_d_t_o>
        </result>
        <result_success>true</result_success>
        <biz_error_desc>入参不能为空</biz_error_desc>
        <total_count>100</total_count>
        <biz_error_code>201</biz_error_code>
    </alibaba_alsc_union_kbcpx_refund_order_get_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部