钉钉 API

查询应用市场订单详情

GET

/v1.0/appMarket/orders/{orderId}

第三方企业应用

说明

调用本接口查询指定订单的详情信息。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	暂不支持	应用市场订单信息读权限	暂不支持
第三方企业应用	支持	应用市场订单信息读权限	API Explorer
第三方个人应用	暂不支持	应用市场订单信息读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	order.not.exist	订单不存在	订单不存在
400	illegal.order.principle	订单归属错误	非当前ISV所属订单无查询权限
400	goods.not.app	非应用或内购商品	非应用或内购商品

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.dingtalk.com/v1.0/appMarket/orders/{orderId}' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

响应示例

{
  "bizOrderId": 0,
  "corpId": "string",
  "itemCode": "string",
  "itemName": "string",
  "goodsCode": "string",
  "goodsName": "string",
  "totalActualPayFee": 0,
  "status": 0,
  "quantity": 0,
  "paidTimestamp": 0,
  "createTimestamp": 0,
  "startTimestamp": 0,
  "endTimestamp": 0,
  "inAppOrder": true
}

请求参数

Path 参数

orderId

订单ID。

可选

Header 参数

x-acs-dingtalk-access-token

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

object {0}

示例

返回响应

🟢200成功

application/json

Body

bizOrderId

integer

订单ID。

可选

corpId

string

组织ID。

可选

itemCode

string

规格编码。

可选

itemName

string

规格名称。

可选

goodsCode

string

商品Code。

可选

goodsName

string

商品名称。

可选

totalActualPayFee

integer

可选

订单实付金额，单位：分。

status

integer

可选

订单状态，取值：0：订单关闭3：订单支付4：订单创建

quantity

integer

购买数量。

可选

paidTimestamp

integer

可选

支付时间戳，单位：毫秒。

createTimestamp

integer

可选

创建时间戳，单位：毫秒。

startTimestamp

integer

可选

开始生效时间，单位：毫秒。

endTimestamp

integer

可选

生效结束时间，单位：毫秒。

inAppOrder

boolean

是否内购订单。

可选

修改于 2021-12-30 06:12:36

个人版接入FAQ

权限申请

查询应用市场订单详情

说明#

权限#

错误码#

请求参数

返回响应

说明

权限

错误码