获取商品详情

商户可以用此API获取在Bothub上的商品详情

发送请求

您可以用任意一个已经启用的API Key(怎样申请APIKey) 向Bothub发起请求。这个请求的说明如下:

请求属性 属性名 说明
地址 https://rapture.mobi/api
请求方式 POST
Header APIKEY 您的API KEY
Header Content-Type application/json
Form Data request.method 需要调用的api。此处设置为product-list
Form Data request.id 用来唯一标识此发送请求的id。由调用方生成
Form Data request.meta 预留字段
Form Data product 过滤条件,只有满足条件的商品才会被返回。以下为可使用的过滤条件,都是选填。如果是不给定任何过滤条件则返回所有属于该Bot的商品
Form Data product.id 商品id,创建商品时返回,也可以通过查询全部商品的接口检查
Form Data product.name 商品名称
Form Data product.description 商品长介绍
Form Data product.image 商品图片
Form Data product.price 商品价格
Form Data product.currency 商品货币
Form Data product.is_taxable 购买商品是否需要缴税
Form Data product.stock 商品存货数量
Form Data product.is_deleted 商品是否上架,false为上架,true为下架
Form Data product.purchase_limit 每位用户可购买的件数
Form Data product.external_id 商品外部id
Form Data product.min_created_at 商品创建在某时间后
Form Data product.max_created_at 商品创建在某时间前

请求样例

{
    "product": {
        "is_deleted" : false 
    },
    "request": {
        "method": "product_list",
        "id" : "F4js0Za1",
        "meta": ""
    } 
}
此查询返回所有上架中的产品
{
    "product": {
        "min_created_at" : 1483200000,
        "is_deleted" : true
    },
    "request": {
        "method": "product_list",
        "id" : "F4js0Za1",
        "meta": ""
    } 
}
此查询返回所有在2017.1.1之后创建,且没有上架的产品 ### 请求返回值 | 返回值 | 内容 | | :--- | :--- | | request_id |调用者在请求中设置的同名字段 | | product | 若调用成功,返回符合条件的商品的详情 | | error.code | 错误码 | | error.message | 错误信息 | | error.error_subcode | 子错误码 | * 成功返回值样例
{
    "request_id": "F4js0Za1",
    "products" : [
        {
            "id": "123456",
            "name": "White Shirt",
            "description": "This is a shirt",
            "image": "http://www.bothub.ai/image/shirt.jpg",
            "price": 13.00,
            "currency": "USD",
            "is_taxable": true,
            "stock": 100,
            "is_deleted": true,
            "purchase_limit": 1,
            "external_id": "ASN0001"
        },        
        {
            "id": "123456",
            "name": "White Blowse",
            "description": "This is a blowse",
            "image": "http://www.bothub.ai/image/blowse.jpg",
            "price": 23.00,
            "currency": "USD",
            "is_taxable": false,
            "stock": 90,
            "purchase_limit": 1,
            "is_deleted": true,
            "external_id": "ASN0002"
        },        
    ]
}

如果没有符合过滤条件的商品。则products为空数组。

  • 失败返回值样例
{
    "error" : {
        "message": "invalid filter type",
        "type": "RuntimeException",
        "code": 10000,
        "error_subcode": 1234567,
        "request_id": "F4js0Za1"
    }
}

注意点

  • 用户下订单的时候,Bothub会保留一份用户下订单时商品的快照。当用户查看订单时看到的是下单时商品的状态。

错误码列表

返回值 内容
10000 内部错误
10001 未指定API KEY
10002 无效的API KEY
10003 未指定Request id
10004 未指定调用API的种类
10005 无效的API种类
10005 无效的API种类
10006 Bot不存在或者已经被删除
10011 Request id与之前的重复
10100 参数无效
60001 缺少Product字段
60002 创建商品时缺少字段
60003 product字段结构不正确
60004 商品价格不正确
60005 商品库存不正确
60006 商品上架情况不正确
60007 商品货币只支持USD
60008 用户购买限制不正确
60009 没有指定商品id
60010 商品id不存在
60011 没有找到要指定的商品属性
18000 内部错误

results matching ""

    No results matching ""