Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

获取商城订单详情

获取商城订单详情

请求说明

请求地址https://openapi.wps.cn/v7/store/orders/{order_id}
请求方法GET
签名方式KSO-1
权限要求查询和管理租户下的所有商城订单(应用授权) kso.store_order.readwrite.all
查询和管理该应用权限下的商城订单(应用授权) kso.store_order.readwrite.ownedby
查询租户下的所有商城订单(应用授权) kso.store_order.read.all
查询该应用权限下的商城订单(应用授权) kso.store_order.read.ownedby

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
order_idstring订单 id

请求地址示例

[GET] https://openapi.wps.cn/v7/store/orders/{order_id}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ actual_feeinteger总实付(单位:分)
∟ company_idstring企业 id
∟ created_atinteger下单时间
∟ idstring主订单 id
∟ operatorobject下单人信息
∟ ∟ user_idstring用户 id
∟ ∟ user_namestring用户名称
∟ origin_feeinteger总原价(单位:分)
∟ paymentsarray[object]付费记录
∟ ∟ actual_feeinteger实际支付费用(单位:分)
∟ ∟ paid_atinteger支付时间
∟ ∟ statestring[enum]状态
finish:支付已完成;refund:支付记录已退款
∟ ∟ typestring[enum]支付方式
wechat:微信支付;alipay:支付宝支付;offline:线下途径支付;remit:汇款支付;coupon:优惠促销
∟ remarkstring下单备注
∟ statestring[enum]订单状态
waiting:待支付;cancel:已取消;review:(汇款支付)审核中;paid:已支付;refund:已退订
∟ sub_ordersarray[object]子订单列表,订购内容记录
∟ ∟ actual_feeinteger订购商品实付(单位:分)
∟ ∟ amountinteger子订单下单套数
∟ ∟ amount_in_effectinteger子订单下单后的生效套数
∟ ∟ expire_atinteger子订单到期时间
∟ ∟ idstring子订单 id
∟ ∟ order_typestring[enum]订单类型
purchase renewal alone
∟ ∟ origin_feeinteger订购商品原价(单位:分)
∟ ∟ product_typestring[enum]订购商品类型
service_package:套餐;privilege_package:权益包;sku:标准商品
∟ ∟ renewal_order_typearray[string]续费订单类型;可以是多个类型的组合,比如续期的同时增购
∟ ∟ sku_descstring商品规格描述
∟ ∟ sku_idstring商品规格 id
∟ ∟ spu_idstring商品类别 id。只有 product_type=sku 的标准商品才有 spu_id
∟ ∟ start_atinteger订购商品的实际生效时间
如果这个字段为 0,则表示订购商品是立即生效的;
如果这个字段 > 0,则表示订购商品在指定时间戳之后生效
∟ ∟ term_in_dayinteger子订单下单时长(单位:天)
moreobject更多的错误信息

响应体示例

json
{
  "data": {
    "actual_fee": 0,
    "company_id": "string",
    "created_at": 0,
    "id": "string",
    "operator": {
      "user_id": "string",
      "user_name": "string"
    },
    "origin_fee": 0,
    "payments": [
      {
        "actual_fee": 0,
        "paid_at": 0,
        "state": "string[enum]",
        "type": "string[enum]"
      }
    ],
    "remark": "string",
    "state": "string[enum]",
    "sub_orders": [
      {
        "actual_fee": 0,
        "amount": 0,
        "amount_in_effect": 0,
        "expire_at": 0,
        "id": "string",
        "order_type": "string[enum]",
        "origin_fee": 0,
        "product_type": "string[enum]",
        "renewal_order_type": ["string"],
        "sku_desc": "string",
        "sku_id": "string",
        "spu_id": "string",
        "start_at": 0,
        "term_in_day": 0
      }
    ]
  },
  "msg": "string",
  "code": 0
}
回到旧版