注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 新零售供应链API

alibaba.ascp.channel.oms.render.common (OMS通用渲染)

OMS通用渲染

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
common_render_request CommonRenderRequest 可选 通用渲染情况
  • └ order_type
  • Number
  • 可选
  • 20
  • 订单类型。1:渠道分销单,20: 物流LP
  • └ biz_order_code
  • String
  • 可选
  • LP00827489591597
  • 单号,根据订单类型orderType使用不同单号。
  • └ render_type
  • Number
  • 可选
  • 10
  • 渲染类型。10: 发货渲染,20: 签收渲染

响应参数

名称 类型 示例值 描述
trace_id String 3b522dca17834942746908129e3754 追踪ID
biz_success Boolean true 成功标志
module CommonRenderResponse 响应数据
  • └ order_type
  • Number
  • 20
  • 订单类型。1:渠道分销单,20: 物流LP
  • └ biz_order_code
  • String
  • LP00827489591597
  • 单号,根据订单类型orderType使用不同单号。
  • └ render_type
  • Number
  • 20
  • 渲染类型
  • render_field_list
  • RenderFieldList []
  • 渲染字段列表
  • └ show_name
  • String
  • 配送模式
  • 展示名称
  • └ key_name
  • String
  • consignMode
  • key名称
  • └ type
  • String
  • string
  • 值类型
  • └ required
  • Boolean
  • true
  • 是否必须
biz_error_message String 无 错误信息
biz_error_code String SUCCESS 错误码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAscpChannelOmsRenderCommonRequest req = new AlibabaAscpChannelOmsRenderCommonRequest();
AlibabaAscpChannelOmsRenderCommonRequest.CommonRenderRequest obj1 = new AlibabaAscpChannelOmsRenderCommonRequest.CommonRenderRequest();
obj1.setOrderType(20L);
obj1.setBizOrderCode("LP00827489591597");
obj1.setRenderType(10L);
req.setCommonRenderRequest(obj1);
AlibabaAscpChannelOmsRenderCommonResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_ascp_channel_oms_render_common_response>
    <trace_id>3b522dca17834942746908129e3754</trace_id>
    <biz_success>true</biz_success>
    <module>
        <order_type>20</order_type>
        <biz_order_code>LP00827489591597</biz_order_code>
        <render_type>20</render_type>
        <render_field_list>
            <render_field_list>
                <show_name>配送模式</show_name>
                <key_name>consignMode</key_name>
                <type>string</type>
                <required>true</required>
            </render_field_list>
        </render_field_list>
    </module>
    <biz_error_message>无</biz_error_message>
    <biz_error_code>SUCCESS</biz_error_code>
</alibaba_ascp_channel_oms_render_common_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

返回
顶部