订单状态变更 custom_order

定义

通过本接口上报订单相关的数据，在订单状态发生变更时上报

本规范支持两种模型：主订单模型、子订单模型

数据规范

主订单维度

主订单维度关注一笔订单整体的数据

订单状态

名称	类型	描述
order 必填	object	订单数据
order_id 必填	string	商户侧订单号，在商户系统内订单的唯一标识符
order_time 必填	datetime	订单下单时间（下单可能不支付），出于计算方便的考虑，在处理订单数据的时候会统一使用下单时间作为重要的时间戳，所以order_time在任何情况下都是必填
pay_time	datetime	订单支付时间，只在支付行为发生时才会生成
cancel_time	datetime	订单取消时间，只在取消订单行为发生时才会生成
refund_time	datetime	订单退款时间，只在退款行为发生时才会生成
order_status 必填	string	订单状态当前的最新变化 give_order 用户提交订单 / 下单成功 cancel_give_order 用户取消订单 / 取消订单成功 cancel_pay 用户关闭输入支付密码的浮层，终止支付动作 pay 用户发起支付 / 用户已支付 refund 用户发起退款 / 订单已退款

子订单维度

子订单维度关注订单的明细数据，若订单业务模型可以支持子订单，则sub_orders必填

名称	类型	描述
sub_orders	object[]	主订单的拆分订单，子订单概念可能是虚拟的
sub_order_id	string	子订单单号，唯一标识符，可按规则计算
order_amt	float	子订单金额（元）
pay_amt	float	子订单实付金额（元）
extra	object	子订单的额外属性
chan	object	各个子订单渠道，标识拆分订单的渠道归因
chan_wxapp_scene 必填	int	小程序场景值，必填例1037
chan_id	string	引流渠道的标识符
chan_refer_app_id	string	来源小程序或公众号appid 例wx9d6f5f6gea059654
chan_shop_id	string	门店ID，若需要计算门店业务则必填
chan_shop_name	string	门店名称，展示字段，若chan_shop_id存在则必填
chan_custom	object	自定义渠道
chan_custom_id 必填	string	4级自定义渠道的标识符，4级是自定义渠道的最小粒度例mp-article-12375
chan_custom_id_desc 必填	string	4级自定义渠道的描述例公众号文章(id=12375)
chan_custom_cat_3 必填	string	3级自定义渠道的标识符，3级是针对4级的分类，要求4级数据必须存在例mp-article
chan_custom_cat_3_desc 必填	string	3级自定义渠道的描述，若chan_custom_cat_3存在则必须存在例公众号文章
chan_custom_cat_2 必填	string	2级自定义渠道的标识符，2级是针对3级的分类，要求34级数据必须存在例media
chan_custom_cat_2_desc 必填	string	2级自定义渠道的描述，若chan_custom_cat_2存在则必须存在例媒体
chan_custom_cat_1 必填	string	1级自定义渠道的标识符，1级是针对2级的分类，要求234级数据必须存在例wechat
chan_custom_cat_1_desc 必填	string	1级自定义渠道的描述，若chan_custom_cat_1存在则必须存在例微信
extra	object

公共基础属性

名称	类型	描述
page 必填	string	行为发生的小程序页面路径，开头不要加 `/`，路径后可带查询参数例pages/product?sku_id=AOdjf7u
page_title	string	行为发生的小程序页面标题例商品详情、商城首页
time 必填	datetime	行为发生时间例1560409473714
sr_sdk_version	string	sdk版本号例1.1.6
wx_user 必填	object	用户相关属性
app_id 必填	string	公众号或小程序唯一标识例wx9d4f5f22pa099f82
open_id 必填	string	微信用户在小程序下的唯一标识符例ogN6X0T-ilsH-XmIdzXtuR1f1r3Q
user_id	string	用户在商户的唯一标识符例548019854034
union_id	string	微信用户在开放平台账号下的唯一标识符例o6_bmlsdaXds8d6_sgVt7hM3OPfL
local_id	string	用户在有数的唯一标识符例360b8853-64bf-3fba-e9a0-5abb1e4d7721
tag	object[]	用户的个性化标签
tag_id 必填	string	标签ID，唯一标识符例游客
tag_name 必填	string	标签名称例游客
extra	object

订单行为产生的渠道

在计算销售归因指标时，需要根据订单的成交渠道来归因

名称	类型	描述
chan	object	渠道相关属性
chan_wxapp_scene 必填	int	小程序场景值，必填例1037
chan_id	string	引流渠道的标识符
chan_refer_app_id	string	来源小程序或公众号appid 例wx9d6f5f6gea059654
chan_shop_id	string	门店ID，若需要计算门店业务则必填
chan_shop_name	string	门店名称，展示字段，若chan_shop_id存在则必填
chan_custom	object	自定义渠道
chan_custom_id 必填	string	4级自定义渠道的标识符，4级是自定义渠道的最小粒度例mp-article-12375
chan_custom_id_desc 必填	string	4级自定义渠道的描述例公众号文章(id=12375)
chan_custom_cat_3 必填	string	3级自定义渠道的标识符，3级是针对4级的分类，要求4级数据必须存在例mp-article
chan_custom_cat_3_desc 必填	string	3级自定义渠道的描述，若chan_custom_cat_3存在则必须存在例公众号文章
chan_custom_cat_2 必填	string	2级自定义渠道的标识符，2级是针对3级的分类，要求34级数据必须存在例media
chan_custom_cat_2_desc 必填	string	2级自定义渠道的描述，若chan_custom_cat_2存在则必须存在例媒体
chan_custom_cat_1 必填	string	1级自定义渠道的标识符，1级是针对2级的分类，要求234级数据必须存在例wechat
chan_custom_cat_1_desc 必填	string	1级自定义渠道的描述，若chan_custom_cat_1存在则必须存在例微信
extra	object
component	object	组件是视图上的一个区块元素
component_id	string	组件ID
component_name	string	组件名称

请求示例

let body = {
    "type": "custom_order",
    "props": {
        "order": {
            "order_id": "1347895",
            "order_time": 1557813400369,
            "order_status": "give_order"
        },
        "sub_orders": [
            {
                "sub_order_id": "1347895_001",
                "order_amt": 150,
                "pay_amt": 100,
                "chan": {
                    "chan_wxapp_scene": 1001,
                    "chan_id": "ad_001",
                    "chan_shop_id": "aHDFO",
                    "chan_shop_name": "滨海小卖部"
                }
            },
            {
                "sub_order_id": "1347895_002",
                "order_amt": 100,
                "pay_amt": 50,
                "chan": {
                    "chan_wxapp_scene": 1002,
                    "chan_id": "ad_001",
                    "chan_shop_id": "aHDFO",
                    "chan_shop_name": "滨海小卖部"
                }
            }
        ],
        "page": "pages/product?sku_id=AOdjf7u",
        "page_title": "商品详情、商城首页",
        "time": "1560409473714",
        "wx_user": {
            "app_id": "wx9d4f5f22pa099f82",
            "open_id": "ogN6X0T-ilsH-XmIdzXtuR1f1r3Q",
            "user_id": "548019854034",
            "union_id": "o6_bmlsdaXds8d6_sgVt7hM3OPfL",
            "local_id": "360b8853-64bf-3fba-e9a0-5abb1e4d7721",
            "tag": [
                {
                    "tag_id": "游客",
                    "tag_name": "游客"
                }
            ]
        },
        "chan": {
            "chan_wxapp_scene": 1037,
            "chan_id": "",
            "chan_refer_app_id": "wx9d6f5f6gea059654",
            "chan_shop_id": "",
            "chan_shop_name": "",
            "chan_custom": {
                "chan_custom_id": "mp-article-12375",
                "chan_custom_id_desc": "公众号文章(id=12375)",
                "chan_custom_cat_3": "mp-article",
                "chan_custom_cat_3_desc": "公众号文章",
                "chan_custom_cat_2": "media",
                "chan_custom_cat_2_desc": "媒体",
                "chan_custom_cat_1": "wechat",
                "chan_custom_cat_1_desc": "微信"
            }
        },
        "component": {
            "component_id": "",
            "component_name": ""
        }
    }
}
wx.request({
    url: "https://zhls.qq.com/api/report?app_id=APPID&timestamp=TIMESTAMP&nonce=NONCE",
    method: "post",
    data: body,
    success(res) {
        console.log(res)
    }
})