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

taobao.qimen.pos.clerk.synchronize (店员信息同步接口)

基础信息同步,POS机与ERP之间同步店员基础数据

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request Request 可选
  • └ actionType
  • String
  • 必须
  • add
  • 操作(add=新增、update=修改、delete=删除)
  • └ total
  • Number
  • 可选
  • 12
  • 总条数
  • clerks
  • Clerk []
  • 可选
  • └ storeCode
  • String
  • 必须
  • M123
  • 门店编码
  • └ clerkCode
  • String
  • 必须
  • M123
  • POS中的店员编码
  • └ sourceClerkCode
  • String
  • 可选
  • E123
  • ERP中的店员编码
  • └ clerkName
  • String
  • 必须
  • Y123
  • 店员名称
  • └ clerkType
  • String
  • 必须
  • DZ
  • 店员类型(DZ=店长、SYY=收银员、SHY=售货员、OTHER=其他)
  • contactInfo
  • ContactInfo
  • 可选
  • └ name
  • String
  • 必须
  • 老王
  • 姓名
  • └ birthDate
  • String
  • 可选
  • 2017-02-12
  • 出生年月(YYYY-MM-DD)
  • └ gender
  • String
  • 可选
  • M
  • 性别(M=男性、F=女性)
  • └ career
  • String
  • 可选
  • 码农
  • 职业
  • └ zipCode
  • String
  • 可选
  • 043356
  • 邮编
  • └ tel
  • String
  • 可选
  • 087654
  • 固定电话
  • └ mobile
  • String
  • 必须
  • 123456
  • 移动电话
  • └ fax
  • String
  • 可选
  • 12345
  • 传真
  • └ email
  • String
  • 可选
  • 098765
  • 电子邮箱
  • └ province
  • String
  • 可选
  • 浙江
  • 省份
  • └ city
  • String
  • 可选
  • 杭州
  • 城市
  • └ area
  • String
  • 可选
  • 余杭
  • 区域
  • └ town
  • String
  • 可选
  • 西溪
  • 村镇
  • └ detailAddress
  • String
  • 可选
  • 文一路
  • 详细地址
  • └ 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
  • 响应信息
  • clerks
  • Clerk []
  • └ clerkCode
  • String
  • P123
  • POS中的店员编码
  • └ clerkName
  • String
  • D123
  • 店员名称
  • └ storeCode
  • String
  • M123
  • 门店编码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
QimenClient client = new DefaultQimenClient(url, appkey, secret);
PosClerkSynchronizeRequest req = new PosClerkSynchronizeRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setActionType("add");
req.setTotal(12L);
Clerk obj1 = new Clerk();
obj1.setStoreCode("M123");
obj1.setClerkCode("M123");
obj1.setSourceClerkCode("E123");
obj1.setClerkName("Y123");
obj1.setClerkType("DZ");
ContactInfo obj2 = new ContactInfo();
obj2.setName("老王");
obj2.setBirthDate("2017-02-12");
obj2.setGender("M");
obj2.setCareer("码农");
obj2.setZipCode("043356");
obj2.setTel("087654");
obj2.setMobile("123456");
obj2.setFax("12345");
obj2.setEmail("098765");
obj2.setProvince("浙江");
obj2.setCity("杭州");
obj2.setArea("余杭");
obj2.setTown("西溪");
obj2.setDetailAddress("文一路");
obj1.setContactInfo(obj2);
obj1.setIsValid("Y");
obj1.setCreateTime("2017-02-10 00:00:00");
obj1.setLatestUpdateTime("2017-02-10 00:00:00");
req.setClerks(obj1);
PosClerkSynchronizeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
    <clerks>
        <clerk>
            <clerkCode>P123</clerkCode>
            <clerkName>D123</clerkName>
            <storeCode>M123</storeCode>
        </clerk>
    </clerks>
</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

返回
顶部