867 lines
29 KiB
JSON
867 lines
29 KiB
JSON
{
|
||
"generatedAt": "2026-06-08 16:54:48",
|
||
"generatedAtLocal": "2026-06-08 16:54:48",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "基础模块",
|
||
"key": "index",
|
||
"folder": "index",
|
||
"interfaceCount": 21
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "index.fastWhereTree",
|
||
"title": "index.fastWhereTree 接口",
|
||
"description": "index.fastWhereTree 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "type 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.loadStores",
|
||
"title": "index.loadStores 接口",
|
||
"description": "index.loadStores 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.getCOSUploadConfig",
|
||
"title": "index.getCOSUploadConfig 接口",
|
||
"description": "index.getCOSUploadConfig 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "data 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.getImages",
|
||
"title": "index.getImages 接口",
|
||
"description": "index.getImages 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.uploadSuccessNotify",
|
||
"title": "index.uploadSuccessNotify 接口",
|
||
"description": "index.uploadSuccessNotify 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.ReferenceFile",
|
||
"title": "index.ReferenceFile 接口",
|
||
"description": "index.ReferenceFile 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.getMessageDetail",
|
||
"title": "index.getMessageDetail 接口",
|
||
"description": "index.getMessageDetail 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.test",
|
||
"title": "后台专用的拼多多开放平台测试接口,用于传入请求参数并发起真实请求,返回签名后的请求体和接口响应",
|
||
"description": "后台专用的拼多多开放平台测试接口,用于传入请求参数并发起真实请求,返回签名后的请求体和接口响应",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "拼多多接口名,例如 pdd.order.number.list.get"
|
||
},
|
||
{
|
||
"name": "bizParams",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "业务参数对象,会参与签名和请求"
|
||
},
|
||
{
|
||
"name": "request",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "bizParams 兼容字段"
|
||
},
|
||
{
|
||
"name": "accessToken",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "用户授权令牌"
|
||
},
|
||
{
|
||
"name": "access_token",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "accessToken 的下划线命名兼容字段"
|
||
},
|
||
{
|
||
"name": "dataType",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "返回格式,默认 JSON"
|
||
},
|
||
{
|
||
"name": "version",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "API 版本"
|
||
},
|
||
{
|
||
"name": "timestamp",
|
||
"type": "string|number",
|
||
"required": false,
|
||
"description": "时间戳,不传则使用当前秒级时间戳"
|
||
},
|
||
{
|
||
"name": "clientId",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "覆盖配置中的 client_id"
|
||
},
|
||
{
|
||
"name": "clientSecret",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "覆盖配置中的 client_secret"
|
||
},
|
||
{
|
||
"name": "baseUrl",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "请求地址,默认拼多多开放平台网关"
|
||
},
|
||
{
|
||
"name": "headers",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "额外请求头"
|
||
},
|
||
{
|
||
"name": "timeout",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "请求超时时间(毫秒)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "requestBody",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "实际发送到 PDD 网关的请求体,已包含 sign"
|
||
},
|
||
{
|
||
"name": "response",
|
||
"type": "any",
|
||
"required": false,
|
||
"description": "拼多多接口返回内容"
|
||
},
|
||
{
|
||
"name": "baseUrl",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "实际请求地址"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.recognizeLicensePlate",
|
||
"title": "识别车牌号码(通过 base64 图片)",
|
||
"description": "识别车牌号码(通过 base64 图片)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "base64",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "base64 图片,支持 data URL 前缀(data:image/...;base64,)或纯 base64 字符串"
|
||
},
|
||
{
|
||
"name": "imageBase64",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "兼容字段(同 base64)"
|
||
},
|
||
{
|
||
"name": "image_base64",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "兼容字段(同 base64)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "licensePlate",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "识别到的车牌号(对外契约,仅返回该字段)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.getI18nMessage",
|
||
"title": "index.getI18nMessage 接口",
|
||
"description": "index.getI18nMessage 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "language",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "language 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.putI18nCollect",
|
||
"title": "index.putI18nCollect 接口",
|
||
"description": "index.putI18nCollect 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "keys",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "keys 参数"
|
||
},
|
||
{
|
||
"name": "locale",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "locale 参数"
|
||
},
|
||
{
|
||
"name": "project",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "project 参数"
|
||
},
|
||
{
|
||
"name": "source",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "source 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.tryAutoTranslateNewKeys",
|
||
"title": "index.tryAutoTranslateNewKeys 接口",
|
||
"description": "index.tryAutoTranslateNewKeys 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.searchSpace",
|
||
"title": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)",
|
||
"description": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "keyword",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "搜索关键字,对 space_code 和 custom_barcode 做模糊匹配(%keyword%);为空时返回当前仓库下前 50 条"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "flag",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "全局调用结果标识,成功时为 success"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "业务状态码,200 表示成功"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "返回信息"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "库位数组(最多 50 条),每项包含以下字段"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "本次返回的记录条数(等于 data.length,≤50)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.listInterfaceTypes",
|
||
"title": "查询可用的接口类型列表(如奇门仓储、开放接口等)",
|
||
"description": "查询可用的接口类型列表(如奇门仓储、开放接口等)",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "index.getLocationTypeList",
|
||
"title": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存",
|
||
"description": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "库位类型列表"
|
||
},
|
||
{
|
||
"name": "total",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "返回总数"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.getPlatformOauthLink",
|
||
"title": "获取平台授权链接。入参支持 code / platform_code / platformCode,服务端按首个非空值标准化为大写平台编码;会从当前登录上下文读取仓库 ID(ctx.user.store_id),再从 wms_platform.auth_base_url 读取授权基础地址。接口会优先复用当前仓库与平台下 status=0 的未授权记录;若历史 auth_random_code 带有当前配置前缀,则会先去前缀后以裸码回写,当前数据库最终保存的 auth_random_code 为裸码。若无可复用记录则生成新的裸码并写入 wms_shops。返回的 oauth_link 会从配置 platformOauthReservationCodePrefix 读取前缀(本地示例为 xxxxx_),按“前缀 + 平台编码 + '_' + 裸码”生成 state,并将 URL 编码后的 state 直接拼接到平台基础授权链接后,例如 xxxxx_PDD_<rawCode>。当前仅支持已按上述模式配置好的基础授权链接。",
|
||
"description": "获取平台授权链接。入参支持 code / platform_code / platformCode,服务端按首个非空值标准化为大写平台编码;会从当前登录上下文读取仓库 ID(ctx.user.store_id),再从 wms_platform.auth_base_url 读取授权基础地址。接口会优先复用当前仓库与平台下 status=0 的未授权记录;若历史 auth_random_code 带有当前配置前缀,则会先去前缀后以裸码回写,当前数据库最终保存的 auth_random_code 为裸码。若无可复用记录则生成新的裸码并写入 wms_shops。返回的 oauth_link 会从配置 platformOauthReservationCodePrefix 读取前缀(本地示例为 xxxxx_),按“前缀 + 平台编码 + '_' + 裸码”生成 state,并将 URL 编码后的 state 直接拼接到平台基础授权链接后,例如 xxxxx_PDD_<rawCode>。当前仅支持已按上述模式配置好的基础授权链接。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台编码主字段;与 platform_code / platformCode 三选一即可,服务端按 code -> platform_code -> platformCode 顺序取首个非空值并转为大写"
|
||
},
|
||
{
|
||
"name": "platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台编码下划线别名"
|
||
},
|
||
{
|
||
"name": "platformCode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台编码驼峰别名"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,成功时返回 200"
|
||
},
|
||
{
|
||
"name": "data.platform_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "标准化后的平台编码"
|
||
},
|
||
{
|
||
"name": "data.oauth_link",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "基于 wms_platform.auth_base_url 构造的授权链接;实际拼接值为 encodeURIComponent(prefix + platform_code + '_' + rawCode),其中 prefix 来自 platformOauthReservationCodePrefix,rawCode 为数据库 auth_random_code 中保存的裸码。基础授权链接需预先配置为可直接追加 state 值的模式。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.getShopList",
|
||
"title": "获取当前登录仓库下的已授权店铺列表,支持按平台编码可选过滤。仓库上下文来自 ctx.user.store_id;服务端兼容读取 body.platform_code 与 body.platformCode,按该顺序取首个 trim 后非空值作为平台过滤条件。未传平台参数时返回当前登录仓库下全部已授权店铺;传入非空平台编码时仅返回该平台的已授权店铺。结果按 status DESC、updated_at DESC、id DESC 排序,并对敏感字段完成脱敏后返回 data.list。",
|
||
"description": "获取当前登录仓库下的已授权店铺列表,支持按平台编码可选过滤。仓库上下文来自 ctx.user.store_id;服务端兼容读取 body.platform_code 与 body.platformCode,按该顺序取首个 trim 后非空值作为平台过滤条件。未传平台参数时返回当前登录仓库下全部已授权店铺;传入非空平台编码时仅返回该平台的已授权店铺。结果按 status DESC、updated_at DESC、id DESC 排序,并对敏感字段完成脱敏后返回 data.list。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "平台编码过滤条件;兼容 platformCode。服务端按 platform_code、platformCode 的顺序读取首个值,trim 后非空时仅返回该平台的已授权店铺;未传或为空时返回当前登录仓库下全部已授权店铺。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,成功时返回 200"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "业务提示信息,成功时返回 ok"
|
||
},
|
||
{
|
||
"name": "data.list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "当前登录仓库下按条件过滤后的已授权店铺列表数组;未传平台参数时返回当前仓库全部已授权店铺,传入非空 platform_code/platformCode 时仅返回对应平台店铺。结果按 status DESC、updated_at DESC、id DESC 排序,且 owner_id、access_token、refresh_token、auth_random_code 已按实现规则脱敏。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.getShopExpressList",
|
||
"title": "获取指定店铺的快递签约/电子面单可用列表。接口依赖当前登录仓库上下文 ctx.user.store_id 校验店铺归属;服务端会按店铺所属平台拉取并收敛可用快递列表,统一返回前端消费结构;未接入的平台当前返回空列表。",
|
||
"description": "获取指定店铺的快递签约/电子面单可用列表。接口依赖当前登录仓库上下文 ctx.user.store_id 校验店铺归属;服务端会按店铺所属平台拉取并收敛可用快递列表,统一返回前端消费结构;未接入的平台当前返回空列表。",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "shop_id",
|
||
"type": "string|number",
|
||
"required": false,
|
||
"description": "店铺 ID;与 shopId 兼容,二选一至少传一个。服务端按 shop_id、shopId 的顺序读取首个非空值。"
|
||
},
|
||
{
|
||
"name": "shopId",
|
||
"type": "string|number",
|
||
"required": false,
|
||
"description": "店铺 ID 的驼峰兼容字段;当 shop_id 为空时读取该值。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,成功时返回 200。"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "业务提示信息,成功时返回 ok。"
|
||
},
|
||
{
|
||
"name": "data.shop_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "当前店铺 ID。"
|
||
},
|
||
{
|
||
"name": "data.platform_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "店铺所属平台编码,返回值按服务端实现转为大写。"
|
||
},
|
||
{
|
||
"name": "data.list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "服务端按店铺所属平台拉取并统一收敛后的快递签约/电子面单可用列表;未接入的平台返回空数组。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.getCainiaoStfTemplates",
|
||
"title": "公共无参查询淘宝菜鸟标准模板列表;服务端调用淘宝开放平台 cainiao.cloudprint.stdtemplates.get,请求地址为 https://eco.taobao.com/router/rest,使用 TOP 公共签名参数。不需要用户授权,不下发 session,不依赖登录态、当前仓库或店铺授权。成功返回 data.platform_code='TB' 与标准模板数组,模板项统一字段为 template_id/template_name/template_url/cp_code/wp_code。",
|
||
"description": "公共无参查询淘宝菜鸟标准模板列表;服务端调用淘宝开放平台 cainiao.cloudprint.stdtemplates.get,请求地址为 https://eco.taobao.com/router/rest,使用 TOP 公共签名参数。不需要用户授权,不下发 session,不依赖登录态、当前仓库或店铺授权。成功返回 data.platform_code='TB' 与标准模板数组,模板项统一字段为 template_id/template_name/template_url/cp_code/wp_code。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,成功时返回 200。"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "业务提示信息,成功时返回 ok。"
|
||
},
|
||
{
|
||
"name": "data.platform_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "平台编码,固定返回 TB。"
|
||
},
|
||
{
|
||
"name": "data.list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "菜鸟标准模板列表;来源于 cainiao_cloudprint_stdtemplates_get_response.result.datas[*].standard_templates[*] 的宽松兼容解析结果,按统一字段 template_id/template_name/template_url/cp_code/wp_code 返回。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.getPrintPlatformTemplateList",
|
||
"title": "按打印平台与快递编码查询模板列表。express_code 为必填;接口会先按 platform_code(默认 CAINIAO)定位 wms_express 对应打印平台字段,再以 express_code 过滤可用模板后返回。",
|
||
"description": "按打印平台与快递编码查询模板列表。express_code 为必填;接口会先按 platform_code(默认 CAINIAO)定位 wms_express 对应打印平台字段,再以 express_code 过滤可用模板后返回。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "platform_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "打印平台编码(如 CAINIAO);不传默认 CAINIAO,服务端会转为大写。"
|
||
},
|
||
{
|
||
"name": "express_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "快递编码(必填);服务端会转为大写,并用于按 wms_express 中对应打印平台字段筛选模板。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "flag",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "全局结果标识;成功为 success,失败为 failure。"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码;成功时为 200。"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "提示信息;成功时为 ok。"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "返回数据对象。"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "index.polyapiAuthorizeUrl",
|
||
"title": "生成菠萝派授权链接。该接口不接收请求参数,服务端会固定调用 Differ.JH.BuildeAuthorizeUrl,并以内置配置 this.app.config.poloApi.appKey / this.app.config.poloApi.secret 以及当前代码中写死的 callbackUrl=http://39.100.57.68/、state=123456、itemcode=test001 作为上游请求参数,最终将菠萝派接口原始响应包裹后返回。",
|
||
"description": "生成菠萝派授权链接。该接口不接收请求参数,服务端会固定调用 Differ.JH.BuildeAuthorizeUrl,并以内置配置 this.app.config.poloApi.appKey / this.app.config.poloApi.secret 以及当前代码中写死的 callbackUrl=http://39.100.57.68/、state=123456、itemcode=test001 作为上游请求参数,最终将菠萝派接口原始响应包裹后返回。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": false,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "code",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "业务状态码,成功时返回 200。"
|
||
},
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "业务提示信息,成功时返回 ok。"
|
||
},
|
||
{
|
||
"name": "data.respone",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "菠萝派接口 Differ.JH.BuildeAuthorizeUrl 的原始响应对象。字段名按当前实现保持为 respone。"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|