文档中心 > API类目 > 奇门POS接口

taobao.qimen.pos.customer.synchronize (顾客信息同步接口)

基础信息同步,POS与ERP之间同步顾客(VIP)基础数据

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request Request 可选
  • └ actionType
  • String
  • 必须
  • add
  • 操作(add=新增、update=修改、delete=删除)
  • └ total
  • Number
  • 可选
  • 12
  • 所有的总条数
  • customers
  • Customer []
  • 可选
  • 顾客信息
  • customerInfo
  • CustomerInfo
  • 可选
  • 顾客信息
  • └ customerCode
  • String
  • 必须
  • GU123
  • 顾客编码
  • └ customerName
  • String
  • 必须
  • 老王
  • 顾客名称
  • └ storeCode
  • String
  • 必须
  • M123
  • 所属门店编码
  • └ storeName
  • String
  • 可选
  • 常二路门店
  • 所属门店名称
  • └ orgCode
  • String
  • 可选
  • M123
  • 所属组织编码
  • └ regTime
  • String
  • 可选
  • 2017-02-12 00:00:00
  • 会员注册时间(YYYY-MM-DD hh:mm:ss)
  • └ regSource
  • String
  • 可选
  • MD
  • 会员注册来源(MD = 门店、GW = 官网、OTHER= 其他)
  • └ isVIP
  • String
  • 必须
  • Y
  • 是否为VIP(Y/N)
  • contactInfo
  • ContactInfo
  • 可选
  • 信息
  • └ name
  • String
  • 必须
  • 老王
  • 姓名
  • └ gender
  • String
  • 可选
  • M
  • 性别(M=男性、F=女性)
  • └ birthDate
  • String
  • 可选
  • 2017-02-10
  • 出生年月(YYYY-MM-DD)
  • └ career
  • String
  • 可选
  • 码农
  • 职业
  • └ zipCode
  • String
  • 可选
  • 043300
  • 邮编
  • └ tel
  • String
  • 可选
  • 056789
  • 固定电话
  • └ mobile
  • String
  • 必须
  • 123456
  • 移动电话
  • └ fax
  • String
  • 可选
  • 0567
  • 传真
  • └ email
  • String
  • 可选
  • 0867667
  • 电子邮箱
  • └ province
  • String
  • 可选
  • 浙江
  • 省份
  • └ city
  • String
  • 可选
  • 杭州
  • 城市
  • └ area
  • String
  • 可选
  • 余杭
  • 区域
  • └ town
  • String
  • 可选
  • 西溪
  • 村镇
  • └ detailAddress
  • String
  • 可选
  • 文一路
  • 详细地址
  • VIPInfo
  • VIPInfo
  • 可选
  • VIP信息
  • └ VIPCode
  • String
  • 必须
  • VIP123
  • VIP会员编码
  • └ firstPurchaseTime
  • String
  • 可选
  • 2017-02-12 00:00:00
  • 第一次消费时间(YYYY-MM-DD hh:mm:ss)
  • └ lastPurchaseTime
  • String
  • 可选
  • 2017-02-12 00:00:00
  • 最后一次消费时间(YYYY-MM-DD hh:mm:ss)
  • └ amount
  • String
  • 可选
  • 12
  • 总消费金额
  • └ lastYearConsumption
  • String
  • 必须
  • 12
  • 近一年消费金额
  • └ orderNum
  • Number
  • 可选
  • 12
  • 购买单数
  • └ goodsNum
  • Number
  • 可选
  • 13
  • 购买件数
  • └ avgOrderPrice
  • String
  • 可选
  • 12
  • 平均笔单价
  • └ avgGoodsPrice
  • String
  • 可选
  • 12
  • 平均件单价
  • └ point
  • String
  • 可选
  • 12
  • 总积分
  • └ pointBalance
  • String
  • 必须
  • 12
  • 积分余额
  • └ balance
  • String
  • 可选
  • 12
  • 账户余额
  • VIPCardInfo
  • VIPCardInfo
  • 可选
  • VIP信息
  • └ VIPCardNo
  • String
  • 可选
  • VIP123
  • VIP的卡号编码
  • └ status
  • Number
  • 可选
  • 0
  • VIP卡的状态(0=未启用、1=正常、2=停用、4=挂失、5=休眠)
  • └ storeCode
  • String
  • 必须
  • M123
  • 所属门店编码
  • └ orgCode
  • String
  • 可选
  • X123
  • 所属组织编码
  • └ operator
  • String
  • 可选
  • Y123
  • 申请的营业员
  • └ serialCode
  • String
  • 可选
  • VIP23
  • VIP所属系列代码
  • └ serialName
  • String
  • 可选
  • VIPN123
  • VIP所属系列名称
  • └ groupCode
  • String
  • 必须
  • VIP123
  • VIP类别代码(VIP等级之类的信息)
  • └ groupName
  • String
  • 必须
  • S123
  • VIP类别代码(如钻石会员等)
  • └ expireDate
  • String
  • 必须
  • 2017-02-10 00:00:00
  • 会员等级到期时间(YYYY-MM-DD hh:mm:ss)
  • └ discount
  • String
  • 必须
  • 1
  • 默认折扣(如9折为0.9000、默认为1.0000)
  • └ isValid
  • String
  • 可选
  • Y
  • 是否有效(Y/N;默认为Y)
  • └ createTime
  • String
  • 可选
  • 2017-02-10 00:00:00
  • 创建时间(YYYY-MM-DD hh:mm:ss)
  • └ latestUpdateTime
  • String
  • 可选
  • 2017-02-10 00:00:00
  • 最新更新时间(YYYY-MM-DD hh:mm:ss)
  • └ extendProps
  • Map
  • 可选
  • 扩展属性

响应参数

名称 类型 示例值 描述
response Response
  • └ flag
  • String
  • success
  • 响应结果:success|failure
  • └ code
  • String
  • 0
  • 响应码
  • └ message
  • String
  • invalid appkey
  • 响应信息
  • customers
  • Customer []
  • 用户信息
  • └ customerCode
  • String
  • G123
  • 顾客编码
  • └ customerName
  • String
  • 老王
  • 顾客名称

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
QimenClient client = new DefaultQimenClient(url, appkey, secret);
PosCustomerSynchronizeRequest req = new PosCustomerSynchronizeRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setActionType("add");
req.setTotal(12L);
Customer obj1 = new Customer();
CustomerInfo obj2 = new CustomerInfo();
obj2.setCustomerCode("GU123");
obj2.setCustomerName("老王");
obj2.setStoreCode("M123");
obj2.setStoreName("常二路门店");
obj2.setOrgCode("M123");
obj2.setRegTime("2017-02-12 00:00:00");
obj2.setRegSource("MD");
obj2.setIsVIP("Y");
ContactInfo obj3 = new ContactInfo();
obj3.setName("老王");
obj3.setGender("M");
obj3.setBirthDate("2017-02-10");
obj3.setCareer("码农");
obj3.setZipCode("043300");
obj3.setTel("056789");
obj3.setMobile("123456");
obj3.setFax("0567");
obj3.setEmail("0867667");
obj3.setProvince("浙江");
obj3.setCity("杭州");
obj3.setArea("余杭");
obj3.setTown("西溪");
obj3.setDetailAddress("文一路");
obj2.setContactInfo(obj3);
obj1.setCustomerInfo(obj2);
VIPInfo obj4 = new VIPInfo();
obj4.setIPCode("VIP123");
obj4.setFirstPurchaseTime("2017-02-12 00:00:00");
obj4.setLastPurchaseTime("2017-02-12 00:00:00");
obj4.setAmount("12");
obj4.setLastYearConsumption("12");
obj4.setOrderNum(12L);
obj4.setGoodsNum(13L);
obj4.setAvgOrderPrice("12");
obj4.setAvgGoodsPrice("12");
obj4.setPoint("12");
obj4.setPointBalance("12");
obj4.setBalance("12");
VIPCardInfo obj5 = new VIPCardInfo();
obj5.setIPCardNo("VIP123");
obj5.setStatus(0L);
obj4.setIPCardInfo(obj5);
obj4.setStoreCode("M123");
obj4.setOrgCode("X123");
obj4.setOperator("Y123");
obj4.setSerialCode("VIP23");
obj4.setSerialName("VIPN123");
obj4.setGroupCode("VIP123");
obj4.setGroupName("S123");
obj4.setExpireDate("2017-02-10 00:00:00");
obj4.setDiscount("1");
obj4.setIsValid("Y");
obj1.setIPInfo(obj4);
obj1.setCreateTime("2017-02-10 00:00:00");
obj1.setLatestUpdateTime("2017-02-10 00:00:00");
req.setCustomers(obj1);
PosCustomerSynchronizeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
    <customers>
        <customer>
            <customerCode>G123</customerCode>
            <customerName>老王</customerName>
        </customer>
    </customers>
</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

返回
顶部