cainiao.yima.previewqr.previewconfig (获取商家码寄件码预览配置)

获取商家码寄件码预览配置

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id Number 必须 2234123 小件员id
qr_code_preview_type String 必须 Personal 可选值为Personal,Merchant
session_code String 可选 23423asdas session_code
merchant_id Number 可选 123 当预览类型为Merchant时,必传字段
personal_user_id Number 可选 333 个人userid

响应参数

名称 类型 示例值 描述
data YmqrCodePreviewDto data
  • └ bottom_desc
  • String
  • 底部描述
  • └ company_name
  • String
  • 企业公司名称
  • └ logo_image_url
  • String
  • logo图片地址
  • └ mobile_phone
  • String
  • 小件员电话
  • └ qrcode_content
  • String
  • 二维码内容
  • └ top_desc
  • String
  • 顶部描述
  • └ top_title
  • String
  • 顶部标题
  • └ user_name
  • String
  • 小件员名称
  • └ banner_image_url
  • String
  • banner图片地址
  • └ merchant_name
  • String
  • 自定义商户名称
  • └ merchant_image_url
  • String
  • 自定义商户图片地址
status_code String 2 statusCode
status_message String statusMessage
is_success Boolean false success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaPreviewqrPreviewconfigRequest req = new CainiaoYimaPreviewqrPreviewconfigRequest();
req.setUserId(2234123L);
req.setQrCodePreviewType("Personal");
req.setSessionCode("23423asdas");
req.setMerchantId(123L);
req.setPersonalUserId(333L);
CainiaoYimaPreviewqrPreviewconfigResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_previewqr_previewconfig_response>
    <data>
        <bottom_desc></bottom_desc>
        <company_name></company_name>
        <logo_image_url></logo_image_url>
        <mobile_phone></mobile_phone>
        <qrcode_content></qrcode_content>
        <top_desc></top_desc>
        <top_title></top_title>
        <user_name></user_name>
        <banner_image_url></banner_image_url>
        <merchant_name></merchant_name>
        <merchant_image_url></merchant_image_url>
    </data>
    <status_code>2</status_code>
    <status_message></status_message>
    <is_success>false</is_success>
</cainiao_yima_previewqr_previewconfig_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

返回
顶部