oTMS logo 开放平台
Documentation Help

小程序二维码生成

通过小程序二维码生成接口,可以将不同外部系统如ERP系统、WMS系统的订单生成小程序二维码。订单数少于100。

版本号 文档 说明
0.1 当前版本文档

配置说明

oTMS同时在生产环境和测试环境中提供Web Service接口,其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。

注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。

目前对该接口的调用限制为每个公司每秒最多10个请求

接口说明

公共参数

环境 HTTP请求方法 HTTPS请求地址 请求主体MIME类型 响应主体MIME类型
正式环境 POST https://login.otms.cn/ws/openMiniApp/orders/qrCode application/json application/json
沙箱环境 POST https://demo.otms.cn/ws/openMiniApp/orders/qrCode application/json application/json

请求参数

字段名 位置 是否必填 描述 Schema
body body 是 小程序二维码生成请求 MiniAppGenerateCodeRequest
Authorization header Basic Authorization。如果不为空,则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 string

响应参数

状态码 描述 响应模型
200 successful operation MiniAppGenerateCodeResponse

详细描述

MiniAppGenerateCodeOrderDto

字段名 类型 是否必填 描述 示例
orderNumber string 否 订单号
erpNumber string 否 ERP号

MiniAppGenerateCodeRequest

字段名 类型 是否必填 描述 示例
version string 否 请求的版本号
login string 否 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
password string 否 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。
wechatQRCode array[MiniAppGenerateCodeOrderDto] 是 待生成小程序二维码的订单号或者ERP号

MiniAppGenerateCodeResponse

字段名 类型 是否必填 描述 示例
version string 是 响应版本号
responseCode string 否 全局的反馈代码
batchNumber string 否 小程序二维码

报文示例

请求示例

{
    "wechatQRCode":[
        {
            "orderNumber":"SP11000816"
        },
        {
            "orderNumber":"SP11000815"
        }
    ]
}

响应示例

{
    "responseCode":"",
    "batchNumber":"https://login.otms.cn/miniapp/orderlist?batchNumber=ECVXLEFWSF42GH3MYBQAXOSY"
}

错误码解释

全局反馈代码

反馈代码 说明
0客户验证失败
1不支持的请求版本
2请求中的订单数量超过限制

单个请求反馈代码

反馈代码 说明
1106订单不存在或当前订单状态不支持生成小程序二维码
1140未开启小程序二维码权限,请先联系管理员开启

API工具