文档中心 > API类目 > ICBU-交易

alibaba.trade.address.schema.query (地址表单schema查询)

地址表单schema查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_address_localization_form_query AddressLocalizationFormQuery 必须 地址表单查询参数对象
  • └ dest_country_code
  • String
  • 必须
  • US
  • 目的国
  • └ language
  • String
  • 可选
  • en_US
  • en_US,zh_CN,zh_TW

响应参数

名称 类型 示例值 描述
forms AddressCountryFormDTO [] 表单
  • └ country_code
  • String
  • US
  • 国家code
  • └ disabled
  • Boolean
  • false
  • 国家是否被禁用
  • └ enable_association
  • Boolean
  • false
  • 是否开启联想能力
  • └ enable_multi_lang_input
  • Boolean
  • false
  • 是否开启多语言输入
  • └ enable_post_code_search
  • Boolean
  • false
  • 开启邮编联想
  • └ enable_smart_fill
  • Boolean
  • fasle
  • 开启智能解析模块
  • form_fields
  • LocalFormFieldDTO []
  • 表单字段规则
  • └ field_hint
  • String
  • hello
  • * 字段常驻提示 * 默认的只会返回 Select * 如果需要 Enter,前端需要根据当前是否返回数据动态判断
  • └ field_hover_tip
  • String
  • hello
  • 字段悬浮提示
  • └ field_key
  • String
  • contact.mobileNo
  • 手机号 contact.mobileNo,完整姓名 contact.fullName,国家 address.country,州省 address.province,城市 address.city,地址行1 address.address1,地址行2 address.address2,邮编 address.postCode
  • └ field_label
  • String
  • Phone number
  • 字段展示名
  • └ field_placeholder
  • String
  • null
  • 字段底纹提示
  • └ fill_type
  • String
  • input
  • 字段填写方式input,drop_down
  • └ order
  • Number
  • 30
  • 顺序
  • rule
  • LocalFormFieldRuleDTO
  • 规则
  • └ check_reg_exp
  • Boolean
  • true
  • 是否校验正则
  • reg_exps
  • LocalFormFieldRuleRegExpDTO []
  • * 正则表达式 * checkRegExp 为 true 时有效
  • └ check_failed_tips_text
  • String
  • You need to provide your phone number so that you can be contacted for delivery updates
  • * 行间展示:失败了展示的文案 * (内容是动态的,会有动态的参数绑定)
  • └ reg_exp
  • String
  • ^.+$
  • 正则表达式
  • └ reg_key
  • String
  • contact.mobileNo.nullable
  • regKey=fieldKey + regExpName
  • └ require_not_null
  • Boolean
  • true
  • 是否必填
  • └ form_fill_mode
  • String
  • normal
  • 表单填写模式

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTradeAddressSchemaQueryRequest req = new AlibabaTradeAddressSchemaQueryRequest();
AlibabaTradeAddressSchemaQueryRequest.AddressLocalizationFormQuery obj1 = new AlibabaTradeAddressSchemaQueryRequest.AddressLocalizationFormQuery();
obj1.setDestCountryCode("US");
obj1.setLanguage("en_US");
req.setParamAddressLocalizationFormQuery(obj1);
AlibabaTradeAddressSchemaQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_trade_address_schema_query_response>
    <forms>
        <address_country_form_d_t_o>
            <country_code>US</country_code>
            <disabled>false</disabled>
            <enable_association>false</enable_association>
            <enable_multi_lang_input>false</enable_multi_lang_input>
            <enable_post_code_search>false</enable_post_code_search>
            <enable_smart_fill>fasle</enable_smart_fill>
            <form_fields>
                <local_form_field_d_t_o>
                    <field_hint>hello</field_hint>
                    <field_hover_tip>hello</field_hover_tip>
                    <field_key>contact.mobileNo</field_key>
                    <field_label>Phone number</field_label>
                    <field_placeholder>null</field_placeholder>
                    <fill_type>input</fill_type>
                    <order>30</order>
                    <rule>
                        <check_reg_exp>true</check_reg_exp>
                        <reg_exps>
                            <local_form_field_rule_reg_exp_d_t_o>
                                <check_failed_tips_text>You need to provide your phone number so that you can be contacted for delivery updates</check_failed_tips_text>
                                <reg_exp>^.+$</reg_exp>
                                <reg_key>contact.mobileNo.nullable</reg_key>
                            </local_form_field_rule_reg_exp_d_t_o>
                        </reg_exps>
                        <require_not_null>true</require_not_null>
                    </rule>
                </local_form_field_d_t_o>
            </form_fields>
            <form_fill_mode>normal</form_fill_mode>
        </address_country_form_d_t_o>
    </forms>
</alibaba_trade_address_schema_query_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

返回
顶部