对外发放平台礼品信息获取

#  对外发放平台礼品信息获取 `公开`

## 使用场景
>  已支持：
	1.根据礼品编号获取礼品信息

## API描述
>  API描述：根据礼品编号获取礼品信息

## 请求流程

>   1. 在超8平台中申请第三方系统的应用Access Key和密钥（线下）。
>   2. 第三方系统根据应用Access Key和密钥向系统发起**Access Token**申请【[如何获取token](https://developers.yesno.com.cn/doc/57/ "如何获取token")】。
>   3. 三方系统调用防伪领域服务的开放接口进行数据对接。

> 具体请求请参阅：
>请参阅  [请求流程](https://developers.yesno.com.cn/doc/56/ "请求流程")

## 请求信息

| 协议     | HTTPS                                                  |
|----------|-----------------------------------------------------------------------------------------------|
| 请求方法 | GET                                                   |
| 请求路径 | /marketing/v1/pay/open/query-gift                |

### header头
请参阅 [通用请求头](https://developers.yesno.com.cn/doc/56/ "请求头")

## 请求参数

<tr><td>giftNo</td><td>string</td><td>必填</td><td></td><td>礼品编号</td><td></td></tr>

</table>

## 返回消息体

| 名称      | 类型    | 是否必须 | 默认值 | 备注       | 其他信息          |
|-----------|---------|----------|--------|------------|-------------------|
| code      | integer | 非必须   |        | 错误码     | **format:** int32 |
| data      | object  | 非必须   |        | 返回值       |                   |
| message   | string  | 非必须   |        | 消息内容   |                   |
| timestamp | integer | 非必须   |        | 时间戳     | **format:** int64 |
| traceId   | string  | 非必须   |        | 链路追踪ID |                   |

## data返回对象说明

| 参数名称        | 参数类型 | 参数说明             |
|-----------------|----------|---------------------------------------------------|
| id       | int   | 礼品id|
| enterpriseNo       | String   | 企业编号|
| giftNo       | String   | 礼品编号|
| giftName       | String   | 礼品名称|
| giftType       | 数值   | 礼品类型（1：虚拟；2：红包；3：实物，4积分，5红包券）|
| giftPrice       | 数值   | 礼品价值|
| giftScore       | 数值   | 积分价值|
| giftValidDateStart       | Instant   | 有效开始时间|
| giftValidDateEnd       | Instant   | 有效结束时间|
| giftProductImg       | String   | 礼品图片|
| giftUseCount       | 数值   | 使用数量|
| giftTotalCount       | 数值   | 总计数量|
| distributeCount       | 数值   |已分配量（已划拨到积分商城的数量）|
| flag       | 数值   |是否可用：1可用；0不可用|
| sendType       | 数值   | 发奖方式：默认0，1-快递物流,2-门店核销，3-权益礼品；4-卡券；5-链接|
| giftCcnProductId       | 数值   | 中商礼品ID|
| giftSource       | 数值   | 礼品来源类型【1：中商充值平台；2：企业；3：支付宝】，默认0|
| alipayCount       | 数值   | 支付宝礼品值|
| getType       | 数值   | (针对支付宝礼品)获取方式：1直接充值；2：短信提取。默认0|
| warnCount       | string   |库存预警值|
| dayLimit       | 数值   | 每日上限，红包为元|
| weekLimit       | 数值   |每周上限，红包为元|
| linkType       | 数值   |虚拟礼品专用链接类型:1-H5链接，2-小程序，默认为0|
| miniProAppId       | string   |小程序AppId|
| miniProPagePath       | string   |小程序页面路径|
| failCount       | 数值   |发放失败数量（礼品发放成功数量=已使用gift_UseCount-发放失败数量）|
| repeatGet       | 数值   |虚拟礼品专用重复领取:1-开启，2-关闭。默认关闭|
| giftDescribe       | string   |礼品使用说明描述|
| relationMerchant       | 数值   |商户号主键|

## 请求示例
``` text
请求地址：{URL}/v1/pay/open/query-gift?giftNo=120301

```

## 响应示例

```json
{
    "code": 200,
    "message": "success",
    "data": {
        "id": 82249,
        "enterpriseNo": "131627012487",
        "giftNo": "120301",
        "giftName": "发放红包-中商01",
        "giftType": 2,
        "giftPrice": 0.00,
        "giftScore": 0.00,
        "giftValidDateStart": "2024-11-14T16:00:00Z",
        "giftValidDateEnd": "2099-12-31T15:59:59Z",
        "giftProductImg": "https://tx-assets-test.supercarrier8.com/sup8-upload/1632476288%281%29_b0b5c042516b4eb8ad41916ecbc195ef_52e6b3.jpeg",
        "giftUseCount": 12.30,
        "giftTotalCount": 100.00,
        "sendType": 0,
        "giftCcnProductId": 0,
        "giftSource": 2,
        "alipayCount": 0,
        "getType": 0,
        "warnCount": "",
        "dayLimit": 0.00,
        "weekLimit": 0.00,
        "linkType": 0,
        "miniProAppId": "",
        "miniProPagePath": "",
        "failCount": 0.00,
        "repeatGet": 2,
        "distributeCount": 50.00,
        "flag": 1,
        "giftDescribe": "",
        "relationMerchant": 62
    },
    "timestamp": 1733292551340,
    "traceId": "",
    "exception": null,
    "meta": null,
    "ext": null
}
```

## 异常示例
```json
{
  "code": 21223004,
  "message": "系统异常，请联系管理员!",
  "traceId":"xxxxxx",
  "timestamp": 1679368912568
}
```

## 返回码
| 返回码 | 描述 |  解决方案|
| --- | --- | --- | 
21223004|系统异常，请联系管理员!