# 上传团购优惠code

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：uploadvouchercode

上传团购优惠code（仅商家预存code模式需要）
如添加团购优惠时选择code_source_type=2，需要商家先预存code，用户支付成功后平台从code库中分配。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/channels/ec/voucher/codes/upload?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：129

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/channels/api/basic/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "product_id",
    "类型": "string",
    "必填": "是",
    "说明": "通过本地生活api或页面创建的商品id"
  },
  {
    "参数名": "sku_id",
    "类型": "string",
    "必填": "是",
    "说明": "创建的商品时返回的sku_id"
  },
  {
    "参数名": "codes",
    "类型": "Array",
    "必填": "是",
    "说明": "商户上传的券code列表\n一次最多200个\n单个code不超过48位\ncode仅支持由数字和字母组成"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "product_id",
    "类型": "string",
    "说明": "通过本地生活api或页面创建的商品id"
  },
  {
    "参数名": "total_count",
    "类型": "number",
    "说明": "本次上传去重后的code总数"
  },
  {
    "参数名": "success_count",
    "类型": "number",
    "说明": "本次上传操作上传成功个数"
  },
  {
    "参数名": "success_codes",
    "类型": "Array",
    "说明": "上传成功的code列表"
  },
  {
    "参数名": "fail_count",
    "类型": "number",
    "说明": "本次上传操作上传失败的code数"
  },
  {
    "参数名": "fail_codes",
    "类型": "objarray",
    "说明": "本次导入失败的code信息，请参照错误信息，修改后重试"
  }
]
```

">

### Res.fail_codes(Array) `Object Payload`

本次导入失败的code信息，请参照错误信息，修改后重试

```json
[
  {
    "参数名": "code",
    "类型": "string",
    "说明": "商家自定义券code，代表唯一一张券"
  },
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "对应券code上传失败的错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "上传失败的错误信息描述"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

``` json 
{
   "product_id": "qy1rz",
   "sku_id": "fdsfdf",
   "codes": ["232323","23232323","32434454545"]
}
```

返回示例

``` json 
{
   "errcode": 10001,
   "errmsg": "部分成功",
   "product_id": "qy1rz",
   "total_count": 3,
   "success_count": 2,
   "success_codes": ["232323","23232323"],
   "fail_count": 1,
   "fail_codes": [
     {
       "code": "32434454545",
       "errcode": 111,
       "errmsg": "此code已上传"
     }
   ]
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "10027002",
    "错误描述": "code已存在，在UploadCodeFailReason中"
  },
  {
    "错误码": "10027003",
    "错误描述": "code超过最大长度，在UploadCodeFailReason中"
  },
  {
    "错误码": "10027004",
    "错误描述": "上传的code数量超过最大数量"
  },
  {
    "错误码": "10027005",
    "错误描述": "product_id不存在或填写错误"
  }
]
```

## 7. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。