查询 CPS 信息

我的收藏

查询订单 CPS 信息。可用于判断订单是否为 CPS 订单。返回数据包含订单的支付、CPS、退款、核销等信息。

注意：返回信息只包含 CPS 订单已核销和已退款记录（不包含退款中和退款失败记录）。

使用限制

无

接口说明

无

基本信息

基本信息
HTTP URL	https://open.douyin.com/api/apps/trade/v2/order/query_cps
HTTP Method	POST
Scope	industry_open.trade.cps
权限要求	不需要用户授权

请求头

参见通用参数。

请求参数

名称	类型	是否必填	描述	示例值
order_id	string	否	抖音开平内部交易订单号，该单号通过预下单回调传给开发者服务，长度 < 64byte。	"mock_order_id"
out_order_no	string	否	开发者系统生成的订单号，与唯一 order_id 关联，长度 < 64byte。	"mock_out_no"

名称

类型

是否必填

描述

示例值

order_id

string

否

抖音开平内部交易订单号，该单号通过预下单回调传给开发者服务，长度 < 64byte。

"mock_order_id"

out_order_no

string

否

开发者系统生成的订单号，与唯一 order_id 关联，长度 < 64byte。

"mock_out_no"

说明：

order_id 与 out_order_no 二选一。

请求示例

curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/order/query_cps' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.xxx' \
--data-raw='{
    "order_id" : "mock_order_id",
    "out_order_no" : "mock_out_order_no"
}'

响应参数

名称	类型	描述	示例值
data	Object	CPS 订单相关信息	参见 data 字段
extra	object	额外信息，参考通用参数中的说明

data 字段

名称	类型	描述	示例值
error_code	int	错误码，0为成功	0
description	string	错误码描述	success
order_id	string	抖音开平侧订单号	"mock_order_id"
out_order_no	string	开发者侧订单号，与 order_id一一对应	"mock_out_order_no"
payment_info	Object	CPS 订单支付相关信息	参见 payment_info 字段
cps_info	Object	CPS 相关信息	参见 cps_info 字段
refund_info	Object	CPS 订单已退款记录信息	参见 refund_info 字段
delivery_info	Object	CPS 订单已核销记录信息	参见 delivery_info 字段

payment_info 字段

名称	类型	描述	示例值
total_fee	int64	订单实际支付金额，单位分	10000
order_status	string	订单状态， INIT：初始状态 PROCESS：订单处理中 SUCCESS：成功 FAIL：失败 TIMEOUT：用户超时未支付	"SUCCESS"
pay_time	string	支付时间，格式：2021-12-12 00:00:00	"2021-12-12 00:00:00"
pay_channel	int	支付渠道枚举： 1：微信， 2：支付宝 10: 抖音支付	1
channel_pay_id	string	渠道支付单号，如微信的支付单号	"2iu208bfi2897r9hflquf"
seller_uid	string	卖家商户号 id	"287484783"
cp_extra	string	预下单时开发者定义的透传信息	""
message	string	结果描述信息，如失败原因	"SUCCESS"

cps_info 字段

名称	类型	描述	示例值
total_commission_amount	int64	订单总佣金，单位分	1000
cps_item_list	Array<object>	订单 CPS 信息。对于交易模板 1.0 和担保支付订单，Array 长度为 1	参见 cps_item_list 字段

名称

类型

描述

示例值

total_commission_amount

int64

订单总佣金，单位分

1000

cps_item_list

Array<object>

订单 CPS 信息。

对于交易模板 1.0 和担保支付订单，Array 长度为 1

参见 cps_item_list 字段

cps_item_list 字段

名称	类型	描述	示例值
commission_rate	int32	分佣比例，万分位	100
commission_amount	int64	佣金，单位分	1000
source_type	int32	分佣类型： 1：短视频 2：直播间	2
item_id	int64	短视频/直播间 ID	12323123
sell_amount	int63	售价，单位分	1000
status	int32	CPS 订单状态，交易系统下为子单状态 0：未支付， 1：已支付(待使用)； 2：已退款(不分佣)； 3：已核销(已分佣)	0
item_order_id	string	抖音开平侧的商品单号，只存在交易系统	"ot12323123123"
commission_user_nickname	string	达人抖音昵称	小毛驴
commission_user_douyinid	string	达人抖音号	ax81nd873
task_id	string	cps任务的id	“123456789”

refund_info 字段

名称	类型	描述	示例值
total_refund_amount	int64	订单退款总金额，单位分，没有已退款记录，为 0	0
refund_items	Array<object>	订单已退款详细信息，如果没有已退款记录，为 null 对于交易模板 1.0 和担保支付订单，为整单退款记录对于交易系统，为商品单退款记录	参见 refund_items 字段

名称

类型

描述

示例值

total_refund_amount

int64

订单退款总金额，单位分，没有已退款记录，为 0

refund_items

Array<object>

订单已退款详细信息，如果没有已退款记录，为 null

对于交易模板 1.0 和担保支付订单，为整单退款记录

对于交易系统，为商品单退款记录

参见 refund_items 字段

refund_items 字段

名称	类型	描述	示例值
out_refund_no	string	开发者系统生成的退款单号，与抖音开平退款单号 refund_id 唯一关联	"128944123299"
refund_amount	int64	退款金额，单位分	1000
refund_status	string	显示退款状态，默认“已退款”	"已退款"
refund_at	int64	退款时间，13 位毫秒时间戳，只有已退款才有退款时间	164698988000
item_order_id	string	抖音开平侧的商品单号，只存在交易系统	"ot70736673143416"

delivery_info 字段结构

名称	类型	描述	示例值
total_delivery_amount	int64	订单核销总金额，单位分，没有核销记录，为 0。	10
delivery_items	Array<object>	订单核销详细信息，如果没有核销记录，为 null。对于交易模板 1.0 和担保支付订单，为整单核销记录。对于交易系统，为商品单核销记录。	参见 delivery_items 字段结构

名称

类型

描述

示例值

total_delivery_amount

int64

订单核销总金额，单位分，没有核销记录，为 0。

delivery_items

Array<object>

订单核销详细信息，如果没有核销记录，为 null。

对于交易模板 1.0 和担保支付订单，为整单核销记录。

对于交易系统，为商品单核销记录。

参见 delivery_items 字段结构

delivery_items 字段结构

名称	类型	描述	示例值
delivery_amount	int64	核销金额，单位分	10
delivery_status	string	显示核销状态，默认“已核销”	"已核销"
delivery_at	int64	核销时间，13 位毫秒时间戳	1646989887000
item_order_id	string	抖音开平侧的商品单号，只存在交易系统中	"ot7073664578173045032"

响应示例

正常示例

{
  "data": {
    "error_code": 0,
    "description": "success",
    "order_id": "ot7073664578173012264",
    "out_order_no": "ext_ot7073664578173012264",
    "payment_info": {
      "pay_time": "2022-03-11 16:28:06",
      "item_id": "7049587675082263815",
      "total_fee": 20,
      "order_status": "SUCCESS",
      "pay_channel": 1,
      "channel_pay_id": "4313601110202203112588448957",
      "seller_uid": "68882720803499563550",
      "cp_extra": "",
      "message": "CPS-团购测试商品"
    },
    "cps_info": {
      "total_commission_amount": 4,
      "cps_item_list": [
        {
          "commission_amount": 2,
          "source_type": 1,
          "item_id": 7049587675082263815,
          "sell_amount": 10,
          "status": 3,
          "item_order_id": "ot7073664578173045032",
          "commission_rate": 2500,
          "commission_user_douyinid": "ax81nd873",
          "commission_user_nickname": "小毛驴"
        },
        {
          "sell_amount": 10,
          "status": 2,
          "item_order_id": "ot7073664578173061416",
          "commission_rate": 2500,
          "commission_amount": 2,
          "source_type": 1,
          "item_id": 7049587675082263815,
          "commission_user_douyinid": "ax81nd873",
          "commission_user_nickname": "小毛驴"
        }
      ]
    },
    "refund_info": {
      "total_refund_amount": 10,
      "refund_items": [
        {
          "out_refund_no": "12894412389749193299",
          "refund_amount": 10,
          "refund_status": "已退款",
          "refund_at": 1646989887000,
          "item_order_id": "ot7073664578173061416"
        }
      ]
    },
    "delivery_info": {
      "total_delivery_amount": 10,
      "delivery_items": [
        {
          "delivery_amount": 10,
          "delivery_status": "已核销",
          "delivery_at": 1646989889000,
          "item_order_id": "ot7073664578173045032"
        }
      ]
    }
  },
  "extra": {
    "sub_error_code": 0,
    "sub_description": "success",
    "logid": "2022092115392201020812109511046",
    "now": 1663745962686,
    "error_code": 0,
    "description": "success"
  }
}

异常示例

{
  "data": {
    "error_code": 13000,
    "description": "系统错误"
  },
  "extra": {
    "sub_error_code": 13000,
    "sub_description": "系统错误",
    "logid": "2022092115392201020812109511046",
    "now": 1663745962686,
    "error_code": 2191000,
    "description": ""
  }
}

错误码

详情参见错误码/返回码。

下一篇：小程序文档指引