获取商品详情(即将上线)

商户可以用此API获取订单列表

发送请求

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

请求属性 属性名 说明
地址 https://rapture.mobi/api
请求方式 POST
Header APIKEY 您的API KEY
Header Content-Type application/json
Form Data request.method 需要调用的api。此处设置为order-list
Form Data request.id 用来唯一标识此发送请求的id。由调用方生成
Form Data request.meta 预留字段
Form Data order 过滤条件,只有满足条件的订单才会被返回。以下为可使用的过滤条件,都是选填。如果是不给定任何过滤条件则返回所有订单
Form Data order.product_id 订单所属商品id
Form Data order.min_created_at 订单创建在某时间戳之后
Form Data order.max_created_at 订单创建在某时间戳之前
Form Data order.id 订单id
Form Data paging 分页参数,最小为1。如果不带此参数,最多返回前100条记录
Form Data paging.page_size 每页记录数,最大为100
Form Data paging.page_index 获取第n页的记录

请求样例

{
    "order": {
        "product" : 1013,
        "min_created_at" : 1483200000 
    },
    "paging": {
        "page_size": 50,
        "page_index": 1
    },
    "request": {
        "method": "order-list",
        "id" : "F4js0Za1",
        "meta": ""
    } 
}
此查询返回商品id为13,并且在2017.1.1之后创建的订单,第1~50条
{
    "order": {
        "id" : 123456
    },
    "request": {
        "method": "product-list",
        "id" : "F4js0Za1",
        "meta": ""
    } 
}
此查询返回订单号为123456的订单。 ### 请求返回值 | 返回值 | 内容 | | :--- | :--- | | request_id |调用者在请求中设置的同名字段 | | product | 若调用成功,返回符合条件的订单的详情 | | error.code | 错误码 | | error.message | 错误信息 | | error.error_subcode | 子错误码 | * 成功返回值样例
{
    "request_id": "F4js0Za1",
    "order_count": 1,
    "orders" : [
        {
            "id": "123456",
            "user_id": 139211000222444, // Facebook user id
            "tax": 2.50,
            "shipping_fee": 2.10,
            "total": 17.60,
            "currency": "USD",
            "timestamp" : 1483203290,
            "customer_email": "[email protected]",
            "customer_address": "Yuyuan Road 1107",
            "customer_name": "Robert Ji",
            "customer_mobile": "+8618600000000",
            "product": {
                "name": "White Shirt",
                "description": "This is a shirt",
                "image": "http://www.bothub.ai/image/shirt.jpg",
                "currency": "USD",
            }
        }               
    ]
}

order_count返回满足条件的订单总数。 如果没有符合过滤条件的。则orders为空数组。

  • 失败返回值样例
{
    "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 参数无效
无效的过滤条件
分页数量超标
18000 内部错误

results matching ""

    No results matching ""