获取标签列表

## 生码下单获取标签列表接口 `公开`

### 支持场景

> 已支持生码下单前查询可用标签，可按标签名称或编号搜索。

### API描述

> 查询接入账号主组织的有效标签。下单时使用返回的 labelId。无主组织时返回空分页。额度为查询时的参考值，提交时会重新校验。

### 请求流程

> 1. 在超8平台线下申请第三方应用的 Access Key 和密钥。
> 2. 使用 Access Key 和密钥申请 **Access Token**。操作步骤见 [获取 AccessToken](https://developers.yesno.com.cn/doc/57/)。
> 3. 携带 Access Token 调用开放接口。调用流程见 [接入指南](https://developers.yesno.com.cn/doc/56/)。

### 请求信息

| 协议 | HTTPS |
|---|---|
| 请求方法 | GET |
| 请求路径 | `/base/app/v2/open/order/labels` |

### header头

请按平台要求传递 Access Token。请求头字段见 [通用请求头](https://developers.yesno.com.cn/doc/56/)。

### 传入参数

| 参数名称 | 是否必填 | 参数类型 | 参数说明 |
|---|---|---|---|
| keyword | 否 | String | 标签名称或编号，支持模糊搜索 |
| pageIndex | 否 | Integer | 页码，从 1 开始，默认 1 |
| pageSize | 否 | Integer | 每页条数，默认 10 |

### 返回消息体

<table>
  <tr><td>名称</td><td>类型</td><td>是否必须</td><td>默认值</td><td>备注</td><td>其他信息</td></tr>
  <tr><td>message</td><td>string</td><td>非必须</td><td></td><td>响应说明</td><td></td></tr>
  <tr><td>timestamp</td><td>integer</td><td>非必须</td><td></td><td>Unix 时间戳，单位为毫秒</td><td>format: int64</td></tr>
  <tr><td>traceId</td><td>string</td><td>非必须</td><td></td><td>请求追踪 ID，按实际返回</td><td></td></tr>
  <tr><td>code</td><td>integer</td><td>非必须</td><td></td><td>业务状态码，200 表示成功</td><td>format: int32</td></tr>
  <tr><td>data</td><td>object</td><td>非必须</td><td></td><td>标签分页对象</td><td></td></tr>
  <tr><td colspan="6">
    <table>
      <tr><td>total</td><td>integer</td><td>非必须</td><td></td><td>符合条件的总记录数</td><td>format: int64</td></tr>
      <tr><td>pageIndex</td><td>integer</td><td>非必须</td><td></td><td>当前页码</td><td>format: int64</td></tr>
      <tr><td>pageSize</td><td>integer</td><td>非必须</td><td></td><td>每页条数</td><td>format: int64</td></tr>
      <tr><td>records</td><td>object[]</td><td>非必须</td><td></td><td>当前页标签对象列表，无记录时为空数组</td><td>item 类型: object</td></tr>
      <tr><td colspan="6">
        <table>
          <tr><td>labelId</td><td>string</td><td>非必须</td><td></td><td>标签业务 ID，<strong>下单使用此字段</strong></td><td></td></tr>
          <tr><td>labelNo</td><td>string</td><td>非必须</td><td></td><td>标签编号，用于展示或搜索</td><td></td></tr>
          <tr><td>labelName</td><td>string</td><td>非必须</td><td></td><td>标签名称</td><td></td></tr>
          <tr><td>sourceType</td><td>string</td><td>非必须</td><td></td><td>SELF：自建标签。ORG：组织授权标签</td><td></td></tr>
          <tr><td>enterpriseNo</td><td>string</td><td>非必须</td><td></td><td>标签归属企业号，可能不同于订单落库企业号</td><td></td></tr>
          <tr><td>enterpriseName</td><td>string</td><td>非必须</td><td></td><td>标签归属企业名称</td><td>可为 null</td></tr>
          <tr><td>labelOrgId</td><td>integer</td><td>非必须</td><td></td><td>被授权组织 ID，仅组织授权记录有值。无需回传到下单接口</td><td>format: int64，可为 null</td></tr>
          <tr><td>validFlag</td><td>integer</td><td>非必须</td><td></td><td>1：在有效期内。0：不在有效期内。本接口启用有效期筛选</td><td>format: int32</td></tr>
          <tr><td>labelType</td><td>string</td><td>非必须</td><td></td><td>标签类型编码，按平台标签配置返回</td><td>可为 null</td></tr>
          <tr><td>labelStatus</td><td>string</td><td>非必须</td><td></td><td>标签状态编码，按平台标签配置返回</td><td>可为 null</td></tr>
          <tr><td>isObsolete</td><td>integer</td><td>非必须</td><td></td><td>0：正常。1：已作废</td><td>format: int32</td></tr>
          <tr><td>fileStyle</td><td>string</td><td>非必须</td><td></td><td>标签图标配置值</td><td>可为 null</td></tr>
          <tr><td>labelScale</td><td>string</td><td>非必须</td><td></td><td>包装比例配置值，数量约束以下单校验为准</td><td>可为 null</td></tr>
          <tr><td>productType</td><td>integer</td><td>非必须</td><td></td><td>商品关联方式：0 后关联、1 自主选择、2 前关联</td><td>format: int32，可为 null</td></tr>
          <tr><td>availableAmount</td><td>string</td><td>非必须</td><td></td><td>组织标签剩余额度，以十进制字符串返回。为 null 时表示不适用或无单独限额。企业额度以下单校验为准</td><td>可为 null</td></tr>
        </table>
      </td></tr>
    </table>
  </td></tr>
</table>

组织 ID 用于说明授权归属。同一标签出现多条授权记录时，分别读取各记录的额度。分页总数按记录计算。

### 请求示例

```http
GET {URL}/base/app/v2/open/order/labels?keyword=LABEL&pageIndex=1&pageSize=10
```

### 出参示例

```json
{
  "code": 200,
  "message": "success",
  "data": {
    "records": [
      {
        "labelId": "LBL10001",
        "labelNo": "LABEL_001",
        "labelName": "示例标签",
        "sourceType": "ORG",
        "enterpriseNo": "100001",
        "enterpriseName": "示例企业",
        "labelOrgId": 101,
        "validFlag": 1,
        "labelType": null,
        "labelStatus": null,
        "isObsolete": 0,
        "fileStyle": null,
        "labelScale": null,
        "productType": 1,
        "availableAmount": "100000"
      }
    ],
    "total": 1,
    "pageIndex": 1,
    "pageSize": 10
  },
  "timestamp": 1793769600000,
  "traceId": "example-trace-labels"
}
```

### Code 错误码说明

| 错误代码 | 描述 | 处理建议 |
|---|---|---|
| `200` | 成功 | 读取响应 data |
| `21823141` | 主组织未配置，或查询所属组织失败 | 检查接入账号是否有主组织。配置正常仍失败时联系平台 |