当前位置: API文档

fa_alipay_account_check_query.php(查询平台对账)

¥标准

1.接口说明

1.1 接口描述:获取旺店通ERP的平台对账信息
1.2 适用版本:客户端 V2.7.4.0及以上版本
1.3 增量获取:按照下载时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。
1.4 时间跨度:start_time和end_time最大跨度为24小时,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-01 23:59:59,建议根据获取数据量的多少适当减小时间跨度。
1.5注意事项:本接口不返回淘系及系统供销平台订单数据,相关平台规则单击这里。淘系订单数据获取办法单击这里其他平台的敏感信息会根据平台规则同步调整。

2.调用场景

2.1 举例说明:

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境

https://sandbox.wangdian.cn/openapi2/fa_alipay_account_check_query.php

正式环境https://api.wangdian.cn/openapi2/fa_alipay_account_check_query.php

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
本开放平台“自助对接”功能模块内自助申请,获取方式点击这里
时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
API输入参数签名结果,签名算法介绍单击这里

   3.3 业务请求参数

名称字段类型长度
必须描述
开始时间start_timedatetime

开始时间,格式: YYYY-MM-DD HH:MM:SS
结束时间end_timedatetime

结束时间,格式: YYYY-MM-DD HH:MM:SS
时间条件类型time_typeint

1:最后修改时间

2:发货时间

3:对账时间

4:确认收货时间

默认1

平台idplatform_idint
平台id
对账单状态statusint

0未对账,1 对账失败,2部分对账  3对账成功  4设置对账成功  5未关联
分页大小page_sizeint

每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40使用举例单击这里
页号page_noint


不传值默认从0页开始
店铺编号
shop_no
varchar
40

代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),可通过shop.php获取

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
错误码codeint11状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint11只有page_no = 0 时才返回的符合条件的数据总条数,用来分页
单据详情
account_list
data[]

响应参数的1级数据节点

   4.2 业务响应参数

  account_list

名称字段类型长度
必须描述
对账单号account_check_novarchar40
对账单号
原始单号tidvarchar40原始单号
平台idplatform_idvarchar6平台id
店铺id
shop_id
varchar6

店铺id
店铺编号
shop_no
varchar20

店铺编号
店铺名称
shop_namevarchar128

ERP内支持自定义的店铺名称
已收金额
pay_amountdecimal(19,4)
已收金额
发货金额send_amountdecimal(19,4)
发货金额
售中退款金额refund_amountdecimal(19,4)
售中退款金额
费用cost_amountdecimal(19,4)
费用
确认收货金额
confirm_amountdecimal(19,4)
确认收货金额
对账状态
statusint4

对账状态 0未对账,1 对账失败,2部分对账  3对账成功  4设置对账成功  5未关联
平台退款状态
refund_statusint(19,4)
平台退款状态 0无退款 1申请退款 2部分退款 3全部退款
是否全部发货
is_send_allint(19,4)
是否全部发货
对账时间
check_timevarchar(19,4)
对账时间
发货时间consign_timevarchar(19,4)
发货时间yyyy-MM-dd HH:mm:ss
确认收货时间
confirm_timevarchar(19,4)
确认收货时间yyyy-MM-dd HH:mm:ss

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/fa_alipay_account_check_query.php';
    
    $c->putApiParam('start_time', '2020-12-11 12:00:00');
    $c->putApiParam('end_time', '2020-12-11 13:00:00');
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
           
JAVA
package com.wangdian.api.trade;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.wangdian.api.WdtClient;

    public class FaAlipayAccountCheckQuery {

        public static void main(String[] args) {
           // TODO Auto-generated method stub
        WdtClient client = new WdtClient("传入sid", "传入appkey", "传入appsecret", "传入url");
        //测试环境sid、appkey、密钥请到旺店通开放平台-自助对接-申请测试环境内查看,测试环境url=https://sandbox.wangdian.cn/openapi2/
        //调用正式环境时请将sid、appkey、appsecret切换为实际参数,参数在旺店通开放平台-自助对接-应用管理内应用状态为已上线的应用中查看,调用正式环境注意切换正式环境url=https://api.wangdian.cn/openapi2/
            Map<String, String> params = new HashMap<String, String>();
            params.put("start_time", "2020-12-11 12:00:00");
            params.put("end_time", "2020-12-11 13:00:00");
            params.put("page_size", "30");
            params.put("page_no", "0");

            try {
                String response = client.execute("fa_alipay_account_check_query.php", params);
                System.out.println(response);
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }

    }
           
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;

namespace FaAlipayAccountCheckQuery 
{
    class FaAlipayAccountCheckQuery 
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/fa_alipay_account_check_query.php";

            client.putParams("start_time", "2020-12-11 12:00:00");
             client.putParams("end_time", "2020-12-11 13:00:00");
            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}
           
python
import WdtClient

t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/')
params = {}
params.update({"start_time": '2021-01-01 00:00:00'})
params.update({"end_time": '2021-01-01 00:59:59'})
params.update({"page_no": '0'})
params.update({"page_size": '100'})

response = t.execute("fa_alipay_account_check_query", params)
print(response)
           

6.响应示例

   6.1 正常响应示例 

JSON
           
{
    "code":0,
    "total_count":19,
    "account_list":[
        {
            "account_check_no":"xxxx",
            "check_time":"0000-00-00 00:00:00",
            "confirm_amount":"0.0000",
            "confirm_time":"0000-00-00 00:00:00",
            "consign_time":"2022-06-27 16:04:52",
            "cost_amount":"0.0000",
            "is_send_all":"1",
            "pay_amount":"0.0000",
            "platform_id":"0",
            "rec_id":"177745",
            "refund_amount":"0.0000",
            "refund_status":"0",
            "send_amount":"368.0000",
            "shop_id":"28",
            "shop_name":"c-test",
            "shop_no":"c-test",
            "status":"0",
            "tid":"20220627"
        }
    ],
    "message":"ok"
}
           

   6.2 异常响应示例

JSON
           
{
	"code": 2,
	"message": "结束时间 end_time 为空"
}
           



常用工具