1. 接口描述
接口请求域名： trp.tencentcloudapi.com 。
新增批次
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCodeBatch。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-15。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CorpId | 否 | Integer | 企业ID 示例值：10000 |
| MerchantId | 否 | String | 商户ID 示例值：eqdmnz7020bmtvi9 |
| ProductId | 否 | String | 产品ID 示例值：tz6jpscwky41u23o9b |
| BatchType | 否 | Integer | 批次类型 0:溯源 1:营销 示例值：1 |
| BatchId | 否 | String | 批次ID，留空时系统自动生成 示例值：uevdikb06zy5 |
| Remark | 否 | String | 备注 示例值：备注 |
| MpTpl | 否 | String | 模板ID，或者活动ID 示例值：1 |
| CloneId | 否 | String | 克隆批次ID，同时会复制溯源信息 示例值：10000 |
| BatchCode | 否 | String | 批次编号，业务字段不判断唯一性 示例值：202210 |
| ValidDate | 否 | String | 有效期 示例值：2023-05-01 |
| ProductionDate | 否 | String | 生产日期 示例值：2022-05-01 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BatchId | String | 批次ID 示例值：uevdikb06zy5 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新增批次
新增批次
输入示例
POST / HTTP/1.1
Host: trp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCodeBatch
<公共请求参数>
{
"MerchantId": "eqdmnz7020bmtvi9",
"ProductId": "tz6jpscwky41u23o9b",
"BatchType": 1,
"BatchId": "",
"Remark": "备注",
"MpTpl": "模板ID",
"CloneId": "复制的批次ID",
"BatchCode": "20121212000001",
"ValidDate": "2022-11-12",
"ProductionDate": "2022-05-12"
}输出示例
{
"Response": {
"BatchId": "20121212000001xxx",
"RequestId": "eaa3ccac-d2f5-4df0-a8b3-7b51324e9283"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
