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

alibaba.alsc.union.kbcpx.positive.order.get (本地生活媒体推广订单明细报表查询)

本地生活媒体推广订单明细报表查询。如果只关注佣金,看income和settle字段。业务主键:biz_unit+biz_order_id

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
date_type Number 必须 1
  • 默认值:1
  • 时间维度,1-付款时间 2-创建时间 3-结算时间 4-更新时间
    settle_state Number 可选 1 结算状态,1-已结算 2-未结算 不传-全部状态
    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
  • 页码,默认第一页
    start_date String 必须 2021-09-14 10:00:00 查询起始时间,精确到时分秒
    order_state Number 可选 2 订单状态,0-已失效 1-已下单 2-已付款 4-已收货 不传-全部状态
    flow_type String 可选 1 场景值,支持多场景(英文逗号分隔)查询7卡券订单,8卡券核销订单,10-媒体出资CPS红包,11-媒体出资霸王餐加码红包,26-评价有礼订单
    pid String 可选 alsc_0000_1111_2222 推广位pid
    order_id String 可选 2022111xxxx 淘宝子订单号或饿了么订单号
    include_used_store_id Boolean 可选 false 是否包含核销门店

    响应参数

    名称 类型 示例值 描述
    result OrderDetailReportDTO [] [] 所有订单list
    • └ title
    • String
    • 商品标题
    • 商品标题
    • └ pic_url
    • String
    • https://xxx
    • 商品图片下载url
    • └ shop_name
    • String
    • xxx店
    • 店铺名称
    • └ pay_amount
    • String
    • 30.00
    • 付款金额
    • └ settle_amount
    • String
    • 28.00
    • 结算金额,针对CPS订单
    • └ trace_time
    • String
    • 2021-09-01 10:00:00
    • 点击时间
    • └ tk_create_time
    • String
    • 2021-09-01 10:00:00
    • 创建时间
    • └ pay_time
    • String
    • 2021-09-01 10:00:00
    • 付款时间
    • └ receive_time
    • String
    • 2021-09-01 10:00:00
    • 收货时间
    • └ settle_time
    • String
    • 2021-09-01 11:00:00
    • 结算时间
    • └ income
    • String
    • 28.00
    • 预估收入。预估到手的佣金,包含技术服务费。付款之后有值。没结算之前只有income有值
    • └ settle
    • String
    • 24.00
    • 结算预估收入。最终到手的佣金,没有扣除技术服务;结算之后有值
    • └ item_id
    • String
    • 123456789
    • 商品ID
    • └ product_num
    • Number
    • 5
    • 商品数量
    • └ unit_price
    • String
    • 10.00
    • 商品单价
    • └ category_name
    • String
    • 商品类目
    • 商品类目
    • └ biz_order_id
    • Number
    • 123456789
    • 淘宝子单号。biz_order_id+biz_unit是联合主键
    • └ parent_order_id
    • Number
    • 123456789
    • 淘宝主单号
    • └ main_item_id
    • String
    • 123456789
    • 主商品ID,针对CPS订单
    • └ main_item_title
    • String
    • 主商品名称
    • 主商品名称,针对CPS订单
    • └ order_state
    • Number
    • 2
    • 订单状态,0-已失效 1-已下单 2-已付款 4-已收货
    • └ order_item_status_name
    • String
    • 售中退款
    • 订单补充状态,针对CPS订单,考虑到存在已付款的cps订单发生售中退款,不参与结算的情况需要渠道知晓
    • └ settle_state
    • Number
    • 1
    • 结算状态,1-已结算; 2-未结算;-99无需结算
    • └ full_settle_amount
    • String
    • 28.00
    • 结算基数,针对CPS订单,等于付款金额+平台补贴
    • └ commission_rate
    • String
    • 10%
    • 佣金比率,针对CPS订单
    • └ commission_fee
    • String
    • 10.00
    • 佣金金额,针对CPS订单
    • └ subsidy_rate
    • String
    • 5%
    • 补贴比率,针对CPS订单
    • └ subsidy_fee
    • String
    • 5.00
    • 补贴金额
    • └ income_rate
    • String
    • 15%
    • 收入比率,针对CPS订单,等于佣金比率+补贴比率
    • └ stratify_rate
    • String
    • 100%
    • 分成比率,针对CPS订单
    • └ deduct_rate
    • String
    • 15%
    • 提成,针对CPS订单,等于收入比率*分成比率
    • └ platform_commission_rate
    • String
    • 10%
    • 技术服务费率
    • └ platform_commission_fee
    • String
    • 10
    • 技术服务费
    • └ channel_rate
    • String
    • 0%
    • 淘宝直播费率,针对CPS订单
    • └ channel_fee
    • String
    • 0
    • 淘宝直播费,针对CPS订单
    • └ media_id
    • String
    • 12345678
    • 媒体ID
    • └ media_name
    • String
    • 媒体名称
    • 媒体名称
    • └ ad_zone_id
    • String
    • 12345678
    • 推广位ID
    • └ ad_zone_name
    • String
    • 推广位名称
    • 推广位名称
    • └ activity_fee
    • String
    • 12.0
    • 招商服务费
    • └ activity_service_fee
    • String
    • 2.4
    • 招商服务费中的技术服务费
    • └ activity_service_rate
    • String
    • 0.2
    • 招商服务费中的技术服务率
    • └ gmt_modified
    • String
    • 2021-09-01 10:00:00
    • 更新时间
    • └ tag
    • String
    • 用户维权
    • 售中退 或 售后退
    • └ sid
    • String
    • 123456
    • 特定标识。长度限制50字符以内(开通SID权限后下单返回)
    • └ platform_type
    • Number
    • 1
    • 1口碑,2饿了么
    • └ activity_id
    • Number
    • 12
    • 活动ID
    • └ used_store_id
    • String
    • EFDI12d23A
    • 核销门店(已加密)
    • └ pid
    • String
    • alsc_xxx_xxx_xxx
    • pid
    • └ relation_order_id
    • Number
    • 203232223
    • 卡券订单号
    • └ flow_type
    • Number
    • 1
    • 场景值,7卡券订单,8卡券核销订单。16/17囤券券订单,18囤券券外卖订单;19赏金红包
    • └ order_item_status
    • Number
    • 1
    • 0已失效,1已下单,2已付款,3售中退,4已收货,5售后退
    • └ activity_info_remark_list
    • String
    • null
    • 活动信息明细
    • └ channel_right_id
    • String
    • 3145
    • 权益ID(flow_type=10或11时为媒体出资活动ID)
    • └ ext_info
    • String
    • null
    • 扩展信息。tpOrderId:卡券场景下用来找C端用户看到的卡券订单号,无需理解,只要匹配上就行;alscOrderId:卡券场景下用来找C端用户看到的卡券核销订单号,无需理解,只要匹配上就行;isSelfPurchase:是否字段,true/false ;cityName:城市,示例:上海 ;platformActivityType:活动类型,BRAND、CONSUMPTION,对应品牌日和消费日 ;attrOrderDesc:是否归因订单,是/否;lockId评价有礼字段;commentFee评价返现金额
    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);
    AlibabaAlscUnionKbcpxPositiveOrderGetRequest req = new AlibabaAlscUnionKbcpxPositiveOrderGetRequest();
    req.setDateType(1L);
    req.setSettleState(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.setOrderState(2L);
    req.setFlowType("1");
    req.setPid("alsc_0000_1111_2222");
    req.setOrderId("2022111xxxx");
    req.setIncludeUsedStoreId(false);
    AlibabaAlscUnionKbcpxPositiveOrderGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alibaba_alsc_union_kbcpx_positive_order_get_response>
        <result>
            <order_detail_report_d_t_o>
                <title>商品标题</title>
                <pic_url>https://xxx</pic_url>
                <shop_name>xxx店</shop_name>
                <pay_amount>30.00</pay_amount>
                <settle_amount>28.00</settle_amount>
                <trace_time>2021-09-01 10:00:00</trace_time>
                <tk_create_time>2021-09-01 10:00:00</tk_create_time>
                <pay_time>2021-09-01 10:00:00</pay_time>
                <receive_time>2021-09-01 10:00:00</receive_time>
                <settle_time>2021-09-01 11:00:00</settle_time>
                <income>28.00</income>
                <settle>24.00</settle>
                <item_id>123456789</item_id>
                <product_num>5</product_num>
                <unit_price>10.00</unit_price>
                <category_name>商品类目</category_name>
                <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>
                <order_state>2</order_state>
                <order_item_status_name>售中退款</order_item_status_name>
                <settle_state>1</settle_state>
                <full_settle_amount>28.00</full_settle_amount>
                <commission_rate>10%</commission_rate>
                <commission_fee>10.00</commission_fee>
                <subsidy_rate>5%</subsidy_rate>
                <subsidy_fee>5.00</subsidy_fee>
                <income_rate>15%</income_rate>
                <stratify_rate>100%</stratify_rate>
                <deduct_rate>15%</deduct_rate>
                <platform_commission_rate>10%</platform_commission_rate>
                <platform_commission_fee>10</platform_commission_fee>
                <channel_rate>0%</channel_rate>
                <channel_fee>0</channel_fee>
                <media_id>12345678</media_id>
                <media_name>媒体名称</media_name>
                <ad_zone_id>12345678</ad_zone_id>
                <ad_zone_name>推广位名称</ad_zone_name>
                <activity_fee>12.0</activity_fee>
                <activity_service_fee>2.4</activity_service_fee>
                <activity_service_rate>0.2</activity_service_rate>
                <gmt_modified>2021-09-01 10:00:00</gmt_modified>
                <tag>用户维权</tag>
                <sid>123456</sid>
                <platform_type>1</platform_type>
                <activity_id>12</activity_id>
                <used_store_id>EFDI12d23A</used_store_id>
                <pid>alsc_xxx_xxx_xxx</pid>
                <relation_order_id>203232223</relation_order_id>
                <flow_type>1</flow_type>
                <order_item_status>1</order_item_status>
                <activity_info_remark_list>null</activity_info_remark_list>
                <channel_right_id>3145</channel_right_id>
                <ext_info>null</ext_info>
            </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_positive_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

    返回
    顶部