开发平台

电话咨询 400-000-7749

QQ咨询

1.促销活动说明



2.根据优惠券规则Uid查询


接口地址 http://host:port/pospal-api2/openapi/v1/promotionOpenApi/queryCouponPromotionByUid
请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "promotionCouponUid": "1442802255016332217",
  • "appId": "abcdefghijklmn"
  • }
  • 参数名 是否必须 类型 说明
    promotionCouponUid Long 优惠券规则uid
    appId String Pospal配置的访问凭证
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data": [
  • {
  • "forRShop": "1",
  • "forEShop": "1",
  • "forCustomer": "0",
  • "enjoyCustomerDiscount": "0",
  • "promotionCouponUid": "1442802255016332217",
  • "createUserAppId": "hanskang_appid",
  • "createUserAccount": "hanskang",
  • "enable": "1",
  • "name": "满额返现100减去50",
  • "startDate": "2015-09-21 00:00:00",
  • "endDate": "2015-09-22 23:59:59",
  • "description": "好吃",
  • "avaliableQuantity": "990",
  • "usedQuantity": "0",
  • "createdQuantity": "660",
  • "codeLength": "5",
  • "salable": "1",
  • "sellingPrice": "0.1"
  • }
  • ]
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data List 实体信息
    forRShop Integer 1:实体店可用,0:实体店不可用
    forEShop Integer 1:网店可用,0:网店不可用
    forCustomer Integer 1: 会员专享,0:不限制
    enjoyCustomerDiscount Integer 会员可享受的折扣率,0或空享受折扣优惠。假设enjoyCustomerDiscount=90表示享受9九折优惠
    promotionCouponUid Long 优惠券规则uid
    createUserAccount String 创建优惠券规则门店的账号
    createUserAppId String 创建优惠券规则门店的AppId
    enable Integer 是否可用,1:可用,0:禁用,-1删除
    name String 促销活动(优惠券活动)名称
    startDate String 促销活动开始时间,格式为yyyy-MM-dd hh:mm:ss
    endDate String 促销活动结束时间,格式为yyyy-MM-dd hh:mm:ss
    description String 促销活动(优惠券活动)描述
    avaliableQuantity Integer 剩余可用优惠券号(核销码)数量
    usedQuantity Integer 已使用(核销)优惠券号(核销码)数量
    createdQuantity Integer 已创建优惠券号(核销码)数量
    codeLength Integer 优惠券号(核销码)建议长度
    salable Integer 是否可用,1:可用,0:禁用,-1删除
    sellingPrice BigDecimal 优惠券号销售价,空或0不收钱
    requiredAmount BigDecimal 满足多少金额才出券,空或0不限制

    3. 查询可用优惠券规则


    接口地址 http://host:port/pospal-api2/openapi/v1/promotionOpenApi/queryCouponPromotions
    请求头
  • 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":{
  • {
  • "forRShop": "1",
  • "forEShop": "1",
  • "forCustomer": "0",
  • "enjoyCustomerDiscount": "0",
  • "promotionCouponUid": "1442802255016332217",
  • "createUserAppId": "hanskang_appid",
  • "createUserAccount": "hanskang",
  • "enable": "1",
  • "name": "满额返现100减去50",
  • "startDate": "2015-09-21 00:00:00",
  • "endDate": "2015-09-22 23:59:59",
  • "description": "好吃",
  • "avaliableQuantity": "990",
  • "usedQuantity": "0",
  • "createdQuantity": "660",
  • "codeLength": "5",
  • "salable": "1",
  • "sellingPrice": "0.1"
  • }
  • ]
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data List 字段描述参考“2.根据优惠券规则Uid查询

    4. 添加优惠券号(核销码)


    接口地址 http://host:port/pospal-api/api/auth/openapi/promotion/addCouponcode/
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "appId": "abcdefghijklmn",
  • "code": "testCode",
  • "customerUid": 123456789,
  • "promotionCouponUid":1442802255016332217
  • }
  • }
    参数名 是否必须 类型 说明
    appId String Pospal配置的访问凭证
    promotionCouponUid Long 优惠券规则uid
    customerUid Long 会员Uid,如果有值,说明优惠券号挂到会员上
    code String 优惠券号(核销码),长度不能超过50(限英文或数字)注:优惠券号(核销码)必须保证每家门店全局唯一。
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data":{
  • "codeExpiredDate":"2015-09-22 23:59:59"
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data Json
    codeExpiredDate Json 优惠券号(核销码)失效时间,格式为yyyy-MM-dd hh:mm:ss

    5.分页查询会员所有优惠券号(核销码)(id倒序)


    接口地址 http://host:port/pospal-api2/openapi/v1/promotionOpenApi/queryCustomerCouponCodePage
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "customerUid": 817903042980914293,//会员uid
  • "postBackParameter": {
  • "parameterType": "abcdef",//从返回结果中直接取出
  • "parameterValue": "abcdef",//从返回结果中直接取出
  • },
  • "appId": "abcdefghijklmn"
  • }
  • 参数名 是否必须 类型 说明
    customerUid Long 会员uid
    appId String Pospal配置的访问凭证
    postBackParameter Json Pospal查询首页时可以不传,之后的内容从返回结果中取出
    parameterType String 从返回结果中取出
    parameterValue String 从返回结果中取出
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data": {
  • "postBackParameter":{
  • "parameterType": "LAST_RESULT_MAX_ID",
  • "parameterValue": "68975"
  • },
  • "result": [
  • {
  • "createdByUserAppId": "hanskang_appid",
  • "createUserAccount": "hanskang",
  • "usedByUserAppId": "hanskang_appid",
  • "usedByUserAccount": "hanskang",
  • "code": "5213705",
  • "createdDateTime": "2015-09-22 23:59:59",
  • "expiredDate": "好吃",
  • "usedDateTime": "990",
  • "usedByTicketUid": "0",
  • "promotionCouponUid": "660",
  • "promotionCouponName": "5",
  • "promotionCouponAppId": "1",
  • "promotionCouponAccount": "0.1",
  • "promotionCouponStartDate": "0.1",
  • "promotionCouponEndDate": "0.1"
  • }
  • ],
  • "pageSize":"100"
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data Json
    postBackParameter Json 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页
    parameterType String 从返回结果中直接取出用于回传,不能变其值
    parameterValue String 从返回结果中直接取出用于回传,不能变其值
    result List
    createdByUserAppId String 创建优惠券号(核销码)用户AppId
    createdByUserAccount String 创建优惠券号(核销码)用户账号
    code String 优惠券号(核销码)
    createdDateTime String 优惠券号(核销码)创建时间,格式为yyyy-MM-dd hh:mm:ss
    expiredDate String 优惠券号(核销码)过期时间,格式为yyyy-MM-dd hh:mm:ss如果为空,以promotionCouponEndDate为准
    usedByUserAppId String 使用优惠券号(核销码)用户AppId
    usedByUserAccount String 使用优惠券号(核销码)用户账号
    usedDateTime String 使用优惠券号(核销码)时间,格式为yyyy-MM-dd hh:mm:ss
    usedByTicketUid String 使用优惠券号(核销码)的流水单据Uid
    promotionCouponUid Long 优惠券规则Uid
    promotionCouponName String 优惠券规则名称
    promotionCouponAppId Integer 优惠券号(核销码)建议长度
    promotionCouponAccount String 创建优惠券规则用户账号
    promotionCouponStartDate String 优惠券规则-开始时间,格式为yyyy-MM-dd hh:mm:ss
    promotionCouponEndDate String 优惠券规则-结束时间,格式为yyyy-MM-dd hh:mm:ss

    6. 分页查询核销过的优惠券号(核销码)(id倒序)


    接口地址 http://host:port/pospal-api2/openapi/v1/promotionOpenApi/queryUsedPromotionCode
    请求头
  • User-Agent: openApi
  • Content-Type: application/json; charset=utf-8
  • accept-encoding: gzip,deflate
  • time-stamp: 1437528688233
  • data-signature: BF706E6AC693BA3B1BABD32E6713431D
  • 请求方式 POST
    请求体
  • {
  • "startTime": "2017-05-01 00:00:00",//开始时间(包含)
  • "excludeEndTime": "2017-05-05 23:59:59",//结束时间(不包含)
  • "postBackParameter": {
  • "parameterType": "abcdef",//从返回结果中直接取出
  • "parameterValue": "abcdef",//从返回结果中直接取出
  • },
  • "appId": "abcdefghijklmn"
  • }
  • 参数名 是否必须 类型 说明
    startTime String 开始时间(包含),格式为yyyy-MM-dd hh:mm:ss
    excludeEndTime String 结束时间(不包含),格式为yyyy-MM-dd hh:mm:ssendTime - startTime <= 5天
    appId String Pospal配置的访问凭证,任何门店的AppId都可以查出所有用用过的核销码
    postBackParameter Json Pospal查询首页时可以不传,之后的内容从返回结果中取出
    parameterType String 从返回结果中取出
    parameterValue String 从返回结果中取出
    返回结果
  • {
  • "status": "success",
  • "messages": [],
  • "data": {
  • "postBackParameter":{
  • "parameterType": "LAST_RESULT_MAX_ID",
  • "parameterValue": "68975"
  • },
  • "result": [
  • {
  • "createdByUserAppId": "hanskang_appid",
  • "createUserAccount": "hanskang",
  • "usedByUserAppId": "hanskang_appid",
  • "usedByUserAccount": "hanskang",
  • "code": "5213705",
  • "createdDateTime": "2015-09-22 23:59:59",
  • "expiredDate": "好吃",
  • "usedDateTime": "990",
  • "usedByTicketUid": "0",
  • "promotionCouponUid": "660",
  • "promotionCouponName": "5",
  • "promotionCouponAppId": "1",
  • "promotionCouponAccount": "0.1",
  • "promotionCouponStartDate": "0.1",
  • "promotionCouponEndDate": "0.1"
  • }
  • ],
  • "pageSize":"200"
  • }
  • }
  • 字段名 类型 说明
    status String 是否正确处理请求,返回success或error,不区分大小写
    messages String[] 处理结果的消息
    errorCode int 业务处理的错误代码,参见错误代码表
    data Json
    postBackParameter Json 分页查询回传到服务器的参数结构从第二页开始必须回传,如果没传,每次查询都是第一页
    parameterType String 从返回结果中直接取出用于回传,不能变其值
    parameterValue String 从返回结果中直接取出用于回传,不能变其值
    result List
    createdByUserAppId String 创建优惠券号(核销码)用户AppId
    createdByUserAccount String 创建优惠券号(核销码)用户账号
    code String 优惠券号(核销码)
    createdDateTime String 优惠券号(核销码)创建时间,格式为yyyy-MM-dd hh:mm:ss
    expiredDate String 优惠券号(核销码)过期时间,格式为yyyy-MM-dd hh:mm:ss如果为空,以promotionCouponEndDate为准
    usedByUserAppId String 使用优惠券号(核销码)用户AppId
    usedByUserAccount String 使用优惠券号(核销码)用户账号
    usedDateTime String 使用优惠券号(核销码)时间,格式为yyyy-MM-dd hh:mm:ss
    usedByTicketUid String 使用优惠券号(核销码)的流水单据Uid
    promotionCouponUid Long 优惠券规则Uid
    promotionCouponName String 优惠券规则名称
    promotionCouponAppId Integer 优惠券号(核销码)建议长度
    promotionCouponAccount String 创建优惠券规则用户账号
    promotionCouponStartDate String 优惠券规则-开始时间,格式为yyyy-MM-dd hh:mm:ss
    promotionCouponEndDate String 优惠券规则-结束时间,格式为yyyy-MM-dd hh:mm:ss