查询订单信息

更新时间 2024-07-24 02:58:49

我的收藏

查询订单基本信息。

使用限制

无

接口说明

适用场景举例：查询异常订单的支付状态，确认订单是否交易成功。

基本信息

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

请求头

参考通用参数

请求参数

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

说明：

•

order_id 与 out_order_no 二选一。

•

优先使用 order_id 查询交易模版 1.0 和交易系统的订单信息。

•

使用 out_order_no 查询担保支付的订单信息（担保支付系统没有交易订单的概念）。

请求示例

text复制
curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/order/query_order' \
--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	订单支付相关信息
extra	object	额外信息，参见通用参数

data 字段

名称	类型	描述	示例值
order_id	string	抖音开平侧订单号	"mock_order_id"
out_order_no	string	开发者侧订单号，与 order_id 一一对应	"mock_out_no"
refund_amount	int64	已退款金额，单位分	10000
settle_amount	int64	已分账金额，单位分	0
total_fee	int64	订单实际支付金额，单位[分]	10000
order_status	string	订单支付状态 •INIT：初始状态 •PROCESS：订单处理中 •SUCCESS：成功 •FAIL：失败 •TIMEOUT：用户超时未支付 •CLOSED：已关单	"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	渠道支付单号，如微信的支付单号	"2iu2082897r9hflquf"
seller_uid	string	卖家商户号 id	"287484783"
item_id	string	视频id	"9823789736"
cp_extra	string	预下单时开发者定义的透传信息	""
message	string	结果描述信息，如失败原因	"SUCCESS"
payment_order_id	string	担保支付单 id	"abc123"
delivery_type	int	订单核销类型： •0: 三方码（非闭环核销），开发者自行处理券码生成及展示，通过 push_delivery 接口推送核销状态。 •1: 抖音码（闭环核销），开平负责生券，开发者使用核销组件展示，使用验券准备和验券接口核销。	1

响应示例

正常示例

json复制
{
  "data": {
    "order_id": "mock_order_id",
    "out_order_no": "mock_out_order_no",
    "refund_amount": 10000,
    "settle_amount": 0,
    "total_fee": 10000,
    "pay_time": "2021-12-12 00:00:00",
    "order_status": "SUCCESS",
    "pay_channel": 1,
    "channel_pay_id": "2iu208bfi2897r9hflquf",
    "seller_uid": "287484783",
    "item_id": "9823789736",
    "cp_extra": "",
    "message": "SUCCESS",
    "payment_order_id": "abc123"
  },
  "extra": {
    "sub_error_code": 0,
    "sub_description": "success",
    "logid": "2022092115392201020812109511046",
    "now": 1663745962686,
    "error_code": 0,
    "description": "success"
  }
}

异常示例

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