服务端 API 文档

文档捉虫大赛火热进行中,好礼多多> HOT

1. 接口描述

此接口处于预下线状态 。

预计下线时间:2023-06-20 15:52:55

接口请求域名: ocr.tencentcloudapi.com 。

库源服务调整,该接口在2023年6月1日将正式下线。

本接口支持条形码备案信息查询,返回条形码查询结果的相关信息,包括产品名称、产品英文名称、品牌名称、规格型号、宽度、高度、深度、关键字、产品描述、厂家名称、厂家地址、企业社会信用代码13个字段信息。

产品优势:直联中国物品编码中心,查询结果更加准确、可靠。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:QueryBarCode。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto 。
BarCode String 条形码

3. 输出参数

参数名称 类型 描述
BarCode String 条码
ProductDataRecords Array of ProductDataRecord 条码信息数组
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询条码信息

查询条码信息

输入示例

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: QueryBarCode
<公共请求参数>

{
    "BarCode": "6928804021912"
}

输出示例

{
    "Response": {
        "BarCode": "06928804021912",
        "ProductDataRecords": [
            {
                "BrandName": "美汁源",
                "CategoryCode": "",
                "CheckResult": "1",
                "Depth": "",
                "Description": "",
                "EnName": "",
                "FirmCode": "911100006000138767",
                "Height": "",
                "ImageLink": [
                    ""
                ],
                "KeyWord": "480ml美汁源葡萄气泡饮葡萄汁汽水 *12",
                "ManufacturerAddress": "北京市朝阳区酒仙桥路20号楼3层301号312室",
                "ManufacturerName": "太古中萃发展有限公司",
                "ProductName": "480ml美汁源葡萄气泡饮葡萄汁汽水 *12",
                "Type": "480ml*12",
                "Width": ""
            }
        ],
        "RequestId": "e2ca3708-f5cd-49de-b254-4d9beca0eef6"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameter.InvalidGTINError 无效的GTIN。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录