获取商城订单列表

获取商城订单列表

请求说明

请求地址	https://openapi.wps.cn/v7/store/orders
请求方法	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-Type	string	是	使用：application/json
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：Bearer {access_token}

查询参数（Query）

名称	参数类型	是否必填	说明
page_size	integer	否	分页大小；默认为 10
page_token	string	否	分页标记
status	string	否	支付状态过滤；默认是全部订单
with_total	boolean	否	是否返回 total 总数字段

请求地址示例

[GET] https://openapi.wps.cn/v7/store/orders?page_size={integer}&page_token={string}&status={string}&with_total={boolean}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ items	array[object]	订单列表
∟ ∟ actual_fee	integer	总实付（单位：分）
∟ ∟ company_id	string	企业 id
∟ ∟ created_at	integer	下单时间
∟ ∟ id	string	主订单 id
∟ ∟ operator	object	下单人信息
∟ ∟ ∟ user_id	string	用户 id
∟ ∟ ∟ user_name	string	用户名称
∟ ∟ origin_fee	integer	总原价（单位：分）
∟ ∟ payments	array[object]	付费记录
∟ ∟ ∟ actual_fee	integer	实际支付费用（单位：分）
∟ ∟ ∟ paid_at	integer	支付时间
∟ ∟ ∟ state	string[enum]	状态 finish：支付已完成；refund：支付记录已退款
∟ ∟ ∟ type	string[enum]	支付方式 wechat：微信支付；alipay：支付宝支付；offline：线下途径支付；remit：汇款支付；coupon：优惠促销
∟ ∟ remark	string	下单备注
∟ ∟ state	string[enum]	订单状态 waiting：待支付；cancel：已取消；review：（汇款支付）审核中；paid：已支付；refund：已退订
∟ ∟ sub_orders	array[object]	子订单列表，订购内容记录
∟ ∟ ∟ actual_fee	integer	订购商品实付（单位：分）
∟ ∟ ∟ amount	integer	子订单下单套数
∟ ∟ ∟ amount_in_effect	integer	子订单下单后的生效套数
∟ ∟ ∟ expire_at	integer	子订单到期时间
∟ ∟ ∟ id	string	子订单 id
∟ ∟ ∟ order_type	string[enum]	订单类型 purchase：新购；renewal：续费；alone：独立订单（每个订单是独立的，不会在历史生效订单上续费生效）
∟ ∟ ∟ origin_fee	integer	订购商品原价（单位：分）
∟ ∟ ∟ product_type	string[enum]	订购商品类型 service_package：套餐；privilege_package：权益包；sku：标准商品
∟ ∟ ∟ renewal_order_type	array[string]	续费订单类型；可以是多个类型的组合，比如续期的同时增购
∟ ∟ ∟ sku_desc	string	商品规格描述
∟ ∟ ∟ sku_id	string	商品规格 id
∟ ∟ ∟ spu_id	string	商品类别 id。只有 product_type=sku 的标准商品才有 spu_id
∟ ∟ ∟ start_at	integer	订购商品的实际生效时间 如果这个字段为 0，则表示订购商品是立即生效的； 如果这个字段 > 0，则表示订购商品在指定时间戳之后生效
∟ ∟ ∟ term_in_day	integer	子订单下单时长（单位：天）
∟ next_page_token	string	下次查询分页标记
∟ total	integer	总数
more	object	更多的错误信息

响应体示例

{
  "data": {
    "items": [
      {
        "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
          }
        ]
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "msg": "string",
  "code": 0
}