产品介绍

采用电子墨水显示技术和即时通信技术,实现对线下商品价格精准管理,通过EPD技术(Electronic Paper Display电子纸显示屏)达到和普通纸张一的显示清晰度和视觉效果,与企业ERP打通实现显示商品在系统内的价格,对商品价格即时管控。
服务介绍
电子价签服务实现了电子价签全生命周期的管理接口,包括商户管理,门店管理,网关以及价签安装,绑定,联动等功能。功能支持自定义开发管理客户端以及管理后台。在典型的使用场景中,价签系统可以与客流分析服务进行打通,实现根据客流画像来动态推送促销方案的功能。
如下是典型的使用场景示意

典型使用场景数据流向(结合客流分析)

整体使用流程

接口使用流程

接口概览
接口 |
版本 |
描述 |
/commercial/paas/esl/merchant/add |
1.0.0 |
新增电子价签商家 |
/commercial/paas/esl/store/add |
1.0.0 |
新增电子价签门店 |
/commercial/paas/esl/ap/delete |
1.0.0 |
删除价签AP设备 |
/commercial/paas/esl/ap/add |
1.0.0 |
添加价签AP设备 |
/commercial/paas/esl/ap/activate |
1.0.0 |
激活价签AP设备 |
/commercial/paas/esl/ap/search |
1.0.0 |
搜索价签AP设备 |
/commercial/paas/esl/item/batchimport |
1.0.0 |
按商家批量写入商品接口 |
/commercial/paas/esl/unbind |
1.0.0 |
电子价签解绑接口 |
/commercial/paas/esl/bind |
1.0.0 |
电子价签绑定接口 |
/commercial/paas/esl/info/query |
1.0.0 |
价签设备信息查询 |
/commercial/paas/esl/lightup |
1.0.0 |
价签LED亮灯 |
/commercial/paas/esl/item/lightup |
1.0.0 |
价签条码LED亮灯 |
调用示例
依赖包maven坐标
<dependency>
<groupId>com.aliyun.api.gateway</groupId>
<artifactId>sdk-core-java</artifactId>
<version>1.1.0</version>
</dependency>
<dependency>
<groupId>com.aliyun.iotx</groupId>
<artifactId>iotx-api-gateway-client</artifactId>
<version>1.0.3</version>
</dependency>
示例代码
SyncApiClient syncClient = SyncApiClient.newBuilder()
.appKey("1234567")
.appSecret("6726732dsfdsdsfdsfds")
.build();
IoTApiRequest request = new IoTApiRequest();
//设置api的版本
request.setApiVer("0.1.0");
// 接口参数
request.putParam("json","{}");
request.putParam("productKey","a1ILGykZVhP");
request.putParam("deviceName","Dxb3lv1E78mg5dsVLUQW");
request.putParam("serviceName","kkp");
//请求参数域名、path、request
ApiResponse response = syncClient.postBody("test123-cn-shanghai.alicloudapi.com",
"/invokeThingService", request);
System.out.println("response code = " + response.getStatusCode() + " response content = " + new String(response.getBody(),
"utf-8"));
}
参考文档
https://help.aliyun.com/document_detail/144661.html?spm=5176.10695662.1996646101.searchclickresult.1f903f9euZZy7f&aly_as=oU84ocGN
接口定义
1.按商家批量写入商品
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/item/batchimport |
1.0.0 |
按商家批量写入商品接口 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
门店id |
items |
JSONArray |
是 |
商品列表 见 ItemDTO 长度限制500 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
ItemDTO信息
名称 |
类型 |
必须 |
示例值 |
描述 |
sourceCode |
String |
FALSE |
http://taobao.com |
溯源码URL |
priceUnit |
String |
TRUE |
盒 |
销售单位 |
brandName |
String |
TRUE |
品牌 |
品牌 |
categoryName |
String |
TRUE |
品类 |
品类 |
rank |
String |
FALSE |
一级 |
等级 |
suggestPrice |
String |
FALSE |
1000 |
(建议)零售价,单位分,整数 |
skuId |
String |
FALSE |
123123 |
库存sku id |
energyEfficiency |
String |
FALSE |
能效 |
能效 |
promotionStart |
Date |
FALSE |
43313.41667 |
优惠开始时间 |
forestSecondCatId |
String |
FALSE |
12312 |
淘系二级商品类目ID |
customizeFeatureA |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureB |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureC |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureD |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureE |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureF |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureG |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureH |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureI |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
customizeFeatureJ |
String |
FALSE |
自定义扩展属性 |
自定义扩展属性 |
itemQrCode |
String |
FALSE |
http://taobao.com |
二维码图片URL |
ifPromotion |
Boolean |
FALSE |
FALSE |
是否优惠 |
promotionEnd |
Date |
FALSE |
43313.41667 |
优惠结束时间 |
extraAttribute |
|
FALSE |
{ “extra1”: “v1”, “extra2”:”v2” } |
额外扩展信息 |
originalPrice |
String |
FALSE |
2000 |
原价,分,整数 |
positonCode |
String |
FALSE |
1-2-3-4 |
货架位 |
modelNum |
String |
FALSE |
型号 |
型号 |
saleSpec |
String |
FALSE |
500g |
规格 |
acctionPrice |
String |
TRUE |
2000 |
实际销售价格,分,整数 |
itemBarCode |
String |
TRUE |
6955748500036 |
商品条码 |
memberPrice |
String |
FALSE |
1000 |
会员价格,分,整数 |
itemTitle |
String |
TRUE |
商品标题 |
商品标题 |
promotionText |
String |
FALSE |
优惠文案 |
优惠文案 |
itemStatus |
Number |
FALSE |
0 |
商品状态 |
itemId |
Number |
TRUE |
123123 |
商品ID |
forestFirstCatId |
String |
FALSE |
123123 |
一级商品类目id |
shortTitle |
String |
FALSE |
商品短标题 |
商品短标题 |
ifSourceCode |
Boolean |
FALSE |
FALSE |
是否溯源 |
productionPlace |
String |
FALSE |
产地 |
产地 |
示例
入参示例
{
"storeId":123456,
"merchantId":"223456",
"items":{
"originalPrice": "2000",
"categoryName": "品类",
"customizeFeatureC": "自定义扩展属性",
"customizeFeatureD": "自定义扩展属性",
"positonCode": "1-2-3-4",
"customizeFeatureA": "自定义扩展属性",
"customizeFeatureB": "自定义扩展属性",
"itemBarCode": "6955748500036",
"saleSpec": "500g",
"memberPrice": "1000",
"shortTitle": "商品短标题",
"rank": "一级",
"ifPromotion": false,
"promotionEnd": "2018-08-01 10:00:00",
"suggestPrice": "1000",
"itemTitle": "商品标题",
"modelNum": "型号",
"energyEfficiency": "能效",
"extraAttribute": {},
"itemQrCode": "http://taobao.com",
"productionPlace": "产地",
"itemId": 123123,
"promotionStart": "2018-08-01 10:00:00",
"brandName": "品牌",
"skuId": "123123",
"ifSourceCode": false,
"itemStatus": 0,
"priceUnit": "盒",
"forestSecondCatId": "12312",
"acctionPrice": "2000",
"forestFirstCatId": "123123",
"customizeFeatureG": "自定义扩展属性",
"customizeFeatureH": "自定义扩展属性",
"customizeFeatureE": "自定义扩展属性",
"customizeFeatureF": "自定义扩展属性",
"sourceCode": "http://taobao.com",
"customizeFeatureI": "自定义扩展属性",
"promotionText": "优惠文案",
"customizeFeatureJ": "自定义扩展属性"
}
}
出参示例
{
"code":200,
"message":"success"
}
2.新增电子价签商家门店
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/store/add |
1.0.0 |
新增电子价签门店 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeName |
String |
是 |
门店名称 |
storeOutId |
String |
是 |
门店外部ID,要保持同一商家下的唯一性 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
data |
返回值 |
JsonObject StoreDTO |
StoreDTO信息
名称 |
类型 |
必须 |
示例值 |
描述 |
storeId |
Long |
True |
617002 |
门店id |
示例
入参示例
{
"merchantId":"223456",
"storeName":"测试门店",
"storeOutId":"112222335566"
}
出参示例
{
"code":200,
"message":"success",
"data":{
"storeId":617002
}
}
3.新增电子价签商家
注意商家外部编号全局唯一,并且每个项目只允许创建一个商家
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/merchant/add |
1.0.0 |
新增电子价签商家 |
入参
字段名 |
类型 |
必填 |
备注 |
brandName |
String |
是 |
商家名称 |
brandOutCode |
String |
是 |
商家外部编号 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
data |
返回值 |
JsonObject MerchantDTO |
MerchantDTO信息
名称 |
类型 |
必须 |
示例值 |
描述 |
merchantId |
String |
True |
152004 |
商家id |
示例
入参示例
{
"brandName":"测试商家",
"brandOutCode":"112222335566"
}
出参示例
{
"code":200,
"message":"success",
"data":{
"merchantId":"152004"
}
}
4.电子价签解绑
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/unbind |
1.0.0 |
电子价签解绑接口 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
eslBarCode |
String |
是 |
价签条码 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
入参示例
{
"merchantId":"152004",
"storeId":617002,
"eslBarCode":"测试商家"
}
出参示例
{
"code":200,
"message":"success"
}
5.电子价签绑定
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/bind |
1.0.0 |
电子价签绑定接口 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
eslBarCode |
String |
是 |
价签条码 |
itemBarCode |
String |
是 |
商品条码 |
extendInfo |
Json |
否 |
额外扩展信息 { “extend”: “info” } |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
入参示例
{
"merchantId":"152004",
"storeId":617002,
"eslBarCode":"测试商家",
"itemBarCode":"6955748500036",
"extendInfo":{"extend": "info"}
}
出参示例
{
"code":200,
"message":"success"
}
6.价签设备信息查询
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/info/query |
1.0.0 |
价签设备信息查询 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
eslBarCode |
String |
是 |
价签条码 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
data |
返回结果 |
JsonObject(EslInfoDTO) |
EslInfoDTO
字段名 |
类型 |
备注 |
eslConnectAp |
String |
连接的AP信息 |
itemTitle |
String |
商品名称信息 |
eslScreenHeight |
Intger |
屏幕高度 |
eslLastCommunicateTime |
Long |
最后一次通信时间 |
eslStatus |
Intger |
价签状态 |
storeId |
Long |
绑定的门店号296001 |
eslScreenWidth |
Intger |
屏幕宽度 |
eslVendor |
String |
设备商名称 |
ifBind |
Boolean |
是都已绑定 |
eslSize |
String |
价签大小 |
eslType |
Intger |
价签类型 |
eslModel |
String |
价签型号,如AESL0290B |
eslOutId |
Intger |
价签外部id |
eslBatteryLevel |
Intger |
价签电池电量 |
eslId |
String |
价签id |
eslBarCode |
String |
价签条码 18bc5a79ef0f |
入参示例
{
"merchantId":"152004",
"storeId":617002,
"eslBarCode":"测试商家"
}
出参示例
{
"code":200,
"message":"success",
"data":{
"eslConnectAp": null,
"itemTitle": null,
"eslScreenHeight": 128,
"eslLastCommunicateTime": 1533698354000,
"eslStatus": "0",
"storeId": 296001,
"eslScreenWidth": 296,
"eslVendor": "ali",
"ifBind": true,
"eslSize": null,
"eslType": "1",
"eslModel": "AESL0290B",
"eslOutId": "18:bc:5a:79:ef:0f",
"eslBatteryLevel": "100",
"eslId": null,
"eslBarCode": "18bc5a79ef0f"
}
}
7.删除价签AP设备
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/ap/delete |
1.0.0 |
删除价签AP设备 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
apMac |
String |
是 |
ap的mac地址 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
入参示例
{
"merchantId":"152004",
"storeId":617002,
"apMac":"23464433222"
}
出参示例
{
"code":200,
"message":"success"
}
8.添加价签AP设备
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/ap/add |
1.0.0 |
添加价签AP设备 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
apMac |
String |
是 |
ap的mac地址 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
入参示例
{
"merchantId":"152004",
"storeId":617002,
"apMac":"23464433222"
}
出参示例
{
"code":200,
"message":"success"
}
9.激活价签AP设备
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/ap/activate |
1.0.0 |
激活价签AP设备 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
apMac |
String |
是 |
ap的mac地址 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
入参示例
{
"merchantId":"152004",
"storeId":617002
"ap_mac":"23464433222"
}
出参示例
{
"code":200,
"message":"success"
}
10.搜索价签AP设备
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/ap/search |
1.0.0 |
搜索价签AP设备 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
apQuery |
JSONObject |
否 |
详见ApSearchDTO |
ApSearchDTO
字段名 |
类型 |
必填 |
备注 |
apMac |
String |
否 |
ap的mac地址 |
isActivate |
Boolean |
否 |
是否激活 |
pageNo |
Long |
是 |
当前页 |
pageSize |
Long |
是 |
分页大小 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
data |
出参信息 |
JsonArray 详见 ApInfoDTO |
ApInfoDTO
字段名 |
类型 |
必填 |
备注 |
mac |
String |
否 |
ap的mac地址 |
status |
Boolean |
否 |
是否在线 |
isActivate |
Boolean |
否 |
是否激活 |
model |
String |
否 |
AP型号 |
入参示例
{
"merchantId":"152004",
"storeId":617002,
"apQuery":
{
"pageNo":1,
"pageSize":10,
"ap_mac":"23464433222"
}
}
出参示例
{
"code":200,
"message":"success",
"data":[
{
"mac":"112233445",
"status":false,
"isActivate":true,
"model":"aliyunap"
},
{
"mac":"22334455",
"status":true,
"isActivate":true,
"model":"aliyunap"
}
]
}
11.价签LED亮灯【需要价签硬件支持】
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/lightup |
1.0.0 |
价签LED亮灯 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
eslBarCode |
String |
是 |
价签条码 |
ledColor |
String |
是 |
亮灯颜色,绿:值为2;红:值为4 |
lightUpTime |
Long |
是 |
亮灯时长,单位:秒,最大长度3600秒 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
入参示例
{
"merchantId":"152004",
"storeId":617002,
"eslBarCode":"12345678",
"ledColor":"2",
"lightUpTime":60
}
出参示例
{
"code":200,
"message":"success"
}
12.价签条码LED亮灯【需要价签硬件支持】
API概述
接口 |
版本 |
描述 |
/commercial/paas/esl/item/lightup |
1.0.0 |
价签条码LED亮灯 |
入参
字段名 |
类型 |
必填 |
备注 |
merchantId |
String |
是 |
商户id |
storeId |
Long |
是 |
价签系统注册的门店storeId |
itemBarCode |
String |
是 |
商品条码 |
ledColor |
String |
是 |
亮灯颜色,绿:值为2;红:值为4 |
lightUpTime |
Long |
是 |
亮灯时长,单位:秒,最大长度3600秒 |
出参
参数名 |
参数描述 |
数据类型 |
code |
错误码 |
Int |
message |
错误信息 |
String |
data |
亮灯结果 |
JsonObject 详见LightResultDTO |
LightResultDTO
字段名 |
类型 |
必填 |
备注 |
successCount |
Integer |
否 |
成功数量 |
failCount |
Integer |
否 |
失败数量 |
notifyMessage |
String |
否 |
通知消息 |
入参示例
{
"merchantId":"152004",
"storeId":617002,
"itemBarCode":"6955748500036",
"ledColor":"2",
"lightUpTime":60
}
出参示例
{
"code":200,
"message":"success",
"data":{
"successCount":1,
"failCount":0,
"notifyMessage":""
}
}
在文档使用中是否遇到以下问题
更多建议
匿名提交