Skip to main content

单码制码

基本信息

接口名称:同步制码状  态:已完成
接口路径:POST /paas/micro/ecoupon/makeCode更新时间:2024-04-25 01:00:01
Mock地址:https://apimock.e-buychina.com/mock/617/paas/micro/ecoupon/makeCode

请求参数

Headers:

参数名称参数值是否必填
Content-Typeapplication/json

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:ebuywha102410000
actionstring交易类型最大长度:50
最小长度:1
Mock:makeCode
timestampnumber请求时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度:1
Mock:@natural
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject请求报文体
  outerOrderIdstring制码订单号最大长度:64
最小长度:10
Mock:@natural
  mobilestring手机号最大长度:11
最小长度:5
Mock:@natural
  thirdPlatformTypestring第三方平台类型最大长度:50
最小长度:1
Mock:1
  thirdUserIdstring第三方平台用户id最大长度:50
最小长度:1
Mock:1
  itemobject制码子订单
    outerOrderItemIdstring制码子订单号最大长度:64
最小长度:10
Mock:@natural
    codeCountstring制码数量最大长度:250
最小长度:1
Mock:@integer
    ticketIdnumber券批次idMock:202
    commissionDateinteger码启用日期
    validDaysinteger相对有效天数Mock:10
    validStartnumber码有效开始时间(date类型)Mock:@datetime
    validEndnumber码有效结束时间(date类型)Mock:@timestamp
    makeFundsChannelobject制码资金渠道(取码渠道为零售模式必填)
      totalAmountnumber用户购买时订单金额Mock:100
      userRealAmountnumber用户实付金额Mock:80
      merchantRealAmountnumber商户实收金额Mock:10

返回数据

参数名称类型必填默认值备注其他信息
uuidnumber交易成功与否Mock:@now('yyyyMMddHHmmss')-@string('lower',32)
appIdstring请求AppIdMock:@natural
successboolean交易成功与否
actionstring交易类型最大长度:50
最小长度:1
Mock:makeEcoupon
timestampnumber返回时间戳Mock:@timestamp
errorCodestring错误码最大长度:50
Mock:@word
errorMessagestring错误描述最大长度:50
Mock:@csentence
signTypestring签名类型最大长度:20
Mock:sha256
signstring签名值最大长度:500
Mock:@natural
contentobject返回报文
  outerOrderIdstring制码订单号最大长度:64
最小长度:1
Mock:@string
  codeQuantitynumber制码总数量Mock:@natural
  itemsarray
    outerOrderItemIdstring制码子订单号最大长度:64
最小长度:10
Mock:@string
    ticketIdnumber批次号
    ticketNamestring批次名称最大长度:100
最小长度:1
Mock:@string
    brandTicketIdstring品牌方券批次映射ID最大长度:100
最小长度:1
Mock:@string
    thirdSendTicketIdstring第三制码券批次映射ID最大长度:100
最小长度:1
Mock:@string
    validStartstring码有效期开始时间最大长度:14
最小长度:14
Mock:@now('yyyyMMddHHmmss')-@string('lower',32)
    valieEndstring码有效期结束时间最大长度:14
最小长度:14
Mock:@now('yyyyMMddHHmmss')-@string('lower',32)
    ticketUseDescriptionobject券使用说明
      ticketPicturestring券图片链接最大长度:100
最小长度:11
      useThresholdnumber优惠门槛
      discountDescriptionstring优惠说明最大长度:50
最小长度:1
      useDescriptionstring使用说明最大长度:50
最小长度:1
      useRulestring使用规则最大长度:50
最小长度:1
    codeDetailsarray串码详情
      codestring串码号最大长度:64
最小长度:1
Mock:@string
      codeH5Urlstring活动页面连接最大长度:64
最小长度:1
Mock:@string
      codePicUrlstring二维码连接最大长度:64
最小长度:1
Mock:@string
      useTimesinteger串码可使用次数Mock:@natural
      statusstring串码状态最大长度:2
最小长度:2
Mock:@string
      statusDescstring状态描述最大长度:10
最小长度:1
Mock:@string

备注

  1. ticketId为券批次号,由券系统提供给销售渠道。销售渠道再根据其顾客选购商品上传正确的批次号 。
  2. commissionDate = -1时,所制串码的状态为“03:未激活”。销售渠道拿到该串码后,择机调用激活接口将串码状态变更为“00:初始状态”。
  3. 相对有效期和绝对有效期,只可择其一上送,若二者均上送,以绝对有效期优先。
  4. 选择上传相对有效期时,需要上送commissionDate,commissionDate = 0表示当日生效,commissionDate = 1表示次日生效,以此类推。
  5. 商户授权时,若未填写销售价,则制码时资金渠道必填。  并且在核销串码时,将制码资金渠道中商户实收金额作为净值下发给收银机。
  6. status 状态枚举
00
初始状态
01 
已使用
02
使用中
03
未激活
04 
已冻结
05
已作废
06
已失效

变更历史

变更日期变更内容
2024-04-24
2023-04-13
2023-04-13
2023-03-29
2023-03-29
2022-10-26
2022-09-14
2022-09-14
2022-09-01
2022-08-23
2022-07-19
2022-06-23
2022-06-17
2022-06-17
2022-06-17
2022-04-28
2021-11-19
2021-11-18
2021-11-18
2021-11-12
2021-11-12
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-11-11
2021-10-11
2021-08-24
2021-08-13
2021-08-10
2021-08-09
2021-08-09
2021-08-09
2021-08-09
2021-08-07
2021-08-07
2021-08-07
2021-08-07
2021-08-07
2021-08-06
2021-08-05
2021-08-04
2021-08-04
2021-08-04
2021-08-03
2021-08-03
2021-08-03
2021-08-03
2021-08-03
2021-08-03
2021-08-03
2021-08-02
2021-08-02
2021-08-02
2021-06-10
2021-06-09
2021-06-01
2021-06-01
2021-06-01
2021-06-01
2021-06-01
2021-06-01
2021-06-01
2021-06-01
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
2021-05-26
api-id=29767