查询面单服务订购及面单使用情况

查询淘宝商家电子面单服务订购及面单使用情况,获取发货地&CP开通状态&账户的使用情况

1.请求参数

请求URL:

POST https://kf.fw199.com/gateway/taobao/cainiao/waybill/search

参数名 类型 说明 示例
appid String 合作伙伴AppId uwkahf@jfs92
timestamp String 当前时间戳
tb_seller_nick String 淘宝卖家店铺登录账号,非店铺名称 kingdo
cp_code String ,非必填 物流公司code ,如果为空,则查询所有的快递公司的订购关系 比如,韵达:YUNDA ,申通:STO ,物流公司code可通过接口 快递公司列表 获取
sysid String 100,101,102 可空, 代表不同的应用,具体请咨询客服
sign String 接口签名 如何计算生成见示例代码

2. 请求示例代码(Java)

      @Test
    public void getCaiNiaoWayBillSearch() throws Exception {

        String tb_seller_nick = Config.TBSellerNick ; //要查询支付宝的淘宝商家
        //业务参数
        Map<String, String> data = new HashMap<String, String>();
        data.put("appid",  Config.AppId);
        data.put("sysid", "100"); // 此值很重要,代表不同的应用,否则拉到订单,具体请咨询客服。
        data.put("tb_seller_nick", tb_seller_nick);
        Long timestamp = System.currentTimeMillis() / 1000;
        data.put("timestamp", timestamp.toString());
        data.put("cp_code", "ZTO"); 
        data.put("sign", Utils.Sign(data,Config.AppSecret));
        // 调用服务API
        doHttpRequest(Config.TaoBaoCaiNiaoWayBillSearchUrl ,data);

    }

3. 返回结果如下(部分数据):

{
    "code": 0,
    "message": "ok",
    "data": {
        "request_id": "oym0bf1383pg",
        "waybill_apply_subscription_cols": {
            "waybill_apply_subscription_info": [
                {
                    "branch_account_cols": {
                        "waybill_branch_account": [
                            {
                                "allocated_quantity": 0, //已用单数 
                                "branch_code": "11112",
                                "branch_name": "北京市场二部",
                                "cancel_quantity": 0, //取消的面对总数
                                "print_quantity": 0, //已经打印的面单总数
                                "quantity": 0, //可用单数
                                "segment_code": "NORMAL",
                                "service_info_cols": {
                                    "service_info_dto": [
                                        {
                                            "required": false,
                                            "service_attributes": {
                                                "service_attribute_dto": [
                                                    {
                                                        "attribute_code": "value",
                                                        "attribute_name": "代收货款金额",
                                                        "attribute_type": "number",
                                                        "type_desc": "{\"min\":0,\"required\":true,\"type\":\"number\"}"
                                                    }
                                                ]
                                            },
                                            "service_code": "SVC-COD",
                                            "service_desc": "按照寄件方与收件方达成交易协议的要求,快递公司代寄件方客户向收件方客户收取货款,同时按照约定时间将货款返还给寄件方。",
                                            "service_name": "代收货款"
                                        }
                                    ]
                                },
                                "shipp_address_cols": {
                                    "address_dto": [
                                        {
                                            "city": "南昌市",
                                            "detail": "阿萨德",
                                            "district": "东湖区",
                                            "province": "江西省"
                                        }
                                    ]
                                }
                            } 

                        ]
                    },
                    "cp_code": "ZTO",
                    "cp_type": 2
                }
            ]
        }
    }
}

说明: code为0表示成功,非0为失败,message会包含失败原因。 data字段包含数据字段说明:。

文档更新时间: 2024-01-02 17:43   作者:admin