SKU管理API

EasyDL零门槛AI开发平台

所有文档

          EasyDL零门槛AI开发平台

          SKU管理API

          更新时间：2021-04-12

          简介

          本文档主要说EasyDL零售版的定制商品检测服务中的SKU管理API如何使用，如有疑问可以通过以下方式联系我们：

          • 在百度智能云控制台内提交工单，咨询问题类型请选择人工智能服务
          • 进入EasyDL社区交流，与其他开发者进行互动
          • 加入EasyDL零售版官方QQ群（群号:1009661589）联系群管

          接口鉴权

          1. 进入EasyDL零售版的百度智能云控制台应用列表页面，如下图所示：

          1.png

          1. 如果还未创建应用，请点击「创建应用」按钮进行创建。创建应用后，参考鉴权认证机制文档，使用API Key(AK)和Secret Key(SK)获取access_token

          SKU管理API概览

          SKU管理API包含以下API：

          接口名称 HTTP方法 API URL 说明
          SKU创建 POST https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/create 用于创建SKU
          SKU更新 POST https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/update 用于更新SKU
          SKU列表 POST https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/list 用于列出所有SKU，可获得SKU的所有信息
          SKU删除 POST https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/delete 用于删除指定SKU
          SKU数据添加API POST https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/addentity 用于为指定SKU上传单品图片

          SKU创建API

          接口描述

          该接口可用于创建SKU

          请求说明

          请求示例

          HTTP 方法：POST

          请求URL：https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/create

          URL参数：

          参数 值
          access_token 通过API Key和Secret Key获取的access_token，参考鉴权认证机制文档

          Header如下：

          参数 值
          Content-Type application/json

          请求参数

          字段 必选 类型 说明
          sku_name 是 string SKU名称，长度限制100个字符，支持中文、英文、数字和- & ' . + * ( ) % / #
          brand_name 是 string 品牌名称，长度限制100个字符，支持中文、英文、数字和- & ' . + * ( ) % / #
          specs 是 string 规格参数，长度限制100个字符，支持中文、英文、数字和- & ' . + * ( ) % / #
          category 是 string 商品品类：饮品 drink，药品 medicine，保健品 healthcare products，零食 snacks，香烟 cigarette，调味品 condiment，日用品 daily necessities，其它 other
          package_type 是 string 包装类型：瓶装 bottled，罐装 canned，袋装 bagged，盒装 boxed，桶装 barrel，其它 other
          product_code 否 string 商品编号，长度限制100个字符，支持英文、数字和- & ' . + * ( ) % / #
          package_image_url 否 string 和package_image二选一，当package_image字段存在时，该字段输入失效，以package_image字段为准。图片大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式。通过URL上传SKU包装图时，请确保图片链接有外网访问权限，否则图片将会上传失败，若需要补充SKU包装图，可使用SKU更新API。
          package_image 否 string 和package_image二选一，当package_image字段存在时，以package_image字段为准。图片数据，将图片转化为base64编码上传，要求图片大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式， 注意请去掉头部。

          返回说明

          返回参数

          字段 必选 类型 说明
          log_id 是 int 唯一的log id，用于问题定位
          sku_id 是 int 创建的SKU ID

          SKU更新API

          接口描述

          该接口可用于更新SKU

          请求说明

          请求示例

          HTTP 方法：POST

          请求URL：https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/update

          URL参数：

          参数 值
          access_token 通过API Key和Secret Key获取的access_token，参考鉴权认证机制文档

          Header如下：

          参数 值
          Content-Type application/json

          请求参数

          字段 必选 类型 说明
          sku_id 是 string SKU的ID，SKU完成创建时刻获取，或可通过SKU列表接口查询
          sku_name 是 string SKU名称，长度限制100个字符，支持中文、英文、数字和- & ' . + * ( ) % / #
          brand_name 是 string 品牌名称，长度限制100个字符，支持中文、英文、数字和- & ' . + * ( ) % / #
          specs 是 string 规格参数，长度限制100个字符，支持中文、英文、数字和- & ' . + * ( ) % / #
          category 是 string 商品品类：饮品 drink，药品 medicine，保健品 healthcare products，零食 snacks，香烟 cigarette，调味品 condiment，日用品 daily necessities，其它 other
          package_type 是 string 包装类型：瓶装 bottled，罐装 canned，袋装 bagged，盒装 boxed，桶装 barrel，其它 other
          product_code 否 string 商品编号，长度限制100个字符，支持英文、数字和- & ' . + * ( ) % / #
          package_image_url 否 string 和package_image二选一，当package_image字段存在时，该字段输入失效，以package_image字段为准。图片大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式。通过URL上传SKU包装图时，请确保图片链接有外网访问权限，否则图片将会上传失败，若需要补充SKU包装图，可使用SKU更新API。
          package_image 否 string 和package_image二选一，当package_image字段存在时，以package_image字段为准。图片数据，将图片转化为base64编码上传，要求图片大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式， 注意请去掉头部。

          返回说明

          返回参数

          字段 必选 类型 说明
          log_id 是 int 唯一的log id，用于问题定位
          sku_id 是 int 创建的SKU ID

          SKU列表API

          接口描述

          该接口可用于获取已创建的SKU列表

          请求说明

          请求示例

          HTTP 方法：POST

          请求URL：https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/list

          URL参数：

          参数 值
          access_token 通过API Key和Secret Key获取的access_token，参考鉴权认证机制文档

          Header如下：

          参数 值
          Content-Type application/json

          请求参数

          字段 必选 类型 说明
          start 是 int 起始位置
          num 是 int 结果数量

          返回说明

          返回参数

          字段 必选 类型 说明
          log_id 是 int 唯一的log id，用于问题定位
          total_num 是 int 返回结果数
          results 是 array 返回结果
          +sku_id 是 int SKU ID
          +sku_name 是 string SKU名称
          +brand_name 是 string 品牌名称
          +specs 是 string 规格参数
          +category 是 string 商品品类
          +package_type 是 string 包装类型
          +product_code 否 string 商品编号
          +status 是 string SKU状态：新建 new，上传SKU单品图片中 uploading，错误 error，正常 normal，训练中 training
          +entity_count 是 int SKU单品图数量

          SKU删除API

          接口描述

          该接口可用于删除SKU

          请求说明

          请求示例

          HTTP 方法：POST

          请求URL：https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/delete

          URL参数：

          参数 值
          access_token 通过API Key和Secret Key获取的access_token，参考鉴权认证机制文档

          Header如下：

          参数 值
          Content-Type application/json

          请求参数

          字段 必选 类型 说明
          sku_id 是 string SKU的ID，SKU完成创建时刻获取，或可通过SKU列表接口查询

          返回说明

          返回参数

          字段 必选 类型 说明
          log_id 是 int 唯一的log id，用于问题定位

          SKU数据添加API

          接口描述

          该接口可用于为SKU上传单品图片

          请求说明

          请求示例

          HTTP 方法：POST

          请求URL：https://aip.baidubce.com/rpc/2.0/easydl/retail/sku/addentity

          URL参数：

          参数 值
          access_token 通过API Key和Secret Key获取的access_token，鉴权认证机制文档

          Header如下：

          参数 值
          Content-Type application/json

          请求参数

          字段 必选 类型 说明
          sku_id 是 string SKU ID
          entity_content 是 string SKU单品图的base64编码

          返回说明

          返回参数

          字段 必选 类型 说明
          log_id 是 int 唯一的log id，用于问题定位

          错误码

          若请求错误，服务器将返回的JSON文本包含以下参数：

          • error_code：错误码。
          • error_msg：错误描述信息，帮助理解和解决发生的错误。

          例如Access Token失效返回：

          {
  "error_code": 110,
  "error_msg": "Access token invalid or no longer valid"
}

          需要重新获取新的Access Token再次请求即可。

          错误码 错误信息 描述
          1 Unknown error 服务器内部错误，请再次请求， 如果持续出现此类错误，请通过QQ群（1009661589）或工单联系技术支持团队。
          2 Service temporarily unavailable 服务暂不可用，请再次请求， 如果持续出现此类错误，请通过QQ群（1009661589）或工单联系技术支持团队。
          3 Unsupported openapi method 调用的API不存在，请检查后重新尝试
          4 Open api request limit reached 集群超限额
          6 No permission to access data 无权限访问该用户数据
          13 Get service token failed 获取token失败
          14 IAM Certification failed IAM鉴权失败
          15 app not exsits or create failed 应用不存在或者创建失败
          17 Open api daily request limit reached 每天请求量超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请通过QQ群（1009661589）联系群管手动提额
          18 Open api qps request limit reached QPS超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请通过QQ群（1009661589）联系群管手动提额
          19 Open api total request limit reached 请求总量超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请通过QQ群（1009661589）联系群管手动提额
          100 Invalid parameter 无效的access_token参数，请检查后重新尝试
          110 Access token invalid or no longer valid access_token无效
          111 Access token expired access token过期
          406000 internal server error 服务错误
          406001 param[xx] invalid 无效的参数xx，请检查相关参数
          406002 dataset not exist 实景图集不存在
          406003 dataset already exists 实景图集已存在
          406004 dataset can not be modified temporarily 实景图集暂时不能被修改
          406006 no permission to modify the dataset 没有修改实景图集的权限
          406008 [xx] quota exceeded xx配额超限
          406009 sku does not exist SKU不存在
          406010 sku already exists SKU已存在
          406011 sku cannot be modified temporarily SKU暂时不能被修改
          上一篇
          实景图标注规范
          下一篇
          实景图管理API