开发平台

电话咨询 400-000-7749

QQ咨询

1. 查询支付方式代码


接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryAllPayMethod
请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn"
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    sn String 单据序列号
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data": [
  • {
  • "code": "payCode_1",
  • "name": "现金"
  • }
  • {
  • "code": "payCode_2",
  • "name": "储值卡"
  • }
  • ]
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data List 实体信息
    code String 支付方式代码
    name String 支付方式名称

    2. 根据单据序列号查询


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryTicketBySn
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "sn":"201511121549168880001"
  • }
  • 参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    sn String 单据序列号
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data":{
  • "cashierUid": 832101480292933201,
  • "customerUid": 0,
  • "sn": "201511121602084680006",
  • "datetime": "2015-11-12 16:02:12",
  • "totalAmount": 72,
  • "totalProfit": 42,
  • "discount": 100,
  • "rounding": 0,
  • "ticketType": "SELL",
  • "invalid": 0,
  • "payments": [
  • {
  • "code": "payCode_1",
  • "amount": 9.42
  • },
  • ],
  • "item":[
  • {
  • "name": "冰摩卡",
  • "buyPrice": 10,
  • "sellPrice": 24,
  • "customerPrice": 22,
  • "quantity": 1,
  • "discount": 100,
  • "customerDiscount": 100,
  • "totalAmount": 24,
  • "totalProfit": 14,
  • "isCustomerDiscount": 1,
  • "productUid": 379659791803681560,
  • "ticketitemattributes": [
  • {
  • "attributeName": "加粮",
  • "attributeValue": "一匙"
  • }
  • ]
  • }
  • ]
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data Json 单据实体信息
    cashierUid Long 收银员唯一标识
    customerUid Long 会员唯一标识
    sn String 单据序列号
    datetime String 单据产生的时间,格式为yyyy-MM-dd hh:mm:ss
    totalAmount BigDecima 单据实收总额
    totalProfit BigDecima 单据总利润
    discount BigDecima 单据折扣
    rounding BigDecima 抹零数额,比如3.1元收别人3元,0.1就是被抹零数额
    ticketType String 单据类型:SELL销售单据, SELL_RETURN退货单据。不区分大小写
    invalid Int 值为1时表示单据已作废
    payments List 多种支付方式
    code String 支付方式代码
    amount BigDecimal 支付金额
    items List 单据条目实体
    name String 单据条目商品名称
    buyPrice BigDecimal 单据条目商品进货价
    sellPrice BigDecimal 单据条目商品销售价
    customerPrice BigDecimal 单据条目商品会员价
    quantity BigDecimal 单据条目销售的商品数量,如3.5箱
    discount BigDecimal 单据条目所打的折扣
    customerDiscount BigDecimal 单据条目所打的会员折扣
    totalAmount BigDecimal 单据条目总价
    totalProfit BigDecimal 单据条目总利润
    isCustomerDiscount int 数据为1时表求享受了会员折扣
    productUid Long 单据条目所对应的商品唯一标识
    ticketitemattributes List 单据条目属性、备注实体
    attributeName String 属性名称,即口味选项,如加糖、加水、加冰
    attributeValue String 属性值,即口味价格

    3. 分页查询所有单据


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryTicketPages
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "startTime": "2015-11-12 01:59:59",
  • "endTime": "2015-11-12 23:59:59",
  • "postBackParameter":{
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • }
  • }
    参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    startTime String 格式为yyyy-MM-dd hh:mm:ss
    endTime String 格式为yyyy-MM-dd hh:mm:ss
    endTime - startTime<=1天
    postBackParameter Json 查询首页时可以不传,之后的内容从返回结果中取出
    parameterType String 从返回结果中取出
    parameterValue String 从返回结果中取出
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data":{
  • "postBackParameter": {
  • "parameterType": "abcd", 从返回结果中直接取出
  • "parameterValue":"abcd"
  • }
  • "result": [
  • {
  • "cashierUid": 832101480292933201,
  • "customerUid": 0,
  • "sn": "201511121602084680006",
  • "datetime": "2015-11-12 16:02:12",
  • "totalAmount": 72,
  • "totalProfit": 42,
  • "discount": 100,
  • "rounding": 0,
  • "ticketType": "SELL",
  • ""invalid": 0,
  • "payments": [
  • {
  • "code": "payCode_1",
  • "amount": 9.42
  • }
  • ]
  • "items": [
  • {
  • "name": "冰摩卡",
  • "buyPrice": 10,
  • "sellPrice": 24,
  • "customerPrice": 22,
  • "quantity": 1,
  • "discount": 100,
  • "customerDiscount": 100,
  • "totalAmount": 24,
  • "totalProfit": 14,
  • "isCustomerDiscount": 1,
  • "productUid":379659791803681560,
  • ticketitemattributes": [
  • {
  • "attributeName":"加粮",
  • "attributeValue":"一匙"
  • }
  • ]
  • }
  • ]
  • }
  • ]
  • "pageSize": 100
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    pageSize Int 本次查询预期从库存取出记录数,如果结果集的长度小于pageSize,不需要进行下一页查询
    postBackParameter Json 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页
    parameterType String 从返回结果中直接取出用于回传,不能变其值
    parameterValue String 从返回结果中直接取出用于回传,不能变其值
    result List 单据实体信息,字段信息参照2.3.1