订单☍
版本:v1
认证方式:Bearer Token
目录☍
接口列表☍
获取订单列表☍
接口说明
根据查询条件获取订单列表
基本信息☍
- 接口名称:获取订单列表
- 请求方式:GET
- 请求路径:/Order/{appKey}
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
status | string | - | 订单状态 | 否 |
orderNo | string | - | 系统订单号 | 否 |
tradeNo | string | - | 支付平台单号 | 否 |
userId | integer | - | 用户ID | 否 |
pctType | string | - | 商品类型 | 否 |
pctId | string | - | 商品ID | 否 |
pctName | string | - | 商品名称 | 否 |
skip | integer | - | 跳过的条数 | 否 |
take | integer | - | 拉取的条数 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | OrderListResult | - | 否 |
error | string | 错误信息 | 否 |
获取订单详情☍
接口说明
根据订单ID获取订单详情
基本信息☍
- 接口名称:获取订单详情
- 请求方式:GET
- 请求路径:/Order/{appKey}/{id}
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
id | - | 订单ID | 是 |
appKey | - | - | 是 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | Order | - | 否 |
error | string | 错误信息 | 否 |
创建订单☍
接口说明
根据请求参数创建订单
基本信息☍
- 接口名称:创建订单
- 请求方式:POST
- 请求路径:/Order/{appKey}/Create
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Body 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
amount | number | - | - | 是 |
productName | string | - | - | 是 |
productType | string | - | - | 是 |
productID | string | - | - | 是 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | CreateOrderResult | - | 否 |
error | string | 错误信息 | 否 |
数据结构☍
CreateOrderRequest☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
amount | number | - | 是 |
productName | string | - | 是 |
productType | string | - | 是 |
productID | string | - | 是 |
CreateOrderResult☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
id | integer | - | 否 |
orderNo | string | - | 否 |
CreateOrderResultApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
Order☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
id | integer | 订单的唯一标识符。 | 否 |
userID | integer | 创建订单的用户ID。 | 否 |
payType | string | 订单的支付类型,例如 '信用卡', '支付宝', '微信支付' 等。 | 否 |
amount | number | 订单的总金额。 | 否 |
orderNo | string | 订单的唯一编号,通常由系统生成。 | 否 |
tradeNo | string | 与订单关联的交易编号,通常由支付平台提供。 | 否 |
status | string | 订单的当前状态,例如 '待支付', '已完成', '已取消' 等。 | 否 |
productType | string | 订单中商品的类型分类。 | 否 |
productID | string | 订单中商品的唯一标识符。 | 否 |
productName | string | 订单中商品的名称。 | 否 |
allowRefund | boolean | 指示订单是否允许进行退款操作。 | 否 |
allowRefundUntil | string | 订单允许进行退款操作的截止时间。 | 否 |
tags | string | 用于分类或标记订单的标签。 | 否 |
remark | string | 订单的额外备注信息。 | 否 |
description | string | 订单的详细描述信息。 | 否 |
orderPayTime | string | 订单完成支付的时间。 | 否 |
expireTime | string | 订单的过期时间,超过该时间订单将自动取消。 | 否 |
createDate | string | 订单的创建时间,默认为当前时间。 | 否 |
lastUpdate | string | 订单的最后更新时间,默认为当前时间。 | 否 |
OrderApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
OrderListResult☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
total | integer | - | 否 |
data | array | - | 否 |
OrderListResultApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
通用错误码☍
错误码 | 说明 |
---|---|
200 | 成功 |