接口文档 / 营销接口

查询营销卡项详情

GET/api/v2/open-agency/promotions/card/{id}在线调试

响应参数

名称	说明	类型
Body 参数
`data`可选	数据	`object`
`id`可选	卡项ID 示例：`1809264834875924500`	`string`
`name`可选	卡项名称示例：`测试卡`	`string`
`status`可选	卡项状态，0=使用中 1=已终止示例：`0`	`integer`
`isNeedCardFee`可选	开卡方式 0=免费开卡 1=付费开卡示例：`1`	`integer`
`cardFee`可选	卡费，isNeedCardFee=1时有效示例：`100`	`number`
`validityType`可选	有效期类型 0=永久有效 1=自定义有效期 2=指定日期	`integer`
`validityPeriod`可选	有效时长，validityType=1时有效示例：`7`	`integer`
`validityPeriodUnit`可选	有效时长单位 0=天 1=周 2=月 3=年, validityType=1时有效示例：`1`	`integer`
`validityEndDate`可选	指定结束有效日期，validityType=2时有效格式：date-time	`string`
`perPatientObtainLimit`可选	患者领取次数限制，0=无限次 1=限制示例：`1`	`integer`
`perPatientObtainMax`可选	患者领取次数，perPatientObtainLimit = 1时有值示例：`2`	`integer`
`rechargeRights`可选	充送权益	`object`
`discountRights`可选	折扣权益	`object`
`presentRights`可选	抵扣权益	`object`
`error`可选可为空	通用业务错误包装	`object`

响应示例

json

{
  "data": {
    "id": 1809264834875924500,
    "name": "测试卡",
    "status": 0,
    "isNeedCardFee": 1,
    "cardFee": 100,
    "validityType": 0,
    "validityPeriod": 7,
    "validityPeriodUnit": 1,
    "validityEndDate": "2026-01-01T00:00:00Z",
    "perPatientObtainLimit": 1,
    "perPatientObtainMax": 2,
    "rechargeRights": {
      "isOpen": 1,
      "detail": {
        "rechargeRules": [
          {
            "pay": 100,
            "present": 1
          }
        ],
        "balanceUsingScope": 0,
        "goodsPayWithBalance": [
          {
            "discountType": 1,
            "discount": 0,
            "givingLimitType": 1,
            "givingCount": 3,
            "name": "string",
            "type": 0,
            "productId": "string",
            "exceptItems": [
              null
            ]
          }
        ]
      }
    },
    "discountRights": {
      "isOpen": 1,
      "detail": {
        "goodsList": [
          {
            "discountType": 1,
            "discount": 0,
            "givingLimitType": 1,
            "givingCount": 3,
            "name": "string",
            "type": 0,
            "productId": "string",
            "exceptItems": [
              null
            ]
          }
        ]
      }
    },
    "presentRights": {
      "isOpen": 1,
      "detail": {
        "singlePresentList": [
          {
            "discountType": 1,
            "discount": 0,
            "givingLimitType": 1,
            "givingCount": 3,
            "name": "string",
            "type": 0,
            "productId": "string",
            "exceptItems": [
              null
            ]
          }
        ],
        "packagePresentList": [
          {
            "itemTotalCount": 0,
            "itemChoiceCount": 0,
            "goodsList": [
              {
                "discountType": null,
                "discount": null,
                "givingLimitType": null,
                "givingCount": null,
                "name": null,
                "type": null,
                "productId": null,
                "exceptItems": null
              }
            ]
          }
        ]
      }
    }
  },
  "error": null
}

业务失败包装示意

json

{
  "data": null,
  "error": {
    "code": 11003,
    "message": "不支持的授权类型{grantType}"
  }
}

查看 HTTP 状态与业务码排查