电子价签

产品介绍

采用电子墨水显示技术和即时通信技术，实现对线下商品价格精准管理，通过EPD技术（Electronic Paper Display电子纸显示屏）达到和普通纸张一的显示清晰度和视觉效果，与企业ERP打通实现显示商品在系统内的价格，对商品价格即时管控。

服务介绍

电子价签服务实现了电子价签全生命周期的管理接口，包括商户管理，门店管理，网关以及价签安装，绑定，联动等功能。功能支持自定义开发管理客户端以及管理后台。在典型的使用场景中，价签系统可以与客流分析服务进行打通，实现根据客流画像来动态推送促销方案的功能。

如下是典型的使用场景示意

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

整体使用流程

接口使用流程

接口概览

调用示例

依赖包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概述

入参

出参

ItemDTO信息

示例

入参示例

{
  "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概述

入参

出参

StoreDTO信息

示例

入参示例

{
  "merchantId":"223456",
  "storeName":"测试门店",
  "storeOutId":"112222335566"
}

出参示例

{
    "code":200,
    "message":"success",
      "data":{
      "storeId":617002
    }
}

3.新增电子价签商家

注意商家外部编号全局唯一，并且每个项目只允许创建一个商家

API概述

入参

出参

MerchantDTO信息

示例

入参示例

{
  "brandName":"测试商家",
  "brandOutCode":"112222335566"
}

出参示例

{
    "code":200,
    "message":"success",
      "data":{
      "merchantId":"152004"
    }
}

4.电子价签解绑

API概述

入参

出参

入参示例

{
  "merchantId":"152004",
  "storeId":617002,
  "eslBarCode":"测试商家"
}

出参示例

{
    "code":200,
    "message":"success"
}

5.电子价签绑定

API概述

入参

出参

入参示例

{
  "merchantId":"152004",
  "storeId":617002,
  "eslBarCode":"测试商家",
  "itemBarCode":"6955748500036",
  "extendInfo":{"extend": "info"}
}

出参示例

{
    "code":200,
    "message":"success"
}

6.价签设备信息查询

API概述

入参

出参

EslInfoDTO

入参示例

{
  "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概述

入参

出参

入参示例

{
  "merchantId":"152004",
  "storeId":617002,
  "apMac":"23464433222"
}

出参示例

{
    "code":200,
    "message":"success"
}

8.添加价签AP设备

API概述

入参

出参

入参示例

{
  "merchantId":"152004",
  "storeId":617002,
  "apMac":"23464433222"
}

出参示例

{
    "code":200,
    "message":"success"
}

9.激活价签AP设备

API概述

入参

出参

入参示例

{
  "merchantId":"152004",
  "storeId":617002
  "ap_mac":"23464433222"
}

出参示例

{
    "code":200,
    "message":"success"
}

10.搜索价签AP设备

API概述

入参

ApSearchDTO

出参

ApInfoDTO

入参示例

{
  "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概述

入参

出参

入参示例

{
  "merchantId":"152004",
  "storeId":617002,
  "eslBarCode":"12345678",
  "ledColor":"2",
  "lightUpTime":60
}

出参示例

{
    "code":200,
    "message":"success"
}

12.价签条码LED亮灯【需要价签硬件支持】

API概述

入参

出参

LightResultDTO

入参示例

{
  "merchantId":"152004",
  "storeId":617002,
  "itemBarCode":"6955748500036",
  "ledColor":"2",
  "lightUpTime":60
}

出参示例

{
    "code":200,
    "message":"success",
    "data":{
      "successCount":1,
      "failCount":0,
      "notifyMessage":""
    }
}