获取订单信息列表 - 微伴助手OpenAPI

获取订单列表数据。调用此接口需购买基础席位。

请求参数

Query 参数

order_id

string

订单编号

可选

unionid

string

可选

客户的unionid

external_user_id

string

客户的id

可选

limit

string

可选

列表返回长度。默认值为30，最大值为100

示例值:

offset

string

可选

表偏移。用于迭代获取所有数据，默认值为0

示例值:

access_token

string

调用接口凭证

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

integer

必需

状态码，0为正常，非0代表错误。

errmsg

string

必需

错误信息，成功时为'ok'，错误时会以中文方式显示错误原因

order_info

array [object {17}]

订单列表

必需

amount

integer

购买数量

可选

create_time

string

订单创建时间

可选

discount_amount

string | null

优惠金额

可选

item_id

string

可选

商品id，为商品的唯一编号，若存在商品数据，需携带此参数用于辨识区分商品

item_name

string | null

商品名称

可选

item_price

string | null

商品价格

可选

order_fields

array [object {2}]

订单信息自定义字段

可选

order_id

string

订单号

可选

order_status

string

订单状态

可选

order_type

string

可选

订单类型，限制长度不超过18，此参数对应侧边栏的订单名称的显示

paid_time

string

订单支付时间

可选

payment_amount

string

购买总金额

可选

payment_channel

string | null

支付渠道

可选

shop_fields

array [object {2}] | null

可选

店铺信息自定义字段列表，非店铺基本字段。

shop_id

string | null

可选

店铺id，为店铺的唯一编号，若存在店铺数据，需携带此参数用于辨识区分店铺

shop_name

string | null

店铺名称

可选

unionid

string

可选

客户的unionid

total

integer

订单总数

必需

示例

{
  "errcode": 0,
  "errmsg": "ok",
  "order_info": [
    {
      "amount": 2,
      "create_time": "2020-07-01 09:12:21",
      "discount_amount": "4.00",
      "item_id": "200401635358",
      "item_name": "xxxxxxxxx",
      "item_price": "20",
      "order_fields": [
        {
          "field_name": "xxxxx",
          "value": "xxxxxxxxxxxxxx"
        },
        {
          "field_name": "xxxxxxxxxxx",
          "value": "1771908888"
        }
      ],
      "order_id": "888888888888",
      "order_status": "xxxxx",
      "order_type": "xxxxxxxxxxxxxx",
      "paid_time": "2020-07-01 09:12:29",
      "payment_amount": "40",
      "payment_channel": "xxxxxxxxxxxx",
      "shop_fields": [
        {
          "field_name": "xxxxxxxx",
          "value": "xxxxxxxxxxxxx"
        },
        {
          "field_name": "xxxxxxxxxxx",
          "value": "4.3"
        }
      ],
      "shop_id": "xj18xxxxxx3",
      "shop_name": "xxxxxxxxxxxxxx",
      "unionid": "oz9xvxxxxxxxxS1Zu_yP30"
    }
  ],
  "total": 1
}

🟢200正常返回