开发平台

电话咨询 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配置的访问凭证
    返回结果
  • {
  • "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,
  • "cashier": {
  • "jobNumber": "1001",
  • "name": "苏xx",
  • "uid": 832101480292933201
  • },
  • "customerUid": 6666,
  • "uid": 73983541207916670,
  • "sn": "201511121602084680006",
  • "datetime": "2015-11-12 16:02:12",
  • "totalAmount": 72,
  • "totalProfit": 42,
  • "discount": 100,
  • "externalOrderNo": "2017121521001004460219576817",
  • "remark": "收银测试",
  • "rounding": 0,
  • "ticketType": "SELL",
  • "invalid": 0,
  • "webOrderNo": "21061518100850239104",
  • "payments": [
  • {
  • "code": "payCode_1",
  • "amount": 9.42
  • }
  • ],
  • "ticketSpendDetail": {
  • "peopleNum": 5,
  • "spendOutStore": 0
  • },
  • "ticketOnTable": {
  • "tableNumber": "a1",
  • "tableName": "a1",
  • "tableCardNo": "A区 a1"
  • },
  • "pointUsage":{
  • "customerUid": 6666,
  • "point": 80.00,
  • "money": 8.00,
  • "exchangeType": 1
  • },
  • "items":[
  • {
  • "name": "冰摩卡",
  • "buyPrice": 10,
  • "sellPrice": 24,
  • "customerPrice": 22,
  • "quantity": 1,
  • "discount": 100,
  • "customerDiscount": 100,
  • "totalAmount": 24,
  • "totalProfit": 14,
  • "isCustomerDiscount": 1,
  • "productUid": 379659791803681560,
  • "productBarcode": "2206241214109",
  • "ticketitemattributes": [
  • {
  • "attributeName": "加粮",
  • "attributeValue": "一匙"
  • }
  • ],
  • "discountDetails": [
  • {
  • "discountType": 3,
  • "discountRate": 60,
  • "discountAmount": 4,
  • "discountTotalAmount": 4,
  • "discountRuleUid": 340630600558146350,
  • "promotion":
  • {
  • "ruleUid": 340630600558146350,
  • "name": "6折券",
  • "description": "这是张6折券,满10可用"
  • }
  • }
  • ],
  • "saleGuiderList": [
  • {
  • "guiderUid": 340630600558146350,
  • "guiderJobNumber": "2002",
  • "guiderName": "林肉肉"
  • }
  • ]
  • }
  • ]
  • }
  • }
    		•
    字段名 类型 说明
    status String 是否正确处理请求，返回success或error，不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data Json 单据实体信息
    cashierUid Long 收银员唯一标识
    cashier json 收银员信息
    jobNumber String 收银员工号
    name String 收银员名字
    customerUid Long 会员唯一标识 为0表示收银时没选择会员
    uid long 单据唯一标识
    sn String 单据序列号
    datetime String 单据产生的时间，格式为yyyy-MM-dd HH:mm:ss
    sysUpdateTime String 单据更新的时间，格式为yyyy-MM-dd HH:mm:ss 反结账(作废)或者交接班的时候，该字段会更新为当前时间
    totalAmount BigDecima 单据实收总额
    totalProfit BigDecima 单据总利润
    discount BigDecima 整单折扣(对应收银界面的整单折扣，不是最终的折扣比例)
    比如有个商品，原价10，顾客是会员打了8折，收银员在收银时，又勾选了整单折扣9折，用户实付 7.2,但该字段=90
    externalOrderNo String 第三方平台支付单号
    remark String 备注
    serviceFee BigDecima 服务费
    gratuity BigDecima 小费
    coverCharge BigDecima 餐位费，茶位费
    boxFee BigDecima 包厢费
    rounding BigDecima 抹零数额，比如3.1元收别人3元，0.1就是被抹零数额
    ticketType String 单据类型：SELL销售单据, SELL_RETURN退货单据。不区分大小写
    sellTicketUid Long 退货单据关联的销售单据的uid:当ticketType=SELL_RETURN时且有原单关联时会返回
    invalid Int 值为1时表示单据已作废(反结账)
    webOrderNo String 网单号（直接在pos端收银，不会有值。只有通过外卖平台，小程序，或者订单推送接口 的网单才有）
    payments List 多种支付方式
    code String 支付方式代码
    amount BigDecimal 支付金额
    ticketSpendDetail Json 就餐人数信息
    peopleNum int 就餐人数
    spendOutStore int 0:在店，1:外带
    ticketOnTable Json 桌号信息
    tableNumber String 桌号
    tableName String 桌名
    tableCardNo String 牌号
    pointUsage Json 积分使用明细 上面的demo表示 80积分抵现8元
    customerUid long 会员uid
    point BigDecimal 积分
    money BigDecimal 金额
    exchangeType int 积分使用类型 1:积分抵现 2:积分兑换
    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 单据条目所对应的商品唯一标识
    productBarcode String 单据条目所对应的商品条形码
    ticketitemattributes List 单据条目属性、备注实体
    attributeName String 属性名称，即口味选项，如加糖、加水、加冰
    attributeValue String 属性值，即口味价格
    discountDetails List 折扣明细
    discountType Integer 折扣类型：
    0:无折扣
    1:赠送商品
    2:换购
    3:促销打折
    4:半价
    5:会员折扣
    6:单品改价、手动折扣 \赠送
    7:套餐
    8:返现(满多少减多少)
    9:使用次卡折扣
    10:积分抵现
    11:积分兑换商品,
    12:整单折扣
    discountRate BigDecimal 折扣率，折扣率为空时，参考item级别的折扣
    discountAmount BigDecimal 单件商品折扣金额, 折扣金额为空时，参考item级别的折扣
    discountTotalAmount BigDecimal 折扣总金额 discountTotalAmount=discountAmount*quantity
    discountRuleUid Long 促销规则uid
    promotion Object 促销规则详情，discountRuleUid不为空时，才会有
    ruleUid Long 促销规则uid
    name String 促销规则名称
    description String 促销规则描述
    saleGuiderList List 导购员信息
    guiderUid Long 导购员uid
    guiderJobNumber String 导购员工号
    guiderName String 导购员名字
    ticketStoreAppIdOrAccount String 会员所在消费门店的appId或账号
  • 当前接口该字段不会有值。
    • 只有 5. 分页查询会员单据，该字段才有值。

    3. 根据单据uid查询


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryTicketByUid
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
    		•
    请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "uid": 8008010001
  • }
    		•
    参数名 是否必须 类型 说明
    appId 是 String Pospal配置的访问凭证
    uid 是 Long 单据uid
    返回结果
  • 字段参照2. 根据单据序列号查询
    • 字段名 类型 说明
  • 字段参照2. 根据单据序列号查询

  • 银豹单据实现说明
  • 1：退货会新产生一笔ticketType=SELL_RETURN 的单据
  • 2：反结账(作废)不会生成新数据。会把原单据的invalid改为1
  • 3：交接班后，不能再执行反结账（作废）
  • 4：建议用T+1查询，比如第二天凌晨4,5点，查询前一天的数据。 获取到数据后，存到本地数据库
  • 5：如果门店没有每天都交接班，第2天还要反结账前天的单据，建议开通通知服务，反结账的时候，就能实时通知

    • 4. 分页查询所有单据


    接口地址 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": "2022-10-31 00:00:00", 包含开始时间
  • "endTime": "2022-10-31 23:59:59", 包含结束时间
  • "noLimitTimeRange": 1,
  • "postBackParameter":{
  • "parameterType": "abcd",从返回结果中直接取出
  • "parameterValue": "abcd"
  • }
    • }
    参数名 是否必须 类型 说明
    appId 是 String Pospal配置的访问凭证
    startTime 是 String 格式为yyyy-MM-dd HH:mm:ss
    endTime 是 String 格式为yyyy-MM-dd HH:mm:ss
    noLimitTimeRange 否 int 时间范围限制 默认endTime-startTime<=1天,传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,
  • "externalOrderNo": "2017121521001004460219576817",
  • "remark": "收银测试",
  • "rounding": 0,
  • "ticketType": "SELL",
  • ""invalid": 0,
  • "payments": [
  • {
  • "code": "payCode_1",
  • "amount": 9.42
  • }
  • ]
  • "ticketSpendDetail": {
  • "peopleNum": 5,
  • "spendOutStore": 0
  • }
  • "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. 根据单据序列号查询

    5. 分页查询会员单据


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryCustomerHistoryTicketsByUid
    请求头
  • 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",
  • "customerUid": 886263699231969848,
  • "queryAllStoreConsume": 1,
  • "postBackParameter":{
  • "parameterType": "LAST_RESULT_MIN_ID",
  • "parameterValue": "3764404"
  • }
    • }
    参数名 是否必须 类型 说明
    appId 是 String Pospal配置的访问凭证
    startTime 否 String 格式为yyyy-MM-dd HH:mm:ss
    endTime 否 String 格式为yyyy-MM-dd HH:mm:ss
    customerUid 是 Long 会员在银豹系统的唯一标识
    queryAllStoreConsume 否 int 是否查询会员在所有门店的消费记录
    1：是，0：否，默认0
    postBackParameter 否 Json 查询首页时可以不传，之后的内容从返回结果中取出
    parameterType 是 String 从返回结果中取出
    parameterValue 是 String 从返回结果中取出
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data":{
  • "postBackParameter": {
  • "parameterType": "LAST_RESULT_MIN_ID",
  • "parameterValue":"3764404"
  • },
  • "result": [
  • {
  • "cashierUid": 832101480292933201,
  • "customerUid": 0,
  • "sn": "201511121602084680006",
  • "datetime": "2015-11-12 16:02:12",
  • "totalAmount": 72,
  • "totalProfit": 42,
  • "discount": 100,
  • "externalOrderNo": "2017121521001004460219576817",
  • "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":"一匙"
  • }
  • ]
  • }
  • ],
  • "ticketStoreAppIdOrAccount": "87EB2C555BBF382E7F6C7B275B0C502A"
  • }
  • ],
  • "pageSize": 100
  • }
  • }
    		•
    字段名 类型 说明
    status String 是否正确处理请求，返回success或error，不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    pageSize Int 本次查询预期从库存取出记录数，如果结果集的长度小于pageSize，不需要进行下一页查询
    postBackParameter Json 分页查询回传到服务器的参数结构从第二页开始必须回传，如果没传，每次查询都是第一页
    parameterType String 从返回结果中直接取出用于回传，不能变其值
    parameterValue String 从返回结果中直接取出用于回传，不能变其值
    result List 单据实体信息，字段信息参照2. 根据单据序列号查询

    6. 根据销售单据uid查询对应的退货单据


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryRefunTicketBySellTicketUid
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
    		•
    请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "sellTcketUid": 8008010001
  • }
    		•
    参数名 是否必须 类型 说明
    appId 是 String Pospal配置的访问凭证
    sellTcketUid 是 Long 销售单据uid
    返回结果
  • 字段参照2. 根据单据序列号查询

    • 7. 根据销售单据sn查询对应的退货单据


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryRefunTicketBySellTicketSn
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
    		•
    请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "sellTcketSn": "20170509154301968000"
  • }
    		•
    参数名 是否必须 类型 说明
    appId 是 String Pospal配置的访问凭证
    sellTcketSn 是 String 销售单据sn
    返回结果
  • 字段参照2. 根据单据序列号查询

    • 8.根据退货单据uid查询对应的销售单据


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/querySellTicketByRefunTicketUid
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
    		•
    请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "refunTcketUid": 1508919704366308111
  • }
    		•
    参数名 是否必须 类型 说明
    appId 是 String Pospal配置的访问凭证
    refunTcketUid 是 long 退贷单据uid
    返回结果
  • 字段参照2. 根据单据序列号查询

    • 9.根据退货单据sn查询对应的销售单据


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/querySellTicketByRefunTicketSn
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
    		•
    请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "refunTcketSn": "201710251621443620002"
  • }
    		•
    参数名 是否必须 类型 说明
    appId 是 String Pospal配置的访问凭证
    refunTcketSn 是 String 退贷单据sn
    返回结果
  • 字段参照2. 根据单据序列号查询

    • 10.根据网单号查询对应的销售单据


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryTicketByOrderNo
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
    		•
    请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "orderNo": "20170509154301968000"
  • }
    		•
    参数名 是否必须 类型 说明
    appId 是 String Pospal配置的访问凭证
    orderNo 是 String 网单号
    返回结果
  • 字段参照2. 根据单据序列号查询

    • 11. 查询当前门店的支付方式代码


    接口地址 http://host:port/pospal-api2/openapi/v1/ticketOpenApi/queryMyPayMethod
    请求头
  • 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配置的访问凭证
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data": [
  • {
  • "orignCode": "1",
  • "code": "payCode_1",
  • "name": "现金",
  • "showName": "现金支付"
  • }
  • {
  • "code": "payCode_2",
  • "name": "储值卡"
  • }
  • ]
  • }
    		•
    字段名 类型 说明
    status String 是否正确处理请求，返回success或error，不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data List 实体信息
    orignCode String 支付方式原始代码
    code String 支付方式代码
    name String 支付方式名称
    showName String 支付方式展示名称

    
    联系我们
    工作时间
    9:00 - 21:00
    服务热线
    400-806-6866
    QQ售前咨询
    800008626
    QQ投诉通道
    3487430600
    拨打专线更快响应哦
    渠道合作　0592-5932122
    连锁客户　0592-5107006
    廉洁合规　17350856909
    资质证照
    工商营业执照
    增值电信业务经营许可证
    微信咨询
    wx
    微信扫一扫或者
    搜索“银豹收银”
    版本更新 | 支持社区 | 银豹博客 | 渠道合作 | 开放平台 | 服务协议 | 廉洁合规 | 关于我们 | 联系我们
    2010-2019 © Copyright. Zhundong Network - All Rights Reserved
    准动网络科技（厦门）有限公司版权所有 闽ICP备10208378号-2