文档中心 > API类目 > 天猫国际API

tmall.hk.clearance.get (天猫国际-清关材料查询)

提供订单收货人身份信息查询功能。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
order_id Number 必须 1460536261312998 天猫国际订单号
need_image Boolean 可选 false
  • 默认值:false
  • 是否需要身份证图片,不需要可以缩短接口响应时间

    响应参数

    名称 类型 示例值 描述
    result CertifyQueryResult 查询结果对象
    • └ err_code
    • String
    • Wrong order_id
    • 错误代码
    • └ err_msg
    • String
    • 错误原因
    • module
    • ConsigneeCertifyInfo
    • 清关信息对象
    • └ credential1
    • String
    • url
    • 身份证正面
    • └ credential2
    • String
    • url
    • 身份证背面
    • └ ocr_exp
    • String
    • 20240101
    • 有效期截止日期
    • └ ocr_id
    • String
    • 412921198810201123
    • 身份证号
    • └ ocr_name
    • String
    • 张三
    • 姓名
    • └ order_id
    • Number
    • 1460536261312998
    • 订单号
    • └ type
    • Number
    • 1
    • 证件类型
    • └ success
    • Boolean
    • true
    • 查询是否成功

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TmallHkClearanceGetRequest req = new TmallHkClearanceGetRequest();
    req.setOrderId(1460536261312998L);
    req.setNeedImage(false);
    TmallHkClearanceGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tmall_hk_clearance_get_response>
        <result>
            <err_code>Wrong order_id</err_code>
            <err_msg>无</err_msg>
            <module>
                <credential1>url</credential1>
                <credential2>url</credential2>
                <ocr_exp>20240101</ocr_exp>
                <ocr_id>412921198810201123</ocr_id>
                <ocr_name>张三</ocr_name>
                <order_id>1460536261312998</order_id>
                <type>1</type>
            </module>
            <success>true</success>
        </result>
    </tmall_hk_clearance_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.order not exists 订单号不存在 请检查订单号是否存在
    isv.invalid-permission 请检查订单号是否是和商家ID匹配 商家只应该查看自己账号所属的订单
    isv.invalid-parameter:order_id 无线的订单号 请填入正确的天猫国际订单号
    isp.no certification record 订单对应的收货人还未上传清关材料 天猫国际商家可以联系买家到平台上传清关材料
    isp.remote-service-error 远程服务端出错 可以稍后重试
    no certification record 订单收货人未认证 联系消费者上传身份证信息
    isv.invalid-permission:agreement 没有权限查看 请去商家后台查看清关材料,自动弹出协议签署页面

    API工具

    如何获得此API

    FAQ

    返回
    顶部