文档中心 > API类目 > 天猫精灵供应链销售运营

alibaba.gsc.dms.agent.rebate.balance.sum.get (查询客户返利余额汇总信息)

查询客户返利余额汇总信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_d_m_s_rebate_balance_detail_query_request DmsRebateBalanceDetailQueryRequest 可选 入参
  • └ category
  • String
  • 可选
  • TIANMAOJINGLINGCHENGPIN
  • category
  • └ customer_code
  • String
  • 可选
  • XX
  • 客户编码
  • └ operator
  • String
  • 可选
  • XXX
  • 操作人
  • └ out_customer_code
  • String
  • 可选
  • XXX
  • 外部客户编码
  • └ page_no
  • Number
  • 可选
  • 1
  • 分页起始
  • └ page_size
  • Number
  • 可选
  • 2
  • 分页结束
  • └ request_id
  • String
  • 可选
  • XXXX
  • 请求id
  • └ tenant
  • String
  • 可选
  • ailab
  • 租户

响应参数

名称 类型 示例值 描述
result DataResult xxx 返回对象封装
  • └ code
  • String
  • foo
  • 参数code
  • data
  • KeyValueDto
  • xxx
  • 返回列表
  • └ available_amount
  • Number
  • 1
  • 可用金额
  • └ freeze_amount
  • Number
  • 1
  • 冻结金额
  • └ invalid_amount
  • Number
  • 1
  • 失效金额
  • └ total_rebate_amount
  • Number
  • 1
  • 总金额
  • └ used_amount
  • Number
  • 1
  • 已使用金额
  • └ msg
  • String
  • foo
  • 参数msg
  • └ pending
  • Boolean
  • false
  • 是否阻塞
  • └ success
  • Boolean
  • false
  • 是否正常
  • └ total
  • Number
  • 1
  • 总个数
  • └ trace_id
  • String
  • xxx
  • traceId

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaGscDmsAgentRebateBalanceSumGetRequest req = new AlibabaGscDmsAgentRebateBalanceSumGetRequest();
AlibabaGscDmsAgentRebateBalanceSumGetRequest.DmsRebateBalanceDetailQueryRequest obj1 = new AlibabaGscDmsAgentRebateBalanceSumGetRequest.DmsRebateBalanceDetailQueryRequest();
obj1.setCategory("TIANMAOJINGLINGCHENGPIN");
obj1.setCustomerCode("XX");
obj1.setOperator("XXX");
obj1.setOutCustomerCode("XXX");
obj1.setPageNo(1L);
obj1.setPageSize(2L);
obj1.setRequestId("XXXX");
obj1.setTenant("ailab");
req.setParamDMSRebateBalanceDetailQueryRequest(obj1);
AlibabaGscDmsAgentRebateBalanceSumGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_gsc_dms_agent_rebate_balance_sum_get_response>
    <result>
        <code>foo</code>
        <data>
            <available_amount>1</available_amount>
            <freeze_amount>1</freeze_amount>
            <invalid_amount>1</invalid_amount>
            <total_rebate_amount>1</total_rebate_amount>
            <used_amount>1</used_amount>
        </data>
        <msg>foo</msg>
        <pending>false</pending>
        <success>false</success>
        <total>1</total>
        <trace_id>xxx</trace_id>
    </result>
</alibaba_gsc_dms_agent_rebate_balance_sum_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

返回
顶部